The U4DImage class represents all images in a game. More...

Inherited by U4DEngine::U4DSprite, and U4DEngine::U4DText.

Public Member Functions
	U4DImage ()
	Constructor of class.

	U4DImage (const char *uTextureImage, float uWidth, float uHeight)
	Constructor of class. More...

	~U4DImage ()
	Destructor of class.

virtual void	setImage (const char *uTextureImage, float uWidth, float uHeight)
	Method which assins an image to the entity. More...

virtual void	render (id< MTLRenderCommandEncoder > uRenderEncoder)
	Renders the current entity. More...

virtual bool	getImageState ()
	current state of the image. Used for multi-image entities such as buttons to change between the main and secondary texture More...

virtual void	setImageState (bool uValue)
	sets the state of the image. Used for multi-image entities such as buttons to change between the main and secondary texture More...

void	setImageDimension (float uWidth, float uHeight)
	sets the image dimension More...

virtual U4DVector2n &	getSpriteOffset ()
	sprite offset position. Used for sprite entities More...

Public Member Functions inherited from U4DEngine::U4DVisibleEntity
	U4DVisibleEntity ()
	Constructor for the class.

virtual	~U4DVisibleEntity ()
	Destructor for the class.

	U4DVisibleEntity (const U4DVisibleEntity &value)
	Copy constructor for the visible entity.

U4DVisibleEntity &	operator= (const U4DVisibleEntity &value)
	Copy constructor for the visible entity. More...

virtual void	update (double dt)
	Method which updates the states of the entity. More...

virtual void	updateAllUniforms ()

void	loadRenderingInformation ()
	Method which loads all rendering information for the entiy.

std::string	getFragmentShader ()
	get the name of the fragment shader More...

U4DRenderEntity *	getRenderEntity ()

void	setPipelineForPass (std::string uPipelineName, int uRenderPassKey)

void	setPipeline (std::string uPipelineName)
	sets the pipeline for the default final pass More...

Public Member Functions inherited from U4DEngine::U4DEntity
	U4DEntity ()
	Entity Constructor. It creates the entity with the local orientation set to zero and local position set to the origin. The forwad vector is set to (0.0,0.0,-1.0). Parent and Next pointer set to null.

	~U4DEntity ()
	Entity Destructor.

	U4DEntity (const U4DEntity &value)
	Entity Copy Constructor.

U4DEntity &	operator= (const U4DEntity &value)
	Entity Copy Constructor. More...

void	setName (std::string uName)
	Method which sets the name of the Entity. More...

std::string	getName ()
	Method which returns the name of the Entity. More...

void	setEntityType (ENTITYTYPE uType)
	Method which sets the type of the Entity. More...

ENTITYTYPE	getEntityType ()
	Method which returns the type of the Entity. More...

void	setLocalSpace (U4DDualQuaternion &uLocalSpace)
	Method which sets the local space of the Entity. More...

void	setLocalSpace (U4DMatrix4n &uMatrix)
	Method which sets the local space of the Entity. More...

U4DDualQuaternion	getLocalSpace ()

U4DDualQuaternion	getAbsoluteSpace ()
	Method which returns the absolute space of the Entity. More...

U4DQuaternion	getLocalSpaceOrientation ()
	Method which returns the local orientation space of the Entity. More...

U4DQuaternion	getLocalSpacePosition ()
	Method which returns the local position space of the Entity. More...

U4DQuaternion	getAbsoluteSpaceOrientation ()
	Method which returns the absolute orientation space of the Entity. More...

U4DQuaternion	getAbsoluteSpacePosition ()
	Method which returns the absolute position space of the Entity. More...

void	setLocalSpaceOrientation (U4DQuaternion &uOrientation)
	Method which sets the local space orientation of the Entity. More...

void	setLocalSpacePosition (U4DQuaternion &uPosition)
	Method which sets the local space position of the Entity. More...

U4DVector3n	getLocalOrientation ()
	Method which returns the Local orientation of the Entity. More...

U4DVector3n	getLocalPosition ()
	Method which returns the local position of the Entity. More...

U4DVector3n	getAbsoluteOrientation ()
	Method which returns the absolute orientation of the Entity. More...

U4DVector3n	getAbsolutePosition ()
	Method which returns the absolute position of the Entity. More...

U4DVector3n	getEntityForwardVector ()
	Method which returns the forwad vector of the Entity. More...

void	setEntityForwardVector (U4DVector3n &uForwardVector)
	Method which sets the forward vectof of the Entity. The default value is (0.0,0.0,-1.0) More...

U4DMatrix3n	getAbsoluteMatrixOrientation ()
	Method which returns the absolute orientation of the Entity. More...

U4DMatrix3n	getLocalMatrixOrientation ()
	Method which returns the local orientation of the Entity. More...

void	translateTo (U4DVector3n &translation)
	Method which translates entity to a new position. More...

void	translateTo (float x, float y, float z)
	Method which translates entity to a new position. More...

void	translateTo (U4DVector2n &translation)
	Method which translates entity to a new position. More...

void	translateBy (float x, float y, float z)
	Method which translates entity by certain amount. More...

void	translateBy (U4DVector3n &translation)
	Method which translates entity by a certain amount. More...

void	rotateTo (U4DQuaternion &rotation)
	Method which rotates entity to a new orientation. More...

void	rotateBy (U4DQuaternion &rotation)
	Method which rotates entity by a certain amount. More...

void	rotateTo (float angle, U4DVector3n &axis)
	Method which rotates entity to a new orientation. More...

void	rotateBy (float angle, U4DVector3n &axis)
	Method which rotates entity by certain amount. More...

void	rotateTo (float angleX, float angleY, float angleZ)
	Method which rotates entity to a new orientation. More...

void	rotateBy (float angleX, float angleY, float angleZ)
	Method which rotates entity by a certain amount. More...

void	rotateAboutAxis (float angle, U4DVector3n &axisOrientation, U4DVector3n &axisPosition)
	Method which rotates entity about an axis. More...

void	rotateAboutAxis (U4DQuaternion &uOrientation, U4DVector3n &axisPosition)
	Method which rotates entity about an axis. More...

virtual void	viewInDirection (U4DVector3n &uDestinationPoint)
	Method which sets the view direction of the entity. More...

virtual U4DVector3n	getViewInDirection ()
	Method which rotates the view direction of the entiy. More...

void	setZDepth (int uZDepth)
	Loads all rendering information for the entiy ‍/ virtual void loadRenderingInformation(){};. More...

int	getZDepth ()
	Gets the z-depth value used for rendering ordering. More...

virtual bool	changeState (INPUTELEMENTACTION uInputAction, U4DVector2n uPosition)

Public Member Functions inherited from U4DEngine::U4DEntityNode< U4DEntity >
	U4DEntityNode ()
	Constructor for the class.

	U4DEntityNode (std::string uNodeName)

	~U4DEntityNode ()
	Destructor for the class.

void	addChild (U4DEntity *uChild)
	Method which adds a child node to a scenegraph. More...

void	addChild (U4DEntity uChild, U4DEntity uNext)

void	addChild (U4DEntity *uChild, int uZDepth)
	Method which adds a child entity to a scenegraph at a particular location. More...

void	removeChild (U4DEntity *uChild)
	Method which removes a child node from the scenegraph. More...

void	changeLastDescendant (U4DEntity *uNewLastDescendant)
	Method which changes the node's last descendant in the scenegraph. More...

U4DEntity *	getFirstChild ()
	Method which returns the node's first child in the scenegraph. More...

U4DEntity *	getLastChild ()
	Method which returns the node's last child in the scenegraph. More...

U4DEntity *	getNextSibling ()
	Method which returns the node's next sibling in the scenegraph. More...

U4DEntity *	getPrevSibling ()
	Method which returns the node's previous sibling in the scenegraph. More...

U4DEntity *	prevInPreOrderTraversal ()
	Method which returns the node's previous sibling in pre-order traversal order. More...

U4DEntity *	nextInPreOrderTraversal ()
	Method which returns the node's next pointer in pre-order traversal order. More...

bool	isLeaf ()
	Method which returns true if the node represents a leaf node in the scenegraph. More...

bool	isRoot ()
	Method which returns true if the node represents a root node in the scenegraph. More...

U4DEntity *	getParent ()
	Gets the parent to the entity. More...

U4DEntity *	getRootParent ()
	Gets the root parent (top parent in the scenegraph) of the entity. More...

U4DEntity *	searchChild (std::string uName)

Public Attributes
U4DVertexData	bodyCoordinates
	Object which contains attribute data such as vertices, and uv-coordinates.

U4DTextureData	textureInformation
	Object which contains texture information.

Public Attributes inherited from U4DEngine::U4DVisibleEntity
U4DRenderEntity *	renderEntity
	pointer to the rendering entity

Public Attributes inherited from U4DEngine::U4DEntity
U4DDualQuaternion	localSpace
	Local Space of the entity.

U4DDualQuaternion	absoluteSpace
	Absolute Space of the entity.

U4DTransformation *	transformation
	U4DTransformation object pointer in charge of translating/rotating the entity.

U4DVector3n	entityForwardVector
	Forward vector of the entity. This is used to compute the view-direction vector.

int	zDepth
	z-depth used for rendering ordering

Public Attributes inherited from U4DEngine::U4DEntityNode< U4DEntity >
U4DEntity *	parent
	Tree parent pointer.

U4DEntity *	prevSibling
	Tree previous sibling pointer.

U4DEntity *	next
	Tree next pointer.

U4DEntity *	lastDescendant
	Tree last descendant pointer.

Protected Attributes
bool	imageState

Protected Attributes inherited from U4DEngine::U4DEntity
U4DVector3n	localOrientation
	Entity local orientation.

U4DVector3n	localPosition
	Entity local position.

U4DVector3n	absoluteOrientation
	Entity absolute orientation.

U4DVector3n	absolutePosition
	Entity absolute position.

Detailed Description

The U4DImage class represents all images in a game.

Constructor & Destructor Documentation

◆ U4DImage()

U4DEngine::U4DImage::U4DImage	(	const char *	uTextureImage,
		float	uWidth,
		float	uHeight
	)

Constructor of class.

Parameters

uTextureImage	Name of texture image
uWidth	Width of texture image
uHeight	Height of texture image

Member Function Documentation

◆ getImageState()

virtual bool U4DEngine::U4DImage::getImageState ( )

inlinevirtual

current state of the image. Used for multi-image entities such as buttons to change between the main and secondary texture

Returns: state of the image

◆ getSpriteOffset()

virtual U4DVector2n& U4DEngine::U4DImage::getSpriteOffset ( )

inlinevirtual

sprite offset position. Used for sprite entities

Returns: position offset.

Reimplemented in U4DEngine::U4DSprite.

◆ render()

void U4DEngine::U4DImage::render ( id< MTLRenderCommandEncoder > uRenderEncoder )

virtual

Renders the current entity.

Updates the space matrix and any rendering flags. It encodes the pipeline, buffers and issues the draw command

Parameters

uRenderEncoder Metal encoder object for the current entity

Reimplemented from U4DEngine::U4DVisibleEntity.

Reimplemented in U4DEngine::U4DText, and U4DEngine::U4DSprite.

◆ setImage()

void U4DEngine::U4DImage::setImage	(	const char *	uTextureImage,
		float	uWidth,
		float	uHeight
	)

virtual

Method which assins an image to the entity.

Parameters

uTextureImage	Name of texture image
uWidth	Width of texture image
uHeight	Height of texture image

◆ setImageDimension()

void U4DEngine::U4DImage::setImageDimension	(	float	uWidth,
		float	uHeight
	)

sets the image dimension

Parameters

uWidth	width
uHeight	height

◆ setImageState()

virtual void U4DEngine::U4DImage::setImageState ( bool uValue )

inlinevirtual

sets the state of the image. Used for multi-image entities such as buttons to change between the main and secondary texture

Parameters

uValue sets the flag to true when the image should change

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ U4DImage()

Member Function Documentation

◆ getImageState()

◆ getSpriteOffset()

◆ render()

◆ setImage()

◆ setImageDimension()

◆ setImageState()