irrlicht/source/Irrlicht/CSceneNodeAnimatorCameraFPS.h
cutealien ffd7b63af0 API BREAKER: Replacing defines in irrTypes.h which are conflicting with c++ reserved identifier rules.
C++ has undefined behavior for identifiers starting with __ or with _ followed by an uppercase letter.
We still have many more (in IrrCompileConfig.h and in all header-guards), will likely replace those later as well.
As a workaround for users which might use irrlicht defines in their code, I've added the header irrLegacyDefines.h
Including that allows to continue using old defines for a while - or make it easier to have code which compiles 
with old and new Irrlicht library versions.


git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@6251 dfc29bdd-3216-0410-991c-e03cc46cb475
2021-08-27 12:55:10 +00:00

146 lines
4.4 KiB
C++

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h
#ifndef __C_SCENE_NODE_ANIMATOR_CAMERA_FPS_H_INCLUDED__
#define __C_SCENE_NODE_ANIMATOR_CAMERA_FPS_H_INCLUDED__
#include "ISceneNodeAnimatorCameraFPS.h"
#include "vector2d.h"
#include "position2d.h"
#include "SKeyMap.h"
#include "irrArray.h"
namespace irr
{
namespace gui
{
class ICursorControl;
}
namespace scene
{
//! Special scene node animator for FPS cameras
class CSceneNodeAnimatorCameraFPS : public ISceneNodeAnimatorCameraFPS
{
public:
//! Constructor
CSceneNodeAnimatorCameraFPS(gui::ICursorControl* cursorControl,
f32 rotateSpeed = 100.0f, f32 moveSpeed = .5f, f32 jumpSpeed=0.f,
SKeyMap* keyMapArray=0, u32 keyMapSize=0, bool noVerticalMovement=false,
bool invertY=false, float rotateSpeedKeyboard = 0.3f);
//! Destructor
virtual ~CSceneNodeAnimatorCameraFPS();
//! Animates the scene node, currently only works on cameras
virtual void animateNode(ISceneNode* node, u32 timeMs) IRR_OVERRIDE;
//! Event receiver
virtual bool OnEvent(const SEvent& event) IRR_OVERRIDE;
//! Returns the speed of movement in units per second
virtual f32 getMoveSpeed() const IRR_OVERRIDE;
//! Sets the speed of movement in units per second
virtual void setMoveSpeed(f32 moveSpeed) IRR_OVERRIDE;
//! Returns the rotation speed when moving mouse
virtual f32 getRotateSpeed() const IRR_OVERRIDE;
//! Set the rotation speed when moving mouse
virtual void setRotateSpeed(f32 rotateSpeed) IRR_OVERRIDE;
//! Returns the rotation speed when using keyboard
virtual f32 getRotateSpeedKeyboard() const IRR_OVERRIDE
{
return RotateSpeedKeyboard;
}
//! Set the rotation speed when using keyboard
virtual void setRotateSpeedKeyboard(f32 rotateSpeed) IRR_OVERRIDE
{
RotateSpeedKeyboard = rotateSpeed;
}
//! Sets the keyboard mapping for this animator (old style)
//! \param keymap: an array of keyboard mappings, see SKeyMap
//! \param count: the size of the keyboard map array
virtual void setKeyMap(SKeyMap *map, u32 count) IRR_OVERRIDE;
//! Sets the keyboard mapping for this animator
//! \param keymap The new keymap array
virtual void setKeyMap(const core::array<SKeyMap>& keymap) IRR_OVERRIDE;
//! Gets the keyboard mapping for this animator
virtual const core::array<SKeyMap>& getKeyMap() const IRR_OVERRIDE;
//! Sets whether vertical movement should be allowed.
virtual void setVerticalMovement(bool allow) IRR_OVERRIDE;
//! 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 setInvertMouse(bool invert) IRR_OVERRIDE;
//! This animator will receive events when attached to the active camera
virtual bool isEventReceiverEnabled() const IRR_OVERRIDE
{
return true;
}
//! Returns the type of this animator
virtual ESCENE_NODE_ANIMATOR_TYPE getType() const IRR_OVERRIDE
{
return ESNAT_CAMERA_FPS;
}
//! Creates a clone of this animator.
/** Please note that you will have to drop
(IReferenceCounted::drop()) the returned pointer once you're
done with it. */
virtual ISceneNodeAnimator* createClone(ISceneNode* node, ISceneManager* newManager=0) IRR_OVERRIDE;
//! Writes attributes of the scene node animator.
virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options=0) const IRR_OVERRIDE;
//! Reads attributes of the scene node animator.
virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options=0) IRR_OVERRIDE;
private:
void allKeysUp();
gui::ICursorControl *CursorControl;
bool GrabMouse;
f32 MaxVerticalAngle;
bool NoVerticalMovement;
f32 MoveSpeed;
f32 RotateSpeedKeyboard;
f32 RotateSpeed;
f32 JumpSpeed;
// -1.0f for inverted mouse, defaults to 1.0f
f32 MouseYDirection;
s32 LastAnimationTime;
core::array<SKeyMap> KeyMap;
core::position2d<f32> CenterCursor, CursorPos;
bool HadMouseEvent;
bool CursorKeys[EKA_COUNT];
bool firstUpdate;
bool firstInput;
};
} // end namespace scene
} // end namespace irr
#endif // __C_SCENE_NODE_ANIMATOR_CAMERA_FPS_H_INCLUDED__