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

The U4DParticle class contains all the kinetic properties of a 3D particle. More...

Inherits U4DEngine::U4DEntity.

Public Member Functions

 U4DParticle ()
 Constructor of class.
 
 ~U4DParticle ()
 Destructor of class.
 
void setVelocity (U4DVector3n &uVelocity)
 sets the velocity of the 3D particle More...
 
void addForce (U4DVector3n &uForce)
 adds the new force acting on the 3D particle on the current forces More...
 
void clearForce ()
 clears all forces More...
 
U4DVector3n getVelocity ()
 current velocity of the 3D Particle More...
 
void initMass (float uMass)
 initializes the 3D particle with a mass. Default mass is 1.0 More...
 
float getMass ()
 gets current mass of 3D particle More...
 
U4DVector3n getForce ()
 gets the current sum of all forces acting on the 3D particle More...
 
U4DVector3n getGravity ()
 gets the gravity of the particle More...
 
void setGravity (U4DVector3n &uGravity)
 sets the gravity of the particle More...
 
void setParticleRadialAcceleration (float uParticleRadialAcceleration)
 sets the particle radial acceleration More...
 
void setParticleTangentialAcceleration (float uParticleTangentialAcceleration)
 sets the particle tangential acceleration More...
 
float getParticleRadialAcceleration ()
 gets the particle radial acceleration More...
 
float getParticleTangentialAcceleration ()
 gets the particle tangent acceleration 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 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...
 
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)
 

Public Attributes

U4DParticleData particleData
 The particle Data contains information such as start-color, end-color, emit angle, life and speed of the 3D particle.
 
- 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.
 

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 U4DParticle class contains all the kinetic properties of a 3D particle.

Member Function Documentation

◆ addForce()

void U4DEngine::U4DParticle::addForce ( U4DVector3n uForce)

adds the new force acting on the 3D particle on the current forces

Parameters
uForceforce vector

◆ clearForce()

void U4DEngine::U4DParticle::clearForce ( )

clears all forces

clears all forces currently acting on the particle. However, the only forces acting on the particle is gravity. No need to add other forces.

◆ getForce()

U4DVector3n U4DEngine::U4DParticle::getForce ( )

gets the current sum of all forces acting on the 3D particle

Returns
force vector

◆ getGravity()

U4DVector3n U4DEngine::U4DParticle::getGravity ( )

gets the gravity of the particle

Returns
gravity vector

◆ getMass()

float U4DEngine::U4DParticle::getMass ( )

gets current mass of 3D particle

Returns
mass value

◆ getParticleRadialAcceleration()

float U4DEngine::U4DParticle::getParticleRadialAcceleration ( )

gets the particle radial acceleration

Returns
radial acceleration magnitude

◆ getParticleTangentialAcceleration()

float U4DEngine::U4DParticle::getParticleTangentialAcceleration ( )

gets the particle tangent acceleration

Returns
tangent acceleration magnitude

◆ getVelocity()

U4DVector3n U4DEngine::U4DParticle::getVelocity ( )

current velocity of the 3D Particle

Returns
velocity vector

◆ initMass()

void U4DEngine::U4DParticle::initMass ( float  uMass)

initializes the 3D particle with a mass. Default mass is 1.0

Parameters
uMassmass value

◆ setGravity()

void U4DEngine::U4DParticle::setGravity ( U4DVector3n uGravity)

sets the gravity of the particle

Parameters
uGravitygravity vector

◆ setParticleRadialAcceleration()

void U4DEngine::U4DParticle::setParticleRadialAcceleration ( float  uParticleRadialAcceleration)

sets the particle radial acceleration

Parameters
particleradial acceleration magnitude

◆ setParticleTangentialAcceleration()

void U4DEngine::U4DParticle::setParticleTangentialAcceleration ( float  uParticleTangentialAcceleration)

sets the particle tangential acceleration

Parameters
particletangential acceleration magnitude

◆ setVelocity()

void U4DEngine::U4DParticle::setVelocity ( U4DVector3n uVelocity)

sets the velocity of the 3D particle

Parameters
uVelocityvelocity vector