DustyEngine::WaypointRotateInterpolatedTask Class Reference

#include <dustywaypointrotateinterpolatedtask.h>

Inheritance diagram for DustyEngine::WaypointRotateInterpolatedTask:

DustyEngine::RotateInterpolatedTask DustyEngine::VectorInterpolatedTask DustyEngine::NodeAffector DustyEngine::InterpolatedTask DustyEngine::DummyTask DustyEngine::Task List of all members.

Public Member Functions

 WaypointRotateInterpolatedTask ()
 The constructor does nothing.
virtual ~WaypointRotateInterpolatedTask ()
void AddWaypoint (irr::core::vector3df point, irr::u32 time=0)
 AddWaypoint adds a point to the waypoint list.
void SetInterpolationTime (irr::u32 time)
void SetStartVector (irr::core::vector3df sv)
void SetEndVector (irr::core::vector3df ev)
void ClearWaypoints ()
 ClearWaypoints() clears all the waypoints in the task.
void OnUpdate ()
 OnUpdate() is called by the TaskTree when the time has come to execute the task's code.
irr::u32 NumWaypoints ()

Protected Member Functions

void UpdateVectorsAndTime ()
void UpdateWaypointList ()
void AddWaypointToList (irr::core::vector3df start, irr::core::vector3df end, irr::u32 startTime, irr::u32 endTime)

Protected Attributes

irr::core::array< WaypointPointwaypoints
irr::core::array< WaypointListItemwaypointList

Detailed Description

WaypointRotateInterpolatedTask will rotate a node using an interpolated time-based algorithm along a series of waypoints.

Definition at line 16 of file dustywaypointrotateinterpolatedtask.h.


Constructor & Destructor Documentation

DustyEngine::WaypointRotateInterpolatedTask::WaypointRotateInterpolatedTask  ) 
 

The constructor does nothing.

virtual DustyEngine::WaypointRotateInterpolatedTask::~WaypointRotateInterpolatedTask  )  [virtual]
 


Member Function Documentation

void DustyEngine::WaypointRotateInterpolatedTask::AddWaypoint irr::core::vector3df  point,
irr::u32  time = 0
 

AddWaypoint adds a point to the waypoint list.

Parameters:
point,: The point which to iterate towards for this waypoint.
time,: The time between this waypoint and the one before it. If this is the first waypoint, it should be set to 0.

void DustyEngine::WaypointRotateInterpolatedTask::AddWaypointToList irr::core::vector3df  start,
irr::core::vector3df  end,
irr::u32  startTime,
irr::u32  endTime
[protected]
 

void DustyEngine::WaypointRotateInterpolatedTask::ClearWaypoints  ) 
 

ClearWaypoints() clears all the waypoints in the task.

irr::u32 DustyEngine::WaypointRotateInterpolatedTask::NumWaypoints  )  [inline]
 

NumWaypoints returns the number of waypoints.

Returns:
Returns number of waypoints in the task.

Definition at line 48 of file dustywaypointrotateinterpolatedtask.h.

void DustyEngine::WaypointRotateInterpolatedTask::OnUpdate  )  [virtual]
 

OnUpdate() is called by the TaskTree when the time has come to execute the task's code.

OnUpdate is typically the most important function. OnUpdate is only called when enough time has passed or every frame, depending upon what the priority of the task is. If you want code to execute on a time-based basis, put that code here and add the task to the tree.

Reimplemented from DustyEngine::RotateInterpolatedTask.

void DustyEngine::WaypointRotateInterpolatedTask::SetEndVector irr::core::vector3df  ev  ) 
 

SetEndVector sets the vector which should be used as the ending of interpolation.

Parameters:
ev,: The ending vector to use for interpolation.

Reimplemented from DustyEngine::VectorInterpolatedTask.

void DustyEngine::WaypointRotateInterpolatedTask::SetInterpolationTime irr::u32  time  ) 
 

SetInterpolationTime sets the total amount of time it should take for the interpolation to move from 0 to 1.

Parameters:
time,: The total amount of time it should take.

Reimplemented from DustyEngine::InterpolatedTask.

void DustyEngine::WaypointRotateInterpolatedTask::SetStartVector irr::core::vector3df  sv  ) 
 

SetStartVector will set the beginning vector for interpolation.

Parameters:
sv,: The beginning vector to use for interpolation.

Reimplemented from DustyEngine::VectorInterpolatedTask.

void DustyEngine::WaypointRotateInterpolatedTask::UpdateVectorsAndTime  )  [protected]
 

void DustyEngine::WaypointRotateInterpolatedTask::UpdateWaypointList  )  [protected]
 


Member Data Documentation

irr::core::array<WaypointListItem> DustyEngine::WaypointRotateInterpolatedTask::waypointList [protected]
 

Definition at line 59 of file dustywaypointrotateinterpolatedtask.h.

irr::core::array<WaypointPoint> DustyEngine::WaypointRotateInterpolatedTask::waypoints [protected]
 

Definition at line 58 of file dustywaypointrotateinterpolatedtask.h.


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