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

#include <ISceneNodeAnimatorCameraFPS.h>

Inheritance diagram for irr::scene::ISceneNodeAnimatorCameraFPS:

Public Member Functions
virtual f32	getMoveSpeed () const =0
	Returns the speed of movement in units per millisecond. More...

virtual void	setMoveSpeed (f32 moveSpeed)=0
	Sets the speed of movement in units per millisecond. More...

virtual f32	getRotateSpeedKeyboard () const =0
	Returns the rotation speed when using keyboard. More...

virtual void	setRotateSpeedKeyboard (f32 rotateSpeed)=0
	Set the rotation speed when using keyboard. More...

virtual f32	getRotateSpeed () const =0
	Returns the rotation speed in degrees when using mouse. More...

virtual void	setRotateSpeed (f32 rotateSpeed)=0
	Set the rotation speed in degrees when using mouse. More...

virtual void	setKeyMap (SKeyMap *map, u32 count)=0
	Sets the keyboard mapping for this animator (old style) More...

virtual void	setKeyMap (const core::array< SKeyMap > &keymap)=0

virtual const core::array< SKeyMap > &	getKeyMap () const =0
	Gets the keyboard mapping for this animator. More...

virtual void	setVerticalMovement (bool allow)=0
	Sets whether vertical movement should be allowed. More...

virtual void	setInvertMouse (bool invert)=0
	Sets whether the Y axis of the mouse should be inverted. More...

Public Member Functions inherited from irr::scene::ISceneNodeAnimator
	ISceneNodeAnimator ()

virtual void	animateNode (ISceneNode *node, u32 timeMs)=0
	Animates a scene node. More...

virtual ISceneNodeAnimator *	createClone (ISceneNode node, ISceneManager newManager=0)=0
	Creates a clone of this animator. More...

virtual bool	isEventReceiverEnabled () const
	Returns true if this animator receives events. More...

virtual bool	OnEvent (const SEvent &event) _IRR_OVERRIDE_
	Event receiver, override this function for camera controlling animators. More...

virtual ESCENE_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 (u32 time, bool resetPauseTime=true)
	Reset a time-based movement by changing the starttime. More...

virtual irr::u32	getStartTime () const
	Get the starttime. More...

virtual void	setEnabled (bool enabled, u32 timeNow=0)
	Sets the enabled state of this element. More...

virtual bool	isEnabled () const

virtual void	serializeAttributes (io::IAttributes out, io::SAttributeReadWriteOptions options=0) const _IRR_OVERRIDE_
	Writes attributes of the scene node animator. More...

virtual void	deserializeAttributes (io::IAttributes in, io::SAttributeReadWriteOptions options=0) _IRR_OVERRIDE_
	Reads attributes of the scene node animator. More...

Public Member Functions inherited from irr::IReferenceCounted
	IReferenceCounted ()
	Constructor. More...

virtual	~IReferenceCounted ()
	Destructor. More...

void	grab () const
	Grabs the object. Increments the reference counter by one. More...

bool	drop () const
	Drops the object. Decrements the reference counter by one. More...

s32	getReferenceCount () const
	Get the reference count. More...

const c8 *	getDebugName () const
	Returns the debug name of the object. More...

Public Member Functions inherited from irr::IEventReceiver
virtual	~IEventReceiver ()
	Destructor. More...

Additional Inherited Members
Protected Member Functions inherited from irr::scene::ISceneNodeAnimator
void	cloneMembers (const ISceneNodeAnimator *toCopyFrom)

Protected Member Functions inherited from irr::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object. More...

Protected Attributes inherited from irr::scene::ISceneNodeAnimator
bool	IsEnabled

u32	PauseTimeSum
	Only enabled animators are updated. More...

u32	PauseTimeStart
	Sum up time which the animator was disabled. More...

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

Member Function Documentation

◆ getKeyMap()

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

pure virtual

Gets the keyboard mapping for this animator.

◆ getMoveSpeed()

virtual f32 irr::scene::ISceneNodeAnimatorCameraFPS::getMoveSpeed ( ) const

pure virtual

Returns the speed of movement in units per millisecond.

◆ getRotateSpeed()

virtual f32 irr::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.

◆ getRotateSpeedKeyboard()

virtual f32 irr::scene::ISceneNodeAnimatorCameraFPS::getRotateSpeedKeyboard ( ) const

pure virtual

Returns the rotation speed when using keyboard.

◆ setInvertMouse()

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.

◆ setKeyMap() [1/2]

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setKeyMap	(	SKeyMap *	map,
		u32	count
	)

pure virtual

Sets the keyboard mapping for this animator (old style)

Parameters

map	Array of keyboard mappings, see irr::SKeyMap
count	Size of the keyboard map array.

◆ setKeyMap() [2/2]

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setKeyMap ( const core::array< SKeyMap > & keymap )

pure virtual

Sets the keyboard mapping for this animator

Parameters

keymap The new keymap array

◆ setMoveSpeed()

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setMoveSpeed ( f32 moveSpeed )

pure virtual

Sets the speed of movement in units per millisecond.

◆ setRotateSpeed()

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setRotateSpeed ( f32 rotateSpeed )

pure virtual

Set the rotation speed in degrees when using mouse.

◆ setRotateSpeedKeyboard()

virtual void irr::scene::ISceneNodeAnimatorCameraFPS::setRotateSpeedKeyboard ( f32 rotateSpeed )

pure virtual

Set the rotation speed when using keyboard.

◆ setVerticalMovement()

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:

include/irrlicht/ISceneNodeAnimatorCameraFPS.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getKeyMap()

◆ getMoveSpeed()

◆ getRotateSpeed()

◆ getRotateSpeedKeyboard()

◆ setInvertMouse()

◆ setKeyMap() [1/2]

◆ setKeyMap() [2/2]

◆ setMoveSpeed()

◆ setRotateSpeed()

◆ setRotateSpeedKeyboard()

◆ setVerticalMovement()