Irrlicht 3D Engine
ICameraSceneNode.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
2 // This file is part of the "Irrlicht Engine".
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
4 
5 #ifndef __I_CAMERA_SCENE_NODE_H_INCLUDED__
6 #define __I_CAMERA_SCENE_NODE_H_INCLUDED__
7 
8 #include "ISceneNode.h"
9 #include "IEventReceiver.h"
10 
11 namespace irr
12 {
13 namespace scene
14 {
15  struct SViewFrustum;
16 
18 
24  {
25  public:
26 
29  const core::vector3df& position = core::vector3df(0,0,0),
30  const core::vector3df& rotation = core::vector3df(0,0,0),
31  const core::vector3df& scale = core::vector3df(1.0f,1.0f,1.0f))
32  : ISceneNode(parent, mgr, id, position, rotation, scale), IsOrthogonal(false) {}
33 
35 
45  virtual void setProjectionMatrix(const core::matrix4& projection, bool isOrthogonal=false) =0;
46 
48 
49  virtual const core::matrix4& getProjectionMatrix() const =0;
50 
52 
53  virtual const core::matrix4& getViewMatrix() const =0;
54 
56 
60  virtual void setViewMatrixAffector(const core::matrix4& affector) =0;
61 
63 
64  virtual const core::matrix4& getViewMatrixAffector() const =0;
65 
67 
73  virtual bool OnEvent(const SEvent& event) =0;
74 
76 
83  virtual void setTarget(const core::vector3df& pos) =0;
84 
86 
91  virtual void setRotation(const core::vector3df& rotation) =0;
92 
94 
95  virtual const core::vector3df& getTarget() const =0;
96 
98 
99  virtual void setUpVector(const core::vector3df& pos) =0;
100 
102 
103  virtual const core::vector3df& getUpVector() const =0;
104 
106 
107  virtual f32 getNearValue() const =0;
108 
110 
111  virtual f32 getFarValue() const =0;
112 
114 
115  virtual f32 getAspectRatio() const =0;
116 
118 
119  virtual f32 getFOV() const =0;
120 
122 
123  virtual void setNearValue(f32 zn) =0;
124 
126 
127  virtual void setFarValue(f32 zf) =0;
128 
130 
131  virtual void setAspectRatio(f32 aspect) =0;
132 
134 
135  virtual void setFOV(f32 fovy) =0;
136 
138 
139  virtual const SViewFrustum* getViewFrustum() const =0;
140 
142 
144  virtual void setInputReceiverEnabled(bool enabled) =0;
145 
147  virtual bool isInputReceiverEnabled() const =0;
148 
150  virtual bool isOrthogonal() const
151  {
152  return IsOrthogonal;
153  }
154 
156 
164  virtual void bindTargetAndRotation(bool bound) =0;
165 
167  virtual void updateMatrices() = 0;
168 
170 
171  virtual bool getTargetAndRotationBinding(void) const =0;
172 
175  {
176  ISceneNode::serializeAttributes(out, options);
177 
178  if (!out)
179  return;
180  out->addBool("IsOrthogonal", IsOrthogonal);
181  }
182 
185  {
187  if (!in)
188  return;
189 
190  if ( in->findAttribute("IsOrthogonal") )
191  IsOrthogonal = in->getAttributeAsBool("IsOrthogonal");
192  }
193 
194  protected:
195 
196  void cloneMembers(ICameraSceneNode* toCopyFrom)
197  {
198  IsOrthogonal = toCopyFrom->IsOrthogonal;
199  }
200 
202  };
203 
204 } // end namespace scene
205 } // end namespace irr
206 
207 #endif
208 
Scene Node which is a (controllable) camera.
Provides a generic interface for attributes and their values and the possibility to serialize them.
Definition: IAttributes.h:41
SEvents hold information about an event. See irr::IEventReceiver for details on event handling.
virtual bool getAttributeAsBool(const c8 *attributeName, bool defaultNotFound=false) const =0
virtual const core::vector3df & getTarget() const =0
Gets the current look at target of the camera.
float f32
32 bit floating point variable.
Definition: irrTypes.h:108
virtual bool OnEvent(const SEvent &event)=0
It is possible to send mouse and key events to the camera.
virtual void setFarValue(f32 zf)=0
Sets the value of the far clipping plane (default: 2000.0f)
virtual f32 getFOV() const =0
Gets the field of view of the camera.
Scene node interface.
Definition: ISceneNode.h:40
virtual bool getTargetAndRotationBinding(void) const =0
Queries if the camera scene node's rotation and its target position are bound together.
virtual const core::matrix4 & getProjectionMatrix() const =0
Gets the current projection matrix of the camera.
virtual void serializeAttributes(io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
Writes attributes of the scene node.
Definition: ISceneNode.h:700
struct holding data describing options
virtual const core::vector3df & getUpVector() const =0
Gets the up vector of the camera.
virtual void setFOV(f32 fovy)=0
Sets the field of view (Default: PI / 2.5f)
virtual void addBool(const c8 *attributeName, bool value)=0
Adds an attribute as bool.
virtual void deserializeAttributes(io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
Reads attributes of the camera node.
Everything in the Irrlicht Engine can be found in this namespace.
Definition: aabbox3d.h:12
virtual f32 getFarValue() const =0
Gets the value of the far plane of the camera.
ICameraSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id, const core::vector3df &position=core::vector3df(0, 0, 0), const core::vector3df &rotation=core::vector3df(0, 0, 0), const core::vector3df &scale=core::vector3df(1.0f, 1.0f, 1.0f))
Constructor.
virtual void bindTargetAndRotation(bool bound)=0
Binds the camera scene node's rotation to its target position and vice versa, or unbinds them.
virtual const SViewFrustum * getViewFrustum() const =0
Get the view frustum.
Defines the view frustum. That's the space visible by the camera.
Definition: SViewFrustum.h:25
void cloneMembers(ICameraSceneNode *toCopyFrom)
virtual const core::matrix4 & getViewMatrixAffector() const =0
Get the custom view matrix affector.
virtual void setViewMatrixAffector(const core::matrix4 &affector)=0
Sets a custom view matrix affector.
Interface of an object which can receive events.
virtual void serializeAttributes(io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
Writes attributes of the camera node.
signed int s32
32 bit signed variable.
Definition: irrTypes.h:70
virtual const core::matrix4 & getViewMatrix() const =0
Gets the current view matrix of the camera.
virtual void setNearValue(f32 zn)=0
Sets the value of the near clipping plane. (default: 1.0f)
virtual void setProjectionMatrix(const core::matrix4 &projection, bool isOrthogonal=false)=0
Sets the projection matrix of the camera.
virtual void setUpVector(const core::vector3df &pos)=0
Sets the up vector of the camera.
virtual void setTarget(const core::vector3df &pos)=0
Sets the look at target of the camera.
virtual void deserializeAttributes(io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
Reads attributes of the scene node.
Definition: ISceneNode.h:725
virtual s32 findAttribute(const c8 *attributeName) const =0
Returns attribute index from name, -1 if not found.
4x4 matrix. Mostly used as transformation matrix for 3d calculations.
Definition: matrix4.h:45
virtual void setAspectRatio(f32 aspect)=0
Sets the aspect ratio (default: 4.0f / 3.0f)
virtual void updateMatrices()=0
Updates the matrices without uploading them to the driver.
The Scene Manager manages scene nodes, mesh resources, cameras and all the other stuff.
virtual void setRotation(const core::vector3df &rotation)=0
Sets the rotation of the node.
virtual f32 getAspectRatio() const =0
Gets the aspect ratio of the camera.
virtual bool isOrthogonal() const
Checks if a camera is orthogonal.
virtual void setInputReceiverEnabled(bool enabled)=0
Disables or enables the camera to get key or mouse inputs.
virtual bool isInputReceiverEnabled() const =0
Checks if the input receiver of the camera is currently enabled.
virtual f32 getNearValue() const =0
Gets the value of the near plane of the camera.