Saga3D API Documentation  1.0-RC4
saga::scene::ISceneNodeAnimatorCameraFPS Class Referenceabstract

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

#include <ISceneNodeAnimatorCameraFPS.h>

Inheritance diagram for saga::scene::ISceneNodeAnimatorCameraFPS:
saga::scene::ISceneNodeAnimator saga::IEventReceiver

Public Member Functions

virtual float getMoveSpeed () const =0
 Returns the speed of movement in units per millisecond. More...
 
virtual void setMoveSpeed (float moveSpeed)=0
 Sets the speed of movement in units per millisecond. More...
 
virtual float getRotateSpeed () const =0
 Returns the rotation speed in degrees when using mouse. More...
 
virtual void setRotateSpeed (float rotateSpeed)=0
 Set the rotation speed in degrees when using mouse. More...
 
virtual void setInvertMouse (bool invert)=0
 Sets whether the Y axis of the mouse should be inverted. More...
 
- Public Member Functions inherited from saga::scene::ISceneNodeAnimator
 ISceneNodeAnimator ()
 
virtual void animateNode (ISceneNode &node, const float time)=0
 Animates a scene node. More...
 
virtual void onEvent (const SDL_Event &event) override
 Creates a clone of this animator. More...
 
virtual E_SCENE_NODE_ANIMATOR_TYPE getType () const
 Returns type of the scene node animator. More...
 
virtual bool hasFinished (void) const
 Returns if the animator has finished. More...
 
virtual void setStartTime (std::uint32_t time, bool resetPauseTime=true)
 Reset a time-based movement by changing the starttime. More...
 
virtual std::uint32_t getStartTime () const
 Get the starttime. More...
 
virtual void setEnabled (bool enabled, std::uint32_t timeNow=0)
 Sets the enabled state of this element. More...
 
virtual bool isEnabled () const
 
- Public Member Functions inherited from saga::IEventReceiver
virtual ~IEventReceiver ()
 Destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from saga::scene::ISceneNodeAnimator
bool IsEnabled
 
std::uint32_t PauseTimeSum
 Only enabled animators are updated. More...
 
std::uint32_t PauseTimeStart
 Sum up time which the animator was disabled. More...
 
std::uint32_t StartTime
 Last time setEnabled(false) was called with a timer > 0. More...
 

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 20 of file ISceneNodeAnimatorCameraFPS.h.

Member Function Documentation

◆ getMoveSpeed()

virtual float saga::scene::ISceneNodeAnimatorCameraFPS::getMoveSpeed ( ) const
pure virtual

Returns the speed of movement in units per millisecond.

◆ getRotateSpeed()

virtual float saga::scene::ISceneNodeAnimatorCameraFPS::getRotateSpeed ( ) const
pure virtual

Returns the rotation speed in degrees when using mouse.

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.

◆ setInvertMouse()

virtual void saga::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.

◆ setMoveSpeed()

virtual void saga::scene::ISceneNodeAnimatorCameraFPS::setMoveSpeed ( float  moveSpeed)
pure virtual

Sets the speed of movement in units per millisecond.

◆ setRotateSpeed()

virtual void saga::scene::ISceneNodeAnimatorCameraFPS::setRotateSpeed ( float  rotateSpeed)
pure virtual

Set the rotation speed in degrees when using mouse.


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