1 #ifndef __DALI_CAMERA_ACTOR_H__
2 #define __DALI_CAMERA_ACTOR_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/public-api/actors/actor.h>
26 * @addtogroup dali_core_actors
30 namespace Internal DALI_INTERNAL
36 * @brief Camera enumerations.
42 * @brief Type determines how camera operates.
47 FREE_LOOK, ///< Camera orientation is taken from CameraActor @SINCE_1_0.0
48 LOOK_AT_TARGET, ///< Camera is oriented to always look at a target @SINCE_1_0.0
52 * @brief Projection modes.
57 PERSPECTIVE_PROJECTION, ///< Distance causes foreshortening; objects further from the camera appear smaller @SINCE_1_0.0
58 ORTHOGRAPHIC_PROJECTION, ///< Relative distance from the camera does not affect the size of objects @SINCE_1_0.0
64 * @brief CameraActor controls a camera.
66 * Allows the developer to use actor semantics to control a camera.
68 * DALi has a concept of a camera to display its virtual 3D world to a 2D screen.
69 * There are 2 ways of using the camera in DALi:
71 * - For 2D applications, you do not need to care about the camera at all. The default camera is already best suited for 2D applications
72 * (configured to have the origin of the coordinate system at the top-left corner of the screen, and unit 1 as 1 pixel of the screen).
73 * This is a typical way.
75 * - For 3D applications, you can change the view by manipulating the camera. You can translate or rotate the camera in this case.
76 * Note that the top-left corner of the screen and unit 1 no longer are (0,0,0) and 1 pixel after manipulating the camera.
78 * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default
79 * the camera actor will be FREE_LOOK.
81 * - A FREE_LOOK camera uses actor's orientation to control where the camera is looking.
82 * If no additional rotations are specified, the camera looks in the negative Z direction.
84 * - For LOOK_AT_TARGET the actor's orientation is ignored, instead the camera looks at TARGET_POSITION
85 * in world coordinates.
89 class DALI_IMPORT_API CameraActor : public Actor
94 * @brief An enumeration of properties belonging to the CameraActor class.
96 * Properties additional to Actor.
102 * @brief An enumeration of properties belonging to the CameraActor class.
104 * Properties additional to Actor.
109 TYPE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "type", type std::string @SINCE_1_0.0
110 PROJECTION_MODE, ///< name "projectionMode", type std::string @SINCE_1_0.0
111 FIELD_OF_VIEW, ///< name "fieldOfView", type float @SINCE_1_0.0
112 ASPECT_RATIO, ///< name "aspectRatio", type float @SINCE_1_0.0
113 NEAR_PLANE_DISTANCE, ///< name "nearPlaneDistance", type float @SINCE_1_0.0
114 FAR_PLANE_DISTANCE, ///< name "farPlaneDistance", type float @SINCE_1_0.0
115 LEFT_PLANE_DISTANCE, ///< name "leftPlaneDistance", type float @SINCE_1_0.0
116 RIGHT_PLANE_DISTANCE, ///< name "rightPlaneDistance", type float @SINCE_1_0.0
117 TOP_PLANE_DISTANCE, ///< name "topPlaneDistance", type float @SINCE_1_0.0
118 BOTTOM_PLANE_DISTANCE, ///< name "bottomPlaneDistance", type float @SINCE_1_0.0
119 TARGET_POSITION, ///< name "targetPosition", type Vector3 @SINCE_1_0.0
120 PROJECTION_MATRIX, ///< name "projectionMatrix", type Matrix @SINCE_1_0.0
121 VIEW_MATRIX, ///< name "viewMatrix", type Matrix @SINCE_1_0.0
122 INVERT_Y_AXIS, ///< name "invertYAxis", type bool @SINCE_1_0.0
127 * @brief Create an uninitialized CameraActor handle.
129 * Initialise it using CameraActor::New().
130 * Calling member functions with an uninitialized CameraActor handle is not allowed.
136 * @brief Create a CameraActor object.
138 * Sets the default camera perspective projection for the stage's size. @see SetPerspectiveProjection().
140 * @return The newly created camera actor.
142 static CameraActor New();
145 * @brief Create a CameraActor object.
147 * Sets the default camera perspective projection for the given canvas size. @see SetPerspectiveProjection().
150 * @param[in] size The canvas size.
151 * @return The newly created camera actor.
153 static CameraActor New( const Size& size );
156 * @brief Downcast a handle to CameraActor handle.
158 * If handle points to a CameraActor the downcast produces valid
159 * handle. If not the returned handle is left uninitialized.
161 * @param[in] handle to An object
162 * @return Handle to a CameraActor or an uninitialized handle
164 static CameraActor DownCast( BaseHandle handle );
169 * This is non-virtual since derived Handle types must not contain data or virtual methods.
175 * @brief Copy constructor
178 * @param [in] copy The actor to copy.
180 CameraActor(const CameraActor& copy);
183 * @brief Assignment operator
186 * @param [in] rhs The actor to copy.
187 * @return A reference to this
189 CameraActor& operator=(const CameraActor& rhs);
192 * @brief Set the camera type.
193 * The default type is Dali::Camera::FREE_LOOK
195 * @param[in] type The camera type
197 void SetType( Dali::Camera::Type type );
200 * @brief Get the type of the camera.
203 * @return The type of camera
205 Dali::Camera::Type GetType() const;
208 * @brief Set the projection mode.
211 * @param[in] mode One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
213 void SetProjectionMode( Dali::Camera::ProjectionMode mode );
216 * @brief Get the projection mode.
219 * @return One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
221 Dali::Camera::ProjectionMode GetProjectionMode() const;
224 * @brief Set the field of view.
227 * @param[in] fieldOfView The field of view in radians
229 void SetFieldOfView( float fieldOfView );
232 * @brief Get the field of view in Radians.
234 * The default field of view is 45 degrees.
236 * @return The field of view in radians
238 float GetFieldOfView( );
241 * @brief Set the aspect ratio.
244 * @param[in] aspectRatio The aspect ratio
246 void SetAspectRatio( float aspectRatio );
249 * @brief Get the aspect ratio of the camera.
251 * The default aspect ratio is 4.0f/3.0f.
253 * @return The aspect ratio
255 float GetAspectRatio( );
258 * @brief Sets the near clipping plane distance.
261 * @param[in] nearClippingPlane Distance of the near clipping plane
263 void SetNearClippingPlane( float nearClippingPlane );
266 * @brief Get the near clipping plane distance.
268 * The default near clipping plane is 800.0f, to match the default screen height.
269 * Reduce this value to see objects closer to the camera.
271 * @return The near clipping plane value
273 float GetNearClippingPlane( );
276 * @brief Sets the far clipping plane distance.
279 * @param[in] farClippingPlane Distance of the far clipping plane
281 void SetFarClippingPlane( float farClippingPlane );
284 * @brief Get the far clipping plane distance.
286 * The default value is the default near clipping plane + (0xFFFF>>4).
288 * @return The far clipping plane value
290 float GetFarClippingPlane( );
293 * @brief Set the target position of the camera.
296 * @param[in] targetPosition The position of the target to look at
297 * @pre Camera type is LOOK_AT_TARGET.
299 void SetTargetPosition( const Vector3& targetPosition );
302 * @brief Get Camera Target position.
304 * The default target position is Vector3::ZERO.
306 * @return The target position of the camera
307 * @pre Camera type is LOOK_AT_TARGET.
309 Vector3 GetTargetPosition() const;
312 * @brief Request for an inversion on the Y axis on the projection calculation.
314 * The default value is not inverted.
316 * @param[in] invertYAxis True if the Y axis should be inverted
318 void SetInvertYAxis(bool invertYAxis);
321 * @brief Get whether the Y axis is inverted.
324 * @return True if the Y axis is inverted, false otherwise
326 bool GetInvertYAxis();
329 * @brief Sets the default camera perspective projection for the given canvas size.
331 * Sets the near and far clipping planes, the field of view, the aspect ratio
332 * and the Z position of the actor based on the canvas size so that 1 unit in
333 * XY (z=0) plane is 1 pixel on screen.
335 * If the canvas size is ZERO, it sets the default camera perspective
336 * projection for the stage's size.
339 * @param[in] size The canvas size.
340 * @pre If size is non ZERO, \e width and \e height must be greater than zero.
343 void SetPerspectiveProjection( const Size& size );
346 * @brief Sets the camera projection to use orthographic projection.
348 * The XY plane is centered on the camera axis. The units in the X/Y
349 * plane directly equate to pixels on an equivalently sized
352 * The Z position of the actor, and the near and far clip planes of the
353 * bounding box match those that would be created by using
354 * SetPerspectiveProjection with the same size.
357 * @param[in] size Size of XY plane (normal to camera axis)
359 void SetOrthographicProjection( const Size& size );
362 * @brief Sets the camera projection to use orthographic projection with the given clip planes.
364 * This does not change the Z value of the camera actor.
367 * @param[in] left Distance to left clip plane (normal to camera axis)
368 * @param[in] right Distance to right clip plane (normal to camera axis)
369 * @param[in] top Distance to top clip plane (normal to camera axis)
370 * @param[in] bottom Distance to bottom clip plane (normal to camera axis)
371 * @param[in] near Distance to the near clip plane (along camera axis)
372 * @param[in] far Distance to the far clip plane (along camera axis)
374 void SetOrthographicProjection( float left, float right, float top, float bottom, float near, float far );
376 public: // Not intended for use by Application developers
379 * @brief This constructor is used by CameraActor::New() methods.
382 * @param [in] actor A pointer to a newly allocated Dali resource
384 explicit DALI_INTERNAL CameraActor(Internal::CameraActor* actor);
393 #endif // __DALI_CAMERA_ACTOR_H__