Irrlicht 3D Engine
irr::scene::ISceneNodeAnimatorCameraFPS Class Reference

Special scene node animator for FPS cameras. More...

#include <ISceneNodeAnimatorCameraFPS.h>

+ Inheritance diagram for irr::scene::ISceneNodeAnimatorCameraFPS:

List of all members.

Public Member Functions


Detailed Description

Special scene node animator for FPS cameras.

This scene node animator can be attached to a camera to make it act like a first person shooter

Definition at line 23 of file ISceneNodeAnimatorCameraFPS.h.


Member Function Documentation

virtual const core::array<SKeyMap>& irr::scene::ISceneNodeAnimatorCameraFPS::getKeyMap ( ) const [pure virtual]

Gets the keyboard mapping for this animator.

virtual f32 irr::scene::ISceneNodeAnimatorCameraFPS::getMoveSpeed ( ) const [pure virtual]

Returns the speed of movement in units per millisecond.

virtual f32 irr::scene::ISceneNodeAnimatorCameraFPS::getRotateSpeed ( ) const [pure virtual]

Returns the rotation speed in degrees.

The degrees are equivalent to a half screen movement of the mouse, i.e. if the mouse cursor had been moved to the border of the screen since the last animation.

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setInvertMouse ( bool  invert) [pure virtual]

Sets whether the Y axis of the mouse should be inverted.

If enabled then moving the mouse down will cause the camera to look up. It is disabled by default.

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setKeyMap ( SKeyMap map,
u32  count 
) [pure virtual]

Sets the keyboard mapping for this animator (old style)

Parameters:
mapArray of keyboard mappings, see irr::SKeyMap
countSize of the keyboard map array.
virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setKeyMap ( const core::array< SKeyMap > &  keymap) [pure virtual]

Sets the keyboard mapping for this animator

Parameters:
keymapThe new keymap array
virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setMoveSpeed ( f32  moveSpeed) [pure virtual]

Sets the speed of movement in units per millisecond.

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setRotateSpeed ( f32  rotateSpeed) [pure virtual]

Set the rotation speed in degrees.

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setVerticalMovement ( bool  allow) [pure virtual]

Sets whether vertical movement should be allowed.

If vertical movement is enabled then the camera may fight with gravity causing camera shake. Disable this if the camera has a collision animator with gravity enabled.


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