DustyEngine::ScaleBoundedTask Class Reference

#include <dustyscaleboundedtask.h>

Inheritance diagram for DustyEngine::ScaleBoundedTask:

DustyEngine::ScaleTask DustyEngine::DummyTask DustyEngine::NodeAffector DustyEngine::Task List of all members.

Public Member Functions

 ScaleBoundedTask ()
 Constructor does nothing.
virtual ~ScaleBoundedTask ()
void SetBoundaries (irr::core::vector3df min, irr::core::vector3df max)
irr::core::vector3df GetMinBoundary ()
irr::core::vector3df GetMaxBoundary ()
irr::u32 GetCollisionValue ()
void OnUpdate ()
 ScaleTask's OnUpdate will add a vector to the scale of a SceneNode that is associated with the task each time it is executed.

Protected Attributes

irr::core::vector3df minBoundary
irr::core::vector3df maxBoundary
irr::u32 collisionValue

Detailed Description

The ScaleBoundedClass will scale a node inside of a "fence" boundary. This boundary is set as min and max vectors which the node is tested against each time the task is executed. The node's scale will remain inside that min and max space.

Definition at line 16 of file dustyscaleboundedtask.h.


Constructor & Destructor Documentation

DustyEngine::ScaleBoundedTask::ScaleBoundedTask  ) 
 

Constructor does nothing.

virtual DustyEngine::ScaleBoundedTask::~ScaleBoundedTask  )  [virtual]
 


Member Function Documentation

irr::u32 DustyEngine::ScaleBoundedTask::GetCollisionValue  )  [inline]
 

The value of this function can be either BCT_NO_COLLISION, or any combination of the constants BCT_MIN_X, BCT_MAX_X, BCT_MIN_Y, BCT_MAX_Y, BCT_MIN_Z, and BCT_MAX_Z. If the value is BCT_MIN_X, for instance, it means the node has collided against the minimum x value.

Returns:
Returns the current collision value.

Definition at line 54 of file dustyscaleboundedtask.h.

irr::core::vector3df DustyEngine::ScaleBoundedTask::GetMaxBoundary  )  [inline]
 

GetMaxBoundary returns the highest point this node is allowed to scale to.

Returns:
Returns the maximum value of the boundary.

Definition at line 41 of file dustyscaleboundedtask.h.

irr::core::vector3df DustyEngine::ScaleBoundedTask::GetMinBoundary  )  [inline]
 

GetMinBoundary returns the smallest point this node is allowed to scale to.

Returns:
Returns the minimum value of the boundary.

Definition at line 34 of file dustyscaleboundedtask.h.

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

ScaleTask's OnUpdate will add a vector to the scale of a SceneNode that is associated with the task each time it is executed.

Reimplemented from DustyEngine::ScaleTask.

void DustyEngine::ScaleBoundedTask::SetBoundaries irr::core::vector3df  min,
irr::core::vector3df  max
[inline]
 

SetBoundaries sets the boundaries of the "Fence" around the node's scale.

Parameters:
min,: The minimum scale the node is allowed to achieve.
max,: The maximum scale the node is allowed to achieve.

Definition at line 26 of file dustyscaleboundedtask.h.


Member Data Documentation

irr::u32 DustyEngine::ScaleBoundedTask::collisionValue [protected]
 

Definition at line 65 of file dustyscaleboundedtask.h.

irr::core::vector3df DustyEngine::ScaleBoundedTask::maxBoundary [protected]
 

Definition at line 63 of file dustyscaleboundedtask.h.

irr::core::vector3df DustyEngine::ScaleBoundedTask::minBoundary [protected]
 

Definition at line 62 of file dustyscaleboundedtask.h.


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