Untold Engine  Beta v0.0.16
docs
U4DEngine::U4DDirectionalLight Class Reference

The U4DDirectionalLight class implements a light entity used for providing light and shadows to a game. More...

Inherits U4DEngine::U4DEntity.

Public Member Functions

void viewInDirection (U4DVector3n &uDestinationPoint)
 Method which sets the view direction of the light. More...
 
U4DVector3n getViewInDirection ()
 Gets the view direction of the light. More...
 
void setDiffuseColor (U4DVector3n &uDiffuseColor)
 Sets the diffuse color for the light. More...
 
void setSpecularColor (U4DVector3n &uSpecularColor)
 Sets the specular color for the light. More...
 
U4DVector3n getDiffuseColor ()
 gets the light diffuse color More...
 
U4DVector3n getSpecularColor ()
 gets the light specular color 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.
 
U4DEntityoperator= (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 render (id< MTLRenderCommandEncoder > uRenderEncoder)
 Renders the current entity. More...
 
virtual void update (double dt)
 Updates the state of each entity. More...
 
virtual void updateAllUniforms ()
 
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)
 
virtual U4DRenderEntitygetRenderEntity ()
 
- 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...
 
U4DEntitygetFirstChild ()
 Method which returns the node's first child in the scenegraph. More...
 
U4DEntitygetLastChild ()
 Method which returns the node's last child in the scenegraph. More...
 
U4DEntitygetNextSibling ()
 Method which returns the node's next sibling in the scenegraph. More...
 
U4DEntitygetPrevSibling ()
 Method which returns the node's previous sibling in the scenegraph. More...
 
U4DEntityprevInPreOrderTraversal ()
 Method which returns the node's previous sibling in pre-order traversal order. More...
 
U4DEntitynextInPreOrderTraversal ()
 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...
 
U4DEntitygetParent ()
 Gets the parent to the entity. More...
 
U4DEntitygetRootParent ()
 Gets the root parent (top parent in the scenegraph) of the entity. More...
 
U4DEntitysearchChild (std::string uName)
 

Static Public Member Functions

static U4DDirectionalLightsharedInstance ()
 Method which returns an instance for the U4DDirectionalLight Singleton. More...
 

Public Attributes

U4DVector3n diffuseColor
 The diffuse color of the light.
 
U4DVector3n specularColor
 The specular color of the light.
 
float energy
 light energy
 
- Public Attributes inherited from U4DEngine::U4DEntity
U4DDualQuaternion localSpace
 Local Space of the entity.
 
U4DDualQuaternion absoluteSpace
 Absolute Space of the entity.
 
U4DTransformationtransformation
 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 >
U4DEntityparent
 Tree parent pointer.
 
U4DEntityprevSibling
 Tree previous sibling pointer.
 
U4DEntitynext
 Tree next pointer.
 
U4DEntitylastDescendant
 Tree last descendant pointer.
 

Protected Member Functions

 U4DDirectionalLight ()
 Light Constructor which sets the light position to (5.0,5.0,5.0) and its view direction to (0.0,0.0,0.0)
 
 ~U4DDirectionalLight ()
 Light Destructor.
 

Additional Inherited Members

- 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 U4DDirectionalLight class implements a light entity used for providing light and shadows to a game.

Member Function Documentation

◆ getDiffuseColor()

U4DVector3n U4DEngine::U4DDirectionalLight::getDiffuseColor ( )

gets the light diffuse color

Returns
diffuse color in vector format

◆ getSpecularColor()

U4DVector3n U4DEngine::U4DDirectionalLight::getSpecularColor ( )

gets the light specular color

Returns
specular color in vector format

◆ getViewInDirection()

U4DVector3n U4DEngine::U4DDirectionalLight::getViewInDirection ( )
virtual

Gets the view direction of the light.

Returns
Returns the view direction. Note that the coordinate space for the light is different due to its implementation. +z points outward. -z points inward into the screen.

Reimplemented from U4DEngine::U4DEntity.

◆ setDiffuseColor()

void U4DEngine::U4DDirectionalLight::setDiffuseColor ( U4DVector3n uDiffuseColor)

Sets the diffuse color for the light.

Parameters
uDiffuseColordiffuse color in vector format

◆ setSpecularColor()

void U4DEngine::U4DDirectionalLight::setSpecularColor ( U4DVector3n uSpecularColor)

Sets the specular color for the light.

Parameters
uSpecularColorspecular color in vector format

◆ sharedInstance()

U4DDirectionalLight * U4DEngine::U4DDirectionalLight::sharedInstance ( )
static

Method which returns an instance for the U4DDirectionalLight Singleton.

Returns
Returns an instance of the U4DDirectionalLight Singleton

◆ viewInDirection()

void U4DEngine::U4DDirectionalLight::viewInDirection ( U4DVector3n uDestinationPoint)
virtual

Method which sets the view direction of the light.

Parameters
uDestinationPointDestination point where the light should be directed

Reimplemented from U4DEngine::U4DEntity.