Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members

nge::game::ISceneNodeControllerAnimator Class Reference

Special scene node animator for doing automatic movement in 3D space. More...

#include <ISceneNodeControllerAnimator.hpp>

Inheritance diagram for nge::game::ISceneNodeControllerAnimator:

ISceneNodeAnimator irr::IEventReceiver

List of all members.

Public Member Functions

virtual void animateNode (ISceneNode *node, u32 timeMs)=0
virtual f32 getMoveSpeed () const =0
 Get the animator's movement speed.
virtual f32 getRotateSpeed () const =0
 Get the animator's rotation speed.
virtual void invertRotation (bool X, bool Y)=0
 Set should the rotation on both X and Y axes be inverted.
virtual void invertXRotation (bool isInvert)=0
 Set should the rotation on the X axis be inverted.
virtual void invertYRotation (bool isInvert)=0
 Set should the rotation on the Y axis be inverted.
virtual bool isInputReceiverEnabled ()=0
 Returns if the input receiver of the animator is currently enabled.
virtual bool isKeyInputEnabled ()=0
 Returns if the the animator receives key input.
virtual bool isMouseCursorUsed () const =0
virtual bool isMouseInputEnabled ()=0
 Returns if the the animator receives mouse input.
virtual bool isVerticalMovementEnabled ()=0
 Returns if the scene node could move vertically or not.
virtual bool isXRotationInverted () const =0
 Returns whether the rotation on the X axis is inverted or not.
virtual bool isYRotationInverted () const =0
 Returns whether the rotation on the Y axis is inverted or not.
virtual bool OnEvent (const SEvent &event)=0
 called if an event happened.
virtual void setInputReceiverEnabled (bool enabled)=0
 Disables or enables the animator to get key or mouse input.
virtual void setKeyInputEnabled (bool enabled)=0
 Disables or enables the animator to get key input.
virtual void setKeyMap (SOpKeyMap *keyMapArray=0, u32 keyMapSize=0)=0
 Sets new controls, 0 for default.
virtual void setMouseInputEnabled (bool enabled)=0
 Disables or enables the animator to get mouse input.
virtual void setMoveSpeed (f32 speed)=0
 Set the animator's movement speed.
virtual void setRotateSpeed (f32 speed)=0
 Set the animator's rotation speed.
virtual void setVerticalMovementEnabled (bool enabled)=0
 Sets if the scene node could move vertically or not.
virtual void useMouseCursor (bool used)=0
virtual ~ISceneNodeControllerAnimator ()
 Destructor.


Detailed Description

Special scene node animator for doing automatic movement in 3D space.

This scene node animator can be attached to any scene node modifying it in that way, that it can move freely in 3D space, rotate and move with mouse and keyboard input.

Special thanks goes to 'arras' for his Free Flight (space flight) functions. You can check the tutorial here: http://irrlicht.sf.net/phpBB2/viewtopic.php?t=4680

Definition at line 30 of file ISceneNodeControllerAnimator.hpp.


Constructor & Destructor Documentation

virtual nge::game::ISceneNodeControllerAnimator::~ISceneNodeControllerAnimator (  )  [inline, virtual]

Destructor.

Definition at line 34 of file ISceneNodeControllerAnimator.hpp.


Member Function Documentation

virtual void nge::game::ISceneNodeControllerAnimator::animateNode ( ISceneNode node,
u32  timeMs 
) [pure virtual]

Animates a scene node.

Parameters:
node,: Node to animate.
timeMs,: Current time in milli seconds.

virtual f32 nge::game::ISceneNodeControllerAnimator::getMoveSpeed (  )  const [pure virtual]

Get the animator's movement speed.

virtual f32 nge::game::ISceneNodeControllerAnimator::getRotateSpeed (  )  const [pure virtual]

Get the animator's rotation speed.

virtual void nge::game::ISceneNodeControllerAnimator::invertRotation ( bool  X,
bool  Y 
) [pure virtual]

Set should the rotation on both X and Y axes be inverted.

virtual void nge::game::ISceneNodeControllerAnimator::invertXRotation ( bool  isInvert  )  [pure virtual]

Set should the rotation on the X axis be inverted.

virtual void nge::game::ISceneNodeControllerAnimator::invertYRotation ( bool  isInvert  )  [pure virtual]

Set should the rotation on the Y axis be inverted.

virtual bool nge::game::ISceneNodeControllerAnimator::isInputReceiverEnabled (  )  [pure virtual]

Returns if the input receiver of the animator is currently enabled.

virtual bool nge::game::ISceneNodeControllerAnimator::isKeyInputEnabled (  )  [pure virtual]

Returns if the the animator receives key input.

virtual bool nge::game::ISceneNodeControllerAnimator::isMouseCursorUsed (  )  const [pure virtual]

virtual bool nge::game::ISceneNodeControllerAnimator::isMouseInputEnabled (  )  [pure virtual]

Returns if the the animator receives mouse input.

virtual bool nge::game::ISceneNodeControllerAnimator::isVerticalMovementEnabled (  )  [pure virtual]

Returns if the scene node could move vertically or not.

virtual bool nge::game::ISceneNodeControllerAnimator::isXRotationInverted (  )  const [pure virtual]

Returns whether the rotation on the X axis is inverted or not.

virtual bool nge::game::ISceneNodeControllerAnimator::isYRotationInverted (  )  const [pure virtual]

Returns whether the rotation on the Y axis is inverted or not.

virtual bool nge::game::ISceneNodeControllerAnimator::OnEvent ( const SEvent event  )  [pure virtual]

called if an event happened.

Implements irr::IEventReceiver.

virtual void nge::game::ISceneNodeControllerAnimator::setInputReceiverEnabled ( bool  enabled  )  [pure virtual]

Disables or enables the animator to get key or mouse input.

virtual void nge::game::ISceneNodeControllerAnimator::setKeyInputEnabled ( bool  enabled  )  [pure virtual]

Disables or enables the animator to get key input.

virtual void nge::game::ISceneNodeControllerAnimator::setKeyMap ( SOpKeyMap keyMapArray = 0,
u32  keyMapSize = 0 
) [pure virtual]

Sets new controls, 0 for default.

virtual void nge::game::ISceneNodeControllerAnimator::setMouseInputEnabled ( bool  enabled  )  [pure virtual]

Disables or enables the animator to get mouse input.

virtual void nge::game::ISceneNodeControllerAnimator::setMoveSpeed ( f32  speed  )  [pure virtual]

Set the animator's movement speed.

virtual void nge::game::ISceneNodeControllerAnimator::setRotateSpeed ( f32  speed  )  [pure virtual]

Set the animator's rotation speed.

virtual void nge::game::ISceneNodeControllerAnimator::setVerticalMovementEnabled ( bool  enabled  )  [pure virtual]

Sets if the scene node could move vertically or not.

virtual void nge::game::ISceneNodeControllerAnimator::useMouseCursor ( bool  used  )  [pure virtual]


The documentation for this class was generated from the following file:

The NUSoftware Game Engine
The NUSoftware Game Engine Documentation © 2007-2008 by Tomer Nosrati. Generated on Sat Apr 26 16:52:36 2008 by Doxygen (1.5.5)