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 Controls a camera.
66 * Allows the developer to use actor semantics to control a camera.
68 * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default
69 * the camera actor will be FREE_LOOK.
71 * A FREE_LOOK camera uses actor's orientation to control where the camera is looking.
72 * If no additional rotations are specified, the camera looks in the negative Z direction.
74 * For LOOK_AT_TARGET the actor's orientation is ignored, instead the camera looks at TARGET_POSITION
75 * in world coordinates.
79 class DALI_IMPORT_API CameraActor : public Actor
84 * @brief An enumeration of properties belonging to the CameraActor class.
86 * Properties additional to Actor.
93 TYPE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "type", type std::string @SINCE_1_0.0
94 PROJECTION_MODE, ///< name "projectionMode", type std::string @SINCE_1_0.0
95 FIELD_OF_VIEW, ///< name "fieldOfView", type float @SINCE_1_0.0
96 ASPECT_RATIO, ///< name "aspectRatio", type float @SINCE_1_0.0
97 NEAR_PLANE_DISTANCE, ///< name "nearPlaneDistance", type float @SINCE_1_0.0
98 FAR_PLANE_DISTANCE, ///< name "farPlaneDistance", type float @SINCE_1_0.0
99 LEFT_PLANE_DISTANCE, ///< name "leftPlaneDistance", type float @SINCE_1_0.0
100 RIGHT_PLANE_DISTANCE, ///< name "rightPlaneDistance", type float @SINCE_1_0.0
101 TOP_PLANE_DISTANCE, ///< name "topPlaneDistance", type float @SINCE_1_0.0
102 BOTTOM_PLANE_DISTANCE, ///< name "bottomPlaneDistance", type float @SINCE_1_0.0
103 TARGET_POSITION, ///< name "targetPosition", type Vector3 @SINCE_1_0.0
104 PROJECTION_MATRIX, ///< name "projectionMatrix", type Matrix @SINCE_1_0.0
105 VIEW_MATRIX, ///< name "viewMatrix", type Matrix @SINCE_1_0.0
106 INVERT_Y_AXIS, ///< name "invertYAxis", type bool @SINCE_1_0.0
111 * @brief Create an uninitialized CameraActor handle.
113 * Initialise it using CameraActor::New().
114 * Calling member functions with an uninitialized CameraActor handle is not allowed.
120 * @brief Create a CameraActor object.
122 * Sets the default camera perspective projection for the stage's size. @see SetPerspectiveProjection().
124 * @return The newly created camera actor.
126 static CameraActor New();
129 * @brief Create a CameraActor object.
131 * Sets the default camera perspective projection for the given canvas size. @see SetPerspectiveProjection().
134 * @param[in] size The canvas size.
135 * @return The newly created camera actor.
137 static CameraActor New( const Size& size );
140 * @brief Downcast a handle to CameraActor handle.
142 * If handle points to a CameraActor the downcast produces valid
143 * handle. If not the returned handle is left uninitialized.
145 * @param[in] handle to An object
146 * @return Handle to a CameraActor or an uninitialized handle
148 static CameraActor DownCast( BaseHandle handle );
153 * This is non-virtual since derived Handle types must not contain data or virtual methods.
159 * @brief Copy constructor
162 * @param [in] copy The actor to copy.
164 CameraActor(const CameraActor& copy);
167 * @brief Assignment operator
170 * @param [in] rhs The actor to copy.
171 * @return A reference to this
173 CameraActor& operator=(const CameraActor& rhs);
176 * @brief Set the camera type.
177 * The default type is Dali::Camera::FREE_LOOK
179 * @param[in] type The camera type
181 void SetType( Dali::Camera::Type type );
184 * @brief Get the type of the camera.
187 * @return The type of camera
189 Dali::Camera::Type GetType() const;
192 * @brief Set the projection mode.
195 * @param[in] mode One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
197 void SetProjectionMode( Dali::Camera::ProjectionMode mode );
200 * @brief Get the projection mode.
203 * @return One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
205 Dali::Camera::ProjectionMode GetProjectionMode() const;
208 * @brief Set the field of view.
211 * @param[in] fieldOfView The field of view in radians
213 void SetFieldOfView( float fieldOfView );
216 * @brief Get the field of view in Radians.
218 * The default field of view is 45 degrees.
220 * @return The field of view in radians
222 float GetFieldOfView( );
225 * @brief Set the aspect ratio.
228 * @param[in] aspectRatio The aspect ratio
230 void SetAspectRatio( float aspectRatio );
233 * @brief Get the aspect ratio of the camera.
235 * The default aspect ratio is 4.0f/3.0f.
237 * @return The aspect ratio
239 float GetAspectRatio( );
242 * @brief Sets the near clipping plane distance.
245 * @param[in] nearClippingPlane Distance of the near clipping plane
247 void SetNearClippingPlane( float nearClippingPlane );
250 * @brief Get the near clipping plane distance.
252 * The default near clipping plane is 800.0f, to match the default screen height.
253 * Reduce this value to see objects closer to the camera.
255 * @return The near clipping plane value
257 float GetNearClippingPlane( );
260 * @brief Sets the far clipping plane distance.
263 * @param[in] farClippingPlane Distance of the far clipping plane
265 void SetFarClippingPlane( float farClippingPlane );
268 * @brief Get the far clipping plane distance.
270 * The default value is the default near clipping plane + (0xFFFF>>4).
272 * @return The far clipping plane value
274 float GetFarClippingPlane( );
277 * @brief Set the target position of the camera.
280 * @param[in] targetPosition The position of the target to look at
281 * @pre Camera type is LOOK_AT_TARGET.
283 void SetTargetPosition( const Vector3& targetPosition );
286 * @brief Get Camera Target position.
288 * The default target position is Vector3::ZERO.
290 * @return The target position of the camera
291 * @pre Camera type is LOOK_AT_TARGET.
293 Vector3 GetTargetPosition() const;
296 * @brief Request for an inversion on the Y axis on the projection calculation.
298 * The default value is not inverted.
300 * @param[in] invertYAxis True if the Y axis should be inverted
302 void SetInvertYAxis(bool invertYAxis);
305 * @brief Get whether the Y axis is inverted.
308 * @return True if the Y axis is inverted, false otherwise
310 bool GetInvertYAxis();
313 * @brief Sets the default camera perspective projection for the given canvas size.
315 * Sets the near and far clipping planes, the field of view, the aspect ratio
316 * and the Z position of the actor based on the canvas size so that 1 unit in
317 * XY (z=0) plane is 1 pixel on screen.
319 * If the canvas size is ZERO, it sets the default camera perspective
320 * projection for the stage's size.
323 * @param[in] size The canvas size.
324 * @pre If size is non ZERO, \e width and \e height must be greater than zero.
327 void SetPerspectiveProjection( const Size& size );
330 * @brief Sets the camera projection to use orthographic projection.
332 * The XY plane is centered on the camera axis. The units in the X/Y
333 * plane directly equate to pixels on an equivalently sized
336 * The Z position of the actor, and the near and far clip planes of the
337 * bounding box match those that would be created by using
338 * SetPerspectiveProjection with the same size.
341 * @param[in] size Size of XY plane (normal to camera axis)
343 void SetOrthographicProjection( const Size& size );
346 * @brief Sets the camera projection to use orthographic projection with the given clip planes.
348 * This does not change the Z value of the camera actor.
351 * @param[in] left Distance to left clip plane (normal to camera axis)
352 * @param[in] right Distance to right clip plane (normal to camera axis)
353 * @param[in] top Distance to top clip plane (normal to camera axis)
354 * @param[in] bottom Distance to bottom clip plane (normal to camera axis)
355 * @param[in] near Distance to the near clip plane (along camera axis)
356 * @param[in] far Distance to the far clip plane (along camera axis)
358 void SetOrthographicProjection( float left, float right, float top, float bottom, float near, float far );
360 public: // Not intended for use by Application developers
362 * @brief This constructor is used by CameraActor::New() methods.
365 * @param [in] actor A pointer to a newly allocated Dali resource
367 explicit DALI_INTERNAL CameraActor(Internal::CameraActor* actor);
375 #endif // __DALI_CAMERA_ACTOR_H__