DustyEngine::Entity

DustyEngine::Entity Class Reference

Entity class represents an object on screen that can be easily controlled through a single interface allowing many options for transformations. More...

#include <dustyentity.h>

Inheritance diagram for DustyEngine::Entity:

DustyEngine::NodeAffector List of all members.

Public Member Functions

 Entity (DustyDriver *d)
virtual ~Entity ()
 Destructor destroys the entity and the tasks associated with it.
void SetUpdateInterval (irr::u32 interval)
irr::u32 GetUpdateInterval ()
void SetMoveType (EntityActionType type)
 SetMoveType sets the type of action to use for movement, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.
void SetRotateType (EntityActionType type)
 SetRotateType sets the type of action to use for rotation, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.
void SetScaleType (EntityActionType type)
 SetScaleType sets the type of action to use for scaling, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.
EntityActionType GetMoveType ()
 GetMoveType returns the type of action currently being used for movement, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.
EntityActionType GetRotateType ()
 GetRotateType returns the type of action currently being used for rotation, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.
EntityActionType GetScaleType ()
 GetScaleType returns the type of action currently being used for scaling, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.
void Pause ()
 Pause will pause the entity completely.
void Unpause ()
 Unpause unpauses the entity.
void PauseMovement ()
 PauseMovement pauses only movement within the entity.
void PauseRotation ()
 PauseRotation pauses only rotation within the entity.
void PauseScaling ()
 PauseScaling pauses only scaling within the entity.
void UnpauseMovement ()
 UnpauseMovement will unpause only movement within the entity.
void UnpauseRotation ()
 UnpauseRotation will unpause only rotation within the entity.
void UnpauseScaling ()
 UnpauseScaling will unpause only scaling within the entity.
void SetExecuteMultiple (bool multiple)
 This sets all the tasks in the entity to use the given ExecuteMultiple flag.
bool GetExecuteMultiple ()
void SetNode (irr::scene::ISceneNode *n)
EntityParentTask * GetParentTask ()
 GetParentTask returns a pointer to the parent task of the entity. The tasks that the entity uses for transformation all fall under this parent.
void SetRemoveNodeOnDestroy (bool remove)
bool GetRemoveNodeOnDestroy ()
 Returns true if this entity is set to remove the node that it controls when it is destroyed, and false otherwise.
void SetMoveVector (irr::core::vector3df vector)
 SetMoveVector sets the vector to add to the Entity's position each time it is updated.
irr::core::vector3df GetMoveVector ()
 GetMoveVector returns the vector that's added to the Entity's position each update.
void SetScaleVector (irr::core::vector3df vector)
 SetScaleVector sets the vector to add to the Entity's scale each time it is updated.
irr::core::vector3df GetScaleVector ()
 GetScaleVector returns the vector that's added to the Entity's scale each update.
void SetRotateVector (irr::core::vector3df vector)
 SetRotateVector sets the vector to add to the Entity's rotation each time it is updated.
irr::core::vector3df GetRotateVector ()
 GetRotateVector returns the vector that's added to the Entity's rotation each update.
void SetMoveBoundaries (irr::core::vector3df min, irr::core::vector3df max)
 SetMoveBoundaries sets the minimum and maximum movement boundaries when using BOUNDED movement.
void SetMoveMinBoundary (irr::core::vector3df min)
 Sets the minimum boundary for movement when using BOUNDED movement.
void SetMoveMaxBoundary (irr::core::vector3df max)
 Sets the maximum boundary for movement when using BOUNDED movement.
irr::core::vector3df GetMoveMinBoundary ()
 GetMoveMinBoundary Returns minimum movement boundary.
irr::core::vector3df GetMoveMaxBoundary ()
 GetMoveMaxBoundary Returns maximum movement boundary.
irr::u32 GetMoveCollisionValue ()
 The bounded movement action type will return a collision value when it hits a boundary. This gets that value (See BoundedMoveTask).
void SetScaleBoundaries (irr::core::vector3df min, irr::core::vector3df max)
 SetScaleBoundaries sets the minimum and maximum scale boundaries when using BOUNDED scaling.
void SetScaleMinBoundary (irr::core::vector3df min)
 Sets the minimum boundary for scaling when using BOUNDED scaling.
void SetScaleMaxBoundary (irr::core::vector3df max)
 Sets the maximum boundary for scaling when using BOUNDED scaling.
irr::core::vector3df GetScaleMinBoundary ()
 GetScaleMinBoundary Returns minimum scaling boundary.
irr::core::vector3df GetScaleMaxBoundary ()
 GetScaleMaxBoundary Returns maximum scaling boundary.
irr::u32 GetScaleCollisionValue ()
 The bounded scaling action type will return a collision value when it hits a boundary. This gets that value (See BoundedScaleTask).
void SetRotateBoundaries (irr::core::vector3df min, irr::core::vector3df max)
 SetRotateBoundaries sets the minimum and maximum rotation boundaries when using BOUNDED rotating.
void SetRotateMinBoundary (irr::core::vector3df min)
 Sets the minimum boundary for rotating when using BOUNDED rotation.
void SetRotateMaxBoundary (irr::core::vector3df max)
 Sets the maximum boundary for rotating when using BOUNDED rotation.
irr::core::vector3df GetRotateMinBoundary ()
 GetRotateMinBoundary Returns minimum rotation boundary.
irr::core::vector3df GetRotateMaxBoundary ()
 GetRotateMaxBoundary Returns maximum rotation boundary.
irr::u32 GetRotateCollisionValue ()
 The bounded rotate action type will return a collision value when it hits a boundary. This gets that value (See BoundedRotateTask).
void SetMoveLooping (bool loop)
bool GetMoveLooping ()
 GetMoveLooping returns true if the interpolated move task is looping, false if not.
void SetMoveReverseLooping (bool loop)
bool GetMoveReverseLooping ()
 GetMoveReverseLooping returns true if the move interpolation is set to loop back to the beginning once it reaches the end.
void SetMoveInterpolationTime (irr::u32 time)
irr::u32 GetMoveInterpolationTime ()
 GetMoveInterpolationTime returns the time to interpolate between start and end point for INTERPOLATED movement.
void SetMoveInterpolationValue (irr::f32 value)
irr::f32 GetMoveInterpolationValue ()
 Returns the current interpolation value (between 0 and 1) of movement interpolation.
void SetMoveStartPoint (irr::core::vector3df start)
irr::core::vector3df GetMoveStartPoint ()
 GetMoveStartPoint returns the initial point for INTERPOLATED movement.
void SetMoveEndPoint (irr::core::vector3df end)
irr::core::vector3df GetMoveEndPoint ()
 GetMoveEndPoint returns the ending point for INTERPOLATED movement.
void ReverseMoveInterpolation ()
 ReverseMoveInterpolation will cause the current movement interpolation to reverse direction. If it is already in reverse, the interpolation will begin going forward.
bool IsMoveInterpolatedReversed ()
 Returns true if the movement interpolation is going in reverse, and false if it is going forward.
void SetRotateLooping (bool loop)
bool GetRotateLooping ()
 GetRotateLooping returns true if the interpolated rotate task is looping, false if not.
void SetRotateReverseLooping (bool loop)
bool GetRotateReverseLooping ()
 GetRotateReverseLooping returns true if the rotate interpolation is set to loop back to the beginning once it reaches the end.
void SetRotateInterpolationTime (irr::u32 time)
irr::u32 GetRotateInterpolationTime ()
 GetMoveInterpolatedTime returns the time to interpolate between start and end point for INTERPOLATED rotation.
void SetRotateInterpolationValue (irr::f32 value)
irr::f32 GetRotateInterpolationValue ()
 Returns the current interpolation value (between 0 and 1) of the rotation interpolation.
void SetRotateStartPoint (irr::core::vector3df start)
irr::core::vector3df GetRotateStartPoint ()
 GetRotateStartPoint returns the initial point for INTERPOLATED rotation.
void SetRotateEndPoint (irr::core::vector3df end)
irr::core::vector3df GetRotateEndPoint ()
 GetRotateEndPoint returns the ending point for INTERPOLATED rotation.
void ReverseRotateInterpolation ()
 ReverseRotateInterpolation will cause the current rotation interpolation to reverse direction. If it is already in reverse, the interpolation will begin going forward.
bool IsRotateInterpolatedReversed ()
 Returns true if the rotation interpolation is going in reverse, and false if it is going forward.
void SetScaleLooping (bool loop)
bool GetScaleLooping ()
 GetScaleLooping returns true if the interpolated scale task is looping, false if not.
void SetScaleReverseLooping (bool loop)
bool GetScaleReverseLooping ()
 GetScaleReverseLooping returns true if the scale interpolation is set to loop back to the beginning once it reaches the end.
void SetScaleInterpolationTime (irr::u32 time)
irr::u32 GetScaleInterpolationTime ()
 GetScaleInterpolatedTime returns the time to interpolate between start and end point for INTERPOLATED scaling.
void SetScaleInterpolationValue (irr::f32 value)
irr::f32 GetScaleInterpolationValue ()
 Returns the current interpolation value (between 0 and 1) of the scale interpolation.
void SetScaleStartPoint (irr::core::vector3df start)
irr::core::vector3df GetScaleStartPoint ()
 GetScaleStartPoint returns the initial point for INTERPOLATED scaling.
void SetScaleEndPoint (irr::core::vector3df end)
irr::core::vector3df GetScaleEndPoint ()
 GetScaleEndPoint returns the ending point for INTERPOLATED scaling.
void ReverseScaleInterpolation ()
 ReverseScaleInterpolation will cause the current rotation interpolation to reverse direction. If it is already in reverse, the interpolation will begin going forward.
bool IsScaleInterpolatedReversed ()
 Returns true if the scale interpolation is going in reverse, and false if it is going forward.
void SetMoveWaypointLooping (bool loop)
bool GetMoveWaypointLooping ()
 GetMoveWaypointLooping returns true if the object is set to loop from the beginning if it reaches the last waypoints, false if not.
void SetMoveWaypointReverseLooping (bool loop)
bool GetMoveWaypointReverseLooping ()
 GetMoveWaypointReverseLooping returns true if the WAYPOINT movement is set to loop back to the beginning once it reaches the end.
void ClearMoveWaypoints ()
 ClearMoveWaypoints deletes all waypoints stored in the waypoint movement task.
irr::u32 GetNumMoveWaypoints ()
 GetNumMoveWaypoints returns the number of waypoints stored in the waypoint movement task.
void AddMoveWaypoint (irr::core::vector3df point, irr::u32 time)
 AddMoveWaypoint adds in a waypoint for the waypoint movement task.
irr::f32 GetMoveWaypointInterpolationValue ()
 Returns the current interpolation value of the movement, between 0 and 1.
void SetScaleWaypointLooping (bool loop)
bool GetScaleWaypointLooping ()
 GetMoveWaypointLooping returns true if the object is set to loop from the beginning if it reaches the last waypoints, false if not.
void SetScaleWaypointReverseLooping (bool loop)
bool GetScaleWaypointReverseLooping ()
 GetScaleWaypointReverseLooping returns true if the WAYPOINT movement is set to loop back to the beginning once it reaches the end.
void ClearScaleWaypoints ()
 ClearScaleWaypoints deletes all waypoints stored in the waypoint scaling task.
irr::u32 GetNumScaleWaypoints ()
 GetNumScaleWaypoints returns the number of waypoints stored in the waypoint scaling task.
void AddScaleWaypoint (irr::core::vector3df point, irr::u32 time)
 AddScaleWaypoint adds in a waypoint for the waypoint scaling task.
irr::f32 GetScaleWaypointInterpolationValue ()
 Returns the current interpolation value of the scaling, between 0 and 1.
void SetRotateWaypointLooping (bool loop)
bool GetRotateWaypointLooping ()
 GetRotateWaypointLooping returns true if the object is set to loop from the beginning if it reaches the last waypoints, false if not.
void SetRotateWaypointReverseLooping (bool loop)
bool GetRotateWaypointReverseLooping ()
 GetRotateWaypointReverseLooping returns true if the WAYPOINT rotation is set to loop back to the beginning once it reaches the end.
void ClearRotateWaypoints ()
 ClearRotateWaypoints deletes all waypoints stored in the waypoint rotation task.
irr::u32 GetNumRotateWaypoints ()
 GetNumRotateWaypoints returns the number of waypoints stored in the waypoint rotation task.
void AddRotateWaypoint (irr::core::vector3df point, irr::u32 time)
 AddRotateWaypoint adds in a waypoint for the waypoint rotation task.
irr::f32 GetRotateWaypointInterpolationValue ()
 Returns the current interpolation value of the rotation, between 0 and 1.
void AddChildTask (Task *t)
 This function provides a shorthand for adding tasks to the task tree as a part of the entity. It will automatically add the task given to it as a child of the entity's parent task, using the entity's current updateInterval as priority.
void RemoveChildTask (Task *t)
 This function provides a shorthand for removing a task that is a child task of this entity. It will remove from the tree the task given to it.

Protected Attributes

DustyDriver * dustyDriver
bool executeMultiple
bool removeNodeOnDestroy
irr::u32 updateInterval
EntityParentTask * parentTask
EntityActionType currentMoveAction
EntityActionType currentScaleAction
EntityActionType currentRotateAction
MoveTask * moveTask
RotateTask * rotateTask
ScaleTask * scaleTask
MoveInterpolatedTask * moveInterpolatedTask
ScaleInterpolatedTask * scaleInterpolatedTask
RotateInterpolatedTask * rotateInterpolatedTask
MoveBoundedTask * moveBoundedTask
ScaleBoundedTask * scaleBoundedTask
RotateBoundedTask * rotateBoundedTask
WaypointMoveInterpolatedTask * moveWaypointTask
WaypointScaleInterpolatedTask * scaleWaypointTask
WaypointRotateInterpolatedTask * rotateWaypointTask

Detailed Description

Entity class represents an object on screen that can be easily controlled through a single interface allowing many options for transformations.

The entity class brings all the movement/rotation/scale tasks into a single interface. This allows you to think of an Entity as an object on the screen. The object can be rotated, scaled, positioned.

There are 4 ways the Entity can affect the position/scale/rotation of the object.

Vector: A vector will be added to the position/scale/rotation each TaskTree update. Interpolated: The position/scale/rotation will be interpolated between 2 points over a given time. Bounded: Just like Vector, except the value cannot exceed a minimum and maximum boundary. Waypoint: The position/scale/rotation will loop through a series of waypoints, using time-based interpolation.

The Entity is a collection of DustyEngine tasks set to affect a common SceneNode. Therefore, it can be paused and unpaused just like a task. This will pause all movement/scaling/rotation on the node.

The programmer can mix and match the modes of the Entity at will. You can have the movement of the node using Interpolation between 2 points, the scale adding a Vector each update, and the Rotation using the Bounded method. You can pick any of the four types of actions for Movement, Scaling, and Rotation, all independently.

Definition at line 74 of file dustyentity.h.

Constructor & Destructor Documentation

DustyEngine::Entity::Entity (  DustyDriver *  d  ) 
 

Constructor creates Parent Task and all children tasks for the Entity.

Parameters:
dd,: A pointer to the Dusty Driver, so the Entity can set up all its tasks on the DustyEngine task tree.

virtual DustyEngine::Entity::~Entity (   )  [virtual]
 

Destructor destroys the entity and the tasks associated with it.

Member Function Documentation

void DustyEngine::Entity::AddChildTask (  Task *  t  ) 
 

This function provides a shorthand for adding tasks to the task tree as a part of the entity. It will automatically add the task given to it as a child of the entity's parent task, using the entity's current updateInterval as priority.

void DustyEngine::Entity::AddMoveWaypoint (  irr::core::vector3df  point,
irr::u32  time
) 
 

AddMoveWaypoint adds in a waypoint for the waypoint movement task.

Parameters:
point,: The point to move to.
time,: The amount of time between the last point and this point. Set to 0 if this is the first point.

void DustyEngine::Entity::AddRotateWaypoint (  irr::core::vector3df  point,
irr::u32  time
) 
 

AddRotateWaypoint adds in a waypoint for the waypoint rotation task.

Parameters:
point,: The point to rotate to.
time,: The amount of time between the last point and this point. Set to 0 if this is the first point.

void DustyEngine::Entity::AddScaleWaypoint (  irr::core::vector3df  point,
irr::u32  time
) 
 

AddScaleWaypoint adds in a waypoint for the waypoint scaling task.

Parameters:
point,: The point to scale to.
time,: The amount of time between the last point and this point. Set to 0 if this is the first point.

void DustyEngine::Entity::ClearMoveWaypoints (   ) 
 

ClearMoveWaypoints deletes all waypoints stored in the waypoint movement task.

void DustyEngine::Entity::ClearRotateWaypoints (   ) 
 

ClearRotateWaypoints deletes all waypoints stored in the waypoint rotation task.

void DustyEngine::Entity::ClearScaleWaypoints (   ) 
 

ClearScaleWaypoints deletes all waypoints stored in the waypoint scaling task.

bool DustyEngine::Entity::GetExecuteMultiple (   ) 
 

irr::u32 DustyEngine::Entity::GetMoveCollisionValue (   ) 
 

The bounded movement action type will return a collision value when it hits a boundary. This gets that value (See BoundedMoveTask).

irr::core::vector3df DustyEngine::Entity::GetMoveEndPoint (   ) 
 

GetMoveEndPoint returns the ending point for INTERPOLATED movement.

irr::u32 DustyEngine::Entity::GetMoveInterpolationTime (   ) 
 

GetMoveInterpolationTime returns the time to interpolate between start and end point for INTERPOLATED movement.

irr::f32 DustyEngine::Entity::GetMoveInterpolationValue (   ) 
 

Returns the current interpolation value (between 0 and 1) of movement interpolation.

bool DustyEngine::Entity::GetMoveLooping (   ) 
 

GetMoveLooping returns true if the interpolated move task is looping, false if not.

irr::core::vector3df DustyEngine::Entity::GetMoveMaxBoundary (   ) 
 

GetMoveMaxBoundary Returns maximum movement boundary.

irr::core::vector3df DustyEngine::Entity::GetMoveMinBoundary (   ) 
 

GetMoveMinBoundary Returns minimum movement boundary.

bool DustyEngine::Entity::GetMoveReverseLooping (   ) 
 

GetMoveReverseLooping returns true if the move interpolation is set to loop back to the beginning once it reaches the end.

irr::core::vector3df DustyEngine::Entity::GetMoveStartPoint (   ) 
 

GetMoveStartPoint returns the initial point for INTERPOLATED movement.

EntityActionType DustyEngine::Entity::GetMoveType (   ) 
 

GetMoveType returns the type of action currently being used for movement, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.

irr::core::vector3df DustyEngine::Entity::GetMoveVector (   ) 
 

GetMoveVector returns the vector that's added to the Entity's position each update.

irr::f32 DustyEngine::Entity::GetMoveWaypointInterpolationValue (   ) 
 

Returns the current interpolation value of the movement, between 0 and 1.

bool DustyEngine::Entity::GetMoveWaypointLooping (   ) 
 

GetMoveWaypointLooping returns true if the object is set to loop from the beginning if it reaches the last waypoints, false if not.

bool DustyEngine::Entity::GetMoveWaypointReverseLooping (   ) 
 

GetMoveWaypointReverseLooping returns true if the WAYPOINT movement is set to loop back to the beginning once it reaches the end.

irr::u32 DustyEngine::Entity::GetNumMoveWaypoints (   ) 
 

GetNumMoveWaypoints returns the number of waypoints stored in the waypoint movement task.

irr::u32 DustyEngine::Entity::GetNumRotateWaypoints (   ) 
 

GetNumRotateWaypoints returns the number of waypoints stored in the waypoint rotation task.

irr::u32 DustyEngine::Entity::GetNumScaleWaypoints (   ) 
 

GetNumScaleWaypoints returns the number of waypoints stored in the waypoint scaling task.

EntityParentTask* DustyEngine::Entity::GetParentTask (   ) 
 

GetParentTask returns a pointer to the parent task of the entity. The tasks that the entity uses for transformation all fall under this parent.

This function exists to allow the programmer to add other tasks to the entity that aren't created by default. Any task added under the parent task of the entity will be destroyed when the entity is destroyed.

bool DustyEngine::Entity::GetRemoveNodeOnDestroy (   ) 
 

Returns true if this entity is set to remove the node that it controls when it is destroyed, and false otherwise.

irr::u32 DustyEngine::Entity::GetRotateCollisionValue (   ) 
 

The bounded rotate action type will return a collision value when it hits a boundary. This gets that value (See BoundedRotateTask).

irr::core::vector3df DustyEngine::Entity::GetRotateEndPoint (   ) 
 

GetRotateEndPoint returns the ending point for INTERPOLATED rotation.

irr::u32 DustyEngine::Entity::GetRotateInterpolationTime (   ) 
 

GetMoveInterpolatedTime returns the time to interpolate between start and end point for INTERPOLATED rotation.

irr::f32 DustyEngine::Entity::GetRotateInterpolationValue (   ) 
 

Returns the current interpolation value (between 0 and 1) of the rotation interpolation.

bool DustyEngine::Entity::GetRotateLooping (   ) 
 

GetRotateLooping returns true if the interpolated rotate task is looping, false if not.

irr::core::vector3df DustyEngine::Entity::GetRotateMaxBoundary (   ) 
 

GetRotateMaxBoundary Returns maximum rotation boundary.

irr::core::vector3df DustyEngine::Entity::GetRotateMinBoundary (   ) 
 

GetRotateMinBoundary Returns minimum rotation boundary.

bool DustyEngine::Entity::GetRotateReverseLooping (   ) 
 

GetRotateReverseLooping returns true if the rotate interpolation is set to loop back to the beginning once it reaches the end.

irr::core::vector3df DustyEngine::Entity::GetRotateStartPoint (   ) 
 

GetRotateStartPoint returns the initial point for INTERPOLATED rotation.

EntityActionType DustyEngine::Entity::GetRotateType (   ) 
 

GetRotateType returns the type of action currently being used for rotation, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.

irr::core::vector3df DustyEngine::Entity::GetRotateVector (   ) 
 

GetRotateVector returns the vector that's added to the Entity's rotation each update.

irr::f32 DustyEngine::Entity::GetRotateWaypointInterpolationValue (   ) 
 

Returns the current interpolation value of the rotation, between 0 and 1.

bool DustyEngine::Entity::GetRotateWaypointLooping (   ) 
 

GetRotateWaypointLooping returns true if the object is set to loop from the beginning if it reaches the last waypoints, false if not.

bool DustyEngine::Entity::GetRotateWaypointReverseLooping (   ) 
 

GetRotateWaypointReverseLooping returns true if the WAYPOINT rotation is set to loop back to the beginning once it reaches the end.

irr::u32 DustyEngine::Entity::GetScaleCollisionValue (   ) 
 

The bounded scaling action type will return a collision value when it hits a boundary. This gets that value (See BoundedScaleTask).

irr::core::vector3df DustyEngine::Entity::GetScaleEndPoint (   ) 
 

GetScaleEndPoint returns the ending point for INTERPOLATED scaling.

irr::u32 DustyEngine::Entity::GetScaleInterpolationTime (   ) 
 

GetScaleInterpolatedTime returns the time to interpolate between start and end point for INTERPOLATED scaling.

irr::f32 DustyEngine::Entity::GetScaleInterpolationValue (   ) 
 

Returns the current interpolation value (between 0 and 1) of the scale interpolation.

bool DustyEngine::Entity::GetScaleLooping (   ) 
 

GetScaleLooping returns true if the interpolated scale task is looping, false if not.

irr::core::vector3df DustyEngine::Entity::GetScaleMaxBoundary (   ) 
 

GetScaleMaxBoundary Returns maximum scaling boundary.

irr::core::vector3df DustyEngine::Entity::GetScaleMinBoundary (   ) 
 

GetScaleMinBoundary Returns minimum scaling boundary.

bool DustyEngine::Entity::GetScaleReverseLooping (   ) 
 

GetScaleReverseLooping returns true if the scale interpolation is set to loop back to the beginning once it reaches the end.

irr::core::vector3df DustyEngine::Entity::GetScaleStartPoint (   ) 
 

GetScaleStartPoint returns the initial point for INTERPOLATED scaling.

EntityActionType DustyEngine::Entity::GetScaleType (   ) 
 

GetScaleType returns the type of action currently being used for scaling, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.

irr::core::vector3df DustyEngine::Entity::GetScaleVector (   ) 
 

GetScaleVector returns the vector that's added to the Entity's scale each update.

irr::f32 DustyEngine::Entity::GetScaleWaypointInterpolationValue (   ) 
 

Returns the current interpolation value of the scaling, between 0 and 1.

bool DustyEngine::Entity::GetScaleWaypointLooping (   ) 
 

GetMoveWaypointLooping returns true if the object is set to loop from the beginning if it reaches the last waypoints, false if not.

bool DustyEngine::Entity::GetScaleWaypointReverseLooping (   ) 
 

GetScaleWaypointReverseLooping returns true if the WAYPOINT movement is set to loop back to the beginning once it reaches the end.

irr::u32 DustyEngine::Entity::GetUpdateInterval (   ) 
 

GetUpdateInterval returns the number of milliseconds between each update of all the entity's tasks.

Returns:
Returns the priority of all the tasks in the entity.

bool DustyEngine::Entity::IsMoveInterpolatedReversed (   ) 
 

Returns true if the movement interpolation is going in reverse, and false if it is going forward.

bool DustyEngine::Entity::IsRotateInterpolatedReversed (   ) 
 

Returns true if the rotation interpolation is going in reverse, and false if it is going forward.

bool DustyEngine::Entity::IsScaleInterpolatedReversed (   ) 
 

Returns true if the scale interpolation is going in reverse, and false if it is going forward.

void DustyEngine::Entity::Pause (   ) 
 

Pause will pause the entity completely.

void DustyEngine::Entity::PauseMovement (   ) 
 

PauseMovement pauses only movement within the entity.

void DustyEngine::Entity::PauseRotation (   ) 
 

PauseRotation pauses only rotation within the entity.

void DustyEngine::Entity::PauseScaling (   ) 
 

PauseScaling pauses only scaling within the entity.

void DustyEngine::Entity::RemoveChildTask (  Task *  t  ) 
 

This function provides a shorthand for removing a task that is a child task of this entity. It will remove from the tree the task given to it.

void DustyEngine::Entity::ReverseMoveInterpolation (   ) 
 

ReverseMoveInterpolation will cause the current movement interpolation to reverse direction. If it is already in reverse, the interpolation will begin going forward.

void DustyEngine::Entity::ReverseRotateInterpolation (   ) 
 

ReverseRotateInterpolation will cause the current rotation interpolation to reverse direction. If it is already in reverse, the interpolation will begin going forward.

void DustyEngine::Entity::ReverseScaleInterpolation (   ) 
 

ReverseScaleInterpolation will cause the current rotation interpolation to reverse direction. If it is already in reverse, the interpolation will begin going forward.

void DustyEngine::Entity::SetExecuteMultiple (  bool  multiple  ) 
 

This sets all the tasks in the entity to use the given ExecuteMultiple flag.

void DustyEngine::Entity::SetMoveBoundaries (  irr::core::vector3df  min,
irr::core::vector3df  max
) 
 

SetMoveBoundaries sets the minimum and maximum movement boundaries when using BOUNDED movement.

The vector set using SetMoveVector will be added to the position each update. However, the object's position cannot go below the minimum or above the maximum given here.

void DustyEngine::Entity::SetMoveEndPoint (  irr::core::vector3df  end  ) 
 

SetMovementEndPoint sets the ending position for interpolation when using INTERPOLATED movement.

Parameters:
start,: The point to use as the beginning of interpolation.

void DustyEngine::Entity::SetMoveInterpolationTime (  irr::u32  time  ) 
 

SetMoveInterpolationTime sets the total time to interpolate between start point and end point using INTERPOLATED movement.

Parameters:
time,: Total time to interpolate, in milliseconds.

void DustyEngine::Entity::SetMoveInterpolationValue (  irr::f32  value  ) 
 

SetMoveInterpolationValue Sets the interpolation value for movement interpolation. This is a float value between 0 and 1, with 0 being start point and 1 being end point.

Parameters:
value,: The new interpolation value to use.

void DustyEngine::Entity::SetMoveLooping (  bool  loop  ) 
 

SetMoveLooping sets the interpolated movement to loop from the beginning once it reaches the end. param loop: set to true to turn on looping, false to turn it off

void DustyEngine::Entity::SetMoveMaxBoundary (  irr::core::vector3df  max  ) 
 

Sets the maximum boundary for movement when using BOUNDED movement.

void DustyEngine::Entity::SetMoveMinBoundary (  irr::core::vector3df  min  ) 
 

Sets the minimum boundary for movement when using BOUNDED movement.

void DustyEngine::Entity::SetMoveReverseLooping (  bool  loop  ) 
 

SetMoveReverseLooping will cause the move interpolation to loop back to the beginning once it reaches the end. param loop: set to true to turn on looping, false to turn it off

void DustyEngine::Entity::SetMoveStartPoint (  irr::core::vector3df  start  ) 
 

SetMoveStartPoint sets the initial position for interpolation when using INTERPOLATED movement.

Parameters:
start,: The point to use as the beginning of interpolation.

void DustyEngine::Entity::SetMoveType (  EntityActionType  type  ) 
 

SetMoveType sets the type of action to use for movement, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.

void DustyEngine::Entity::SetMoveVector (  irr::core::vector3df  vector  ) 
 

SetMoveVector sets the vector to add to the Entity's position each time it is updated.

The vector supplied will be used for both BOUNDED movement and VECTOR movement. It has no effect for INTERPOLATED or WAYPOINT movement.

void DustyEngine::Entity::SetMoveWaypointLooping (  bool  loop  ) 
 

SetMoveWaypointLooping will set the waypoint movement to loop back from the beginning once it reaches the end of the waypoints.

Parameters:
loop,: Set loop to true in order to have the object loop, false if not.

void DustyEngine::Entity::SetMoveWaypointReverseLooping (  bool  loop  ) 
 

SetMoveWaypointReverseLooping will set the waypoint rotation to loop back to the beginning once it reaches the end of the waypoints.

Parameters:
loop,: Set loop to true in order to have the object loop, false if not.

void DustyEngine::Entity::SetNode (  irr::scene::ISceneNode *  n  ) 
 

SetNode sets the node that this entity will transform.

Parameters:
n,: The node to transform.

Reimplemented from DustyEngine::NodeAffector.

void DustyEngine::Entity::SetRemoveNodeOnDestroy (  bool  remove  ) 
 

SetRemoveOnDestroy sets whether or not this entity will call remove() on the node that it is controlling when the entity is destroyed.

Parameters:
remove,: If true, this entity will call remove() on the node it controls when it's destroyed, which will automatically remove the node from the scene.

void DustyEngine::Entity::SetRotateBoundaries (  irr::core::vector3df  min,
irr::core::vector3df  max
) 
 

SetRotateBoundaries sets the minimum and maximum rotation boundaries when using BOUNDED rotating.

The vector set using SetRotateVector will be added to the rotation each update. However, the object's rotation cannot go below the minimum or above the maximum given here.

void DustyEngine::Entity::SetRotateEndPoint (  irr::core::vector3df  end  ) 
 

SetRotateEndPoint sets the ending rotation for interpolation when using INTERPOLATED rotation.

Parameters:
start,: The point to use as the beginning of interpolation.

void DustyEngine::Entity::SetRotateInterpolationTime (  irr::u32  time  ) 
 

SetRotateInterpolationTime sets the total time to interpolate between start point and end point using INTERPOLATED rotation.

Parameters:
time,: Total time to interpolate, in milliseconds.

void DustyEngine::Entity::SetRotateInterpolationValue (  irr::f32  value  ) 
 

Sets the interpolation value for rotation interpolation. This is a float value between 0 and 1, with 0 being start point and 1 being end point.

Parameters:
value,: The new interpolation value to use.

void DustyEngine::Entity::SetRotateLooping (  bool  loop  ) 
 

SetRotateLooping sets the interpolated rotation to loop from the beginning once it reaches the end. param loop: set to true to turn on looping, false to turn it off

void DustyEngine::Entity::SetRotateMaxBoundary (  irr::core::vector3df  max  ) 
 

Sets the maximum boundary for rotating when using BOUNDED rotation.

void DustyEngine::Entity::SetRotateMinBoundary (  irr::core::vector3df  min  ) 
 

Sets the minimum boundary for rotating when using BOUNDED rotation.

void DustyEngine::Entity::SetRotateReverseLooping (  bool  loop  ) 
 

SetRotateReverseLooping will cause the rotate interpolation to loop back to the beginning once it reaches the end. param loop: set to true to turn on looping, false to turn it off

void DustyEngine::Entity::SetRotateStartPoint (  irr::core::vector3df  start  ) 
 

SetRotateStartPoint sets the initial rotation for interpolation when using INTERPOLATED rotation.

Parameters:
start,: The point to use as the beginning of interpolation.

void DustyEngine::Entity::SetRotateType (  EntityActionType  type  ) 
 

SetRotateType sets the type of action to use for rotation, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.

void DustyEngine::Entity::SetRotateVector (  irr::core::vector3df  vector  ) 
 

SetRotateVector sets the vector to add to the Entity's rotation each time it is updated.

The vector supplied will be used for both BOUNDED rotation and VECTOR rotation. It has no effect for INTERPOLATED or WAYPOINT rotation.

void DustyEngine::Entity::SetRotateWaypointLooping (  bool  loop  ) 
 

SetRotateWaypointLooping will set the waypoint rotation to loop back from the beginning once it reaches the end of the waypoints.

Parameters:
loop,: Set loop to true in order to have the object loop, false if not.

void DustyEngine::Entity::SetRotateWaypointReverseLooping (  bool  loop  ) 
 

SetRotateWaypointReverseLooping will set the waypoint scaling to loop back to the beginning once it reaches the end of the waypoints.

Parameters:
loop,: Set loop to true in order to have the object loop, false if not.

void DustyEngine::Entity::SetScaleBoundaries (  irr::core::vector3df  min,
irr::core::vector3df  max
) 
 

SetScaleBoundaries sets the minimum and maximum scale boundaries when using BOUNDED scaling.

The vector set using SetScaleVector will be added to the scale each update. However, the object's scale cannot go below the minimum or above the maximum given here.

void DustyEngine::Entity::SetScaleEndPoint (  irr::core::vector3df  end  ) 
 

SetScaleEndPoint sets the ending scale for interpolation when using INTERPOLATED scaling.

Parameters:
start,: The point to use as the beginning of interpolation.

void DustyEngine::Entity::SetScaleInterpolationTime (  irr::u32  time  ) 
 

SetScaleInterpolationTime sets the total time to interpolate between start point and end point using INTERPOLATED scaling.

Parameters:
time,: Total time to interpolate, in milliseconds.

void DustyEngine::Entity::SetScaleInterpolationValue (  irr::f32  value  ) 
 

Sets the interpolation value for scale interpolation. This is a float value between 0 and 1, with 0 being start point and 1 being end point.

Parameters:
value,: The new interpolation value to use.

void DustyEngine::Entity::SetScaleLooping (  bool  loop  ) 
 

SetScaleLooping sets the interpolated scaling to loop from the beginning once it reaches the end. param loop: set to true to turn on looping, false to turn it off

void DustyEngine::Entity::SetScaleMaxBoundary (  irr::core::vector3df  max  ) 
 

Sets the maximum boundary for scaling when using BOUNDED scaling.

void DustyEngine::Entity::SetScaleMinBoundary (  irr::core::vector3df  min  ) 
 

Sets the minimum boundary for scaling when using BOUNDED scaling.

void DustyEngine::Entity::SetScaleReverseLooping (  bool  loop  ) 
 

SetScaleReverseLooping will cause the scale interpolation to loop back to the beginning once it reaches the end. param loop: set to true to turn on looping, false to turn it off

void DustyEngine::Entity::SetScaleStartPoint (  irr::core::vector3df  start  ) 
 

SetScaleStartPoint sets the initial scale for interpolation when using INTERPOLATED scaling.

Parameters:
start,: The point to use as the beginning of interpolation.

void DustyEngine::Entity::SetScaleType (  EntityActionType  type  ) 
 

SetScaleType sets the type of action to use for scaling, VECTOR, INTERPOLATED, WAYPOINT, or BOUNDED.

void DustyEngine::Entity::SetScaleVector (  irr::core::vector3df  vector  ) 
 

SetScaleVector sets the vector to add to the Entity's scale each time it is updated.

The vector supplied will be used for both BOUNDED scaling and VECTOR scaling. It has no effect for INTERPOLATED or WAYPOINT scaling.

void DustyEngine::Entity::SetScaleWaypointLooping (  bool  loop  ) 
 

SetScaleWaypointLooping will set the waypoint scaling to loop back from the beginning once it reaches the end of the waypoints.

Parameters:
loop,: Set loop to true in order to have the object loop, false if not.

void DustyEngine::Entity::SetScaleWaypointReverseLooping (  bool  loop  ) 
 

SetScaleWaypointReverseLooping will set the waypoint scaling to loop back to the beginning once it reaches the end of the waypoints.

Parameters:
loop,: Set loop to true in order to have the object loop, false if not.

void DustyEngine::Entity::SetUpdateInterval (  irr::u32  interval  ) 
 

The default interval is 20 milliseconds.

void DustyEngine::Entity::Unpause (   ) 
 

Unpause unpauses the entity.

void DustyEngine::Entity::UnpauseMovement (   ) 
 

UnpauseMovement will unpause only movement within the entity.

void DustyEngine::Entity::UnpauseRotation (   ) 
 

UnpauseRotation will unpause only rotation within the entity.

void DustyEngine::Entity::UnpauseScaling (   ) 
 

UnpauseScaling will unpause only scaling within the entity.

Member Data Documentation

EntityActionType DustyEngine::Entity::currentMoveAction [protected]
 

Definition at line 517 of file dustyentity.h.

EntityActionType DustyEngine::Entity::currentRotateAction [protected]
 

Definition at line 519 of file dustyentity.h.

EntityActionType DustyEngine::Entity::currentScaleAction [protected]
 

Definition at line 518 of file dustyentity.h.

DustyDriver* DustyEngine::Entity::dustyDriver [protected]
 

Definition at line 508 of file dustyentity.h.

bool DustyEngine::Entity::executeMultiple [protected]
 

Definition at line 510 of file dustyentity.h.

MoveBoundedTask* DustyEngine::Entity::moveBoundedTask [protected]
 

Definition at line 527 of file dustyentity.h.

MoveInterpolatedTask* DustyEngine::Entity::moveInterpolatedTask [protected]
 

Definition at line 524 of file dustyentity.h.

MoveTask* DustyEngine::Entity::moveTask [protected]
 

Definition at line 521 of file dustyentity.h.

WaypointMoveInterpolatedTask* DustyEngine::Entity::moveWaypointTask [protected]
 

Definition at line 530 of file dustyentity.h.

EntityParentTask* DustyEngine::Entity::parentTask [protected]
 

Definition at line 515 of file dustyentity.h.

bool DustyEngine::Entity::removeNodeOnDestroy [protected]
 

Definition at line 511 of file dustyentity.h.

RotateBoundedTask* DustyEngine::Entity::rotateBoundedTask [protected]
 

Definition at line 529 of file dustyentity.h.

RotateInterpolatedTask* DustyEngine::Entity::rotateInterpolatedTask [protected]
 

Definition at line 526 of file dustyentity.h.

RotateTask* DustyEngine::Entity::rotateTask [protected]
 

Definition at line 522 of file dustyentity.h.

WaypointRotateInterpolatedTask* DustyEngine::Entity::rotateWaypointTask [protected]
 

Definition at line 532 of file dustyentity.h.

ScaleBoundedTask* DustyEngine::Entity::scaleBoundedTask [protected]
 

Definition at line 528 of file dustyentity.h.

ScaleInterpolatedTask* DustyEngine::Entity::scaleInterpolatedTask [protected]
 

Definition at line 525 of file dustyentity.h.

ScaleTask* DustyEngine::Entity::scaleTask [protected]
 

Definition at line 523 of file dustyentity.h.

WaypointScaleInterpolatedTask* DustyEngine::Entity::scaleWaypointTask [protected]
 

Definition at line 531 of file dustyentity.h.

irr::u32 DustyEngine::Entity::updateInterval [protected]
 

Definition at line 513 of file dustyentity.h.

The documentation for this class was generated from the following file:
Generated on Fri Jan 27 17:31:58 2006 for Dusty Engine by  doxygen 1.4.6-NO