dali/public-api/actors/camera-actor.h

   1 #ifndef DALI_CAMERA_ACTOR_H
   2 #define DALI_CAMERA_ACTOR_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 #include <dali/public-api/actors/actor.h>
  22
  23 namespace Dali
  24 {
  25 /**
  26  * @addtogroup dali_core_actors
  27  * @{
  28  */
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class CameraActor;
  33 }
  34
  35 /**
  36  * @brief Enumeration for camera.
  37  * @SINCE_1_0.0
  38  */
  39 namespace Camera
  40 {
  41 /**
  42  * @brief Enumeration for type determination of how camera operates.
  43  * @SINCE_1_0.0
  44  */
  45 enum Type
  46 {
  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
  49 };
  50
  51 /**
  52  * @brief Enumeration for projection modes.
  53  * @SINCE_1_0.0
  54  */
  55 enum ProjectionMode
  56 {
  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
  59 };
  60
  61 } // namespace Camera
  62
  63 /**
  64  * @brief CameraActor controls a camera.
  65  *
  66  * Allows the developer to use actor semantics to control a camera.
  67  *
  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:
  70  *
  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.
  74  *
  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.
  77  *
  78  * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default,
  79  * the camera actor will be FREE_LOOK.
  80  *
  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.
  83  *
  84  * - For LOOK_AT_TARGET, the actor's orientation is ignored, instead the camera looks at TARGET_POSITION
  85  *   in world coordinates.
  86  *
  87  * @SINCE_1_0.0
  88  */
  89 class DALI_CORE_API CameraActor : public Actor
  90 {
  91 public:
  92
  93   /**
  94    * @brief Enumeration for the instance of properties belonging to the CameraActor class.
  95    *
  96    * Properties additional to Actor.
  97    * @SINCE_1_0.0
  98    */
  99   struct Property
 100   {
 101     /**
 102      * @brief Enumeration for the instance of properties belonging to the CameraActor class.
 103      *
 104      * Properties additional to Actor.
 105      * @SINCE_1_0.0
 106      */
 107     enum
 108     {
 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
 123     };
 124   };
 125
 126   /**
 127    * @brief Creates an uninitialized CameraActor handle.
 128    *
 129    * Initialize it using CameraActor::New().
 130    * Calling member functions with an uninitialized CameraActor handle is not allowed.
 131    * @SINCE_1_0.0
 132    */
 133   CameraActor();
 134
 135   /**
 136    * @brief Creates a CameraActor object.
 137    *
 138    * @note No default camera perspective projection is set by this method. @see SetPerspectiveProjection().
 139    *
 140    * @SINCE_1_0.0
 141    * @return The newly created camera actor
 142    */
 143   static CameraActor New();
 144
 145   /**
 146    * @brief Creates a CameraActor object.
 147    *
 148    * Sets the default camera perspective projection for the given canvas size. @see SetPerspectiveProjection().
 149    *
 150    * @SINCE_1_0.0
 151    * @param[in] size The canvas size
 152    * @return The newly created camera actor
 153    */
 154   static CameraActor New( const Size& size );
 155
 156   /**
 157    * @brief Downcasts a handle to CameraActor handle.
 158    *
 159    * If handle points to a CameraActor, the downcast produces valid handle.
 160    * If not, the returned handle is left uninitialized.
 161    * @SINCE_1_0.0
 162    * @param[in] handle to An object
 163    * @return Handle to a CameraActor or an uninitialized handle
 164    */
 165   static CameraActor DownCast( BaseHandle handle );
 166
 167   /**
 168    * @brief Destructor.
 169    *
 170    * This is non-virtual, since derived Handle types must not contain data or virtual methods.
 171    * @SINCE_1_0.0
 172    */
 173   ~CameraActor();
 174
 175   /**
 176    * @brief Copy constructor.
 177    *
 178    * @SINCE_1_0.0
 179    * @param[in] copy The actor to copy
 180    */
 181   CameraActor(const CameraActor& copy);
 182
 183   /**
 184    * @brief Assignment operator.
 185    *
 186    * @SINCE_1_0.0
 187    * @param[in] rhs The actor to copy
 188    * @return A reference to this
 189    */
 190   CameraActor& operator=(const CameraActor& rhs);
 191
 192   /**
 193    * @brief Sets the camera type.
 194    * The default type is Dali::Camera::FREE_LOOK
 195    * @SINCE_1_0.0
 196    * @param[in] type The camera type
 197    */
 198   void SetType( Dali::Camera::Type type );
 199
 200   /**
 201    * @brief Gets the type of the camera.
 202    *
 203    * @SINCE_1_0.0
 204    * @return The type of camera
 205    */
 206   Dali::Camera::Type GetType() const;
 207
 208   /**
 209    * @brief Sets the projection mode.
 210    *
 211    * @SINCE_1_0.0
 212    * @param[in] mode One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
 213    */
 214   void SetProjectionMode( Dali::Camera::ProjectionMode mode );
 215
 216   /**
 217    * @brief Gets the projection mode.
 218    *
 219    * @SINCE_1_0.0
 220    * @return One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
 221    */
 222   Dali::Camera::ProjectionMode GetProjectionMode() const;
 223
 224   /**
 225    * @brief Sets the field of view.
 226    *
 227    * @SINCE_1_0.0
 228    * @param[in] fieldOfView The field of view in radians
 229    */
 230   void SetFieldOfView( float fieldOfView );
 231
 232   /**
 233    * @brief Gets the field of view in Radians.
 234    *
 235    * The default field of view is 45 degrees.
 236    * @SINCE_1_0.0
 237    * @return The field of view in radians
 238    */
 239   float GetFieldOfView( );
 240
 241   /**
 242    * @brief Sets the aspect ratio.
 243    *
 244    * @SINCE_1_0.0
 245    * @param[in] aspectRatio The aspect ratio
 246    */
 247   void SetAspectRatio( float aspectRatio );
 248
 249   /**
 250    * @brief Gets the aspect ratio of the camera.
 251    *
 252    * The default aspect ratio is 4.0f/3.0f.
 253    * @SINCE_1_0.0
 254    * @return The aspect ratio
 255    */
 256   float GetAspectRatio( );
 257
 258   /**
 259    * @brief Sets the near clipping plane distance.
 260    *
 261    * @SINCE_1_0.0
 262    * @param[in] nearClippingPlane Distance of the near clipping plane
 263    */
 264   void SetNearClippingPlane( float nearClippingPlane );
 265
 266   /**
 267    * @brief Gets the near clipping plane distance.
 268    *
 269    * The default near clipping plane is 800.0f, to match the default screen height.
 270    * Reduce this value to see objects closer to the camera.
 271    * @SINCE_1_0.0
 272    * @return The near clipping plane value
 273    */
 274   float GetNearClippingPlane( );
 275
 276   /**
 277    * @brief Sets the far clipping plane distance.
 278    *
 279    * @SINCE_1_0.0
 280    * @param[in] farClippingPlane Distance of the far clipping plane
 281    */
 282   void SetFarClippingPlane( float farClippingPlane );
 283
 284   /**
 285    * @brief Gets the far clipping plane distance.
 286    *
 287    * The default value is the default near clipping plane + (0xFFFF>>4).
 288    * @SINCE_1_0.0
 289    * @return The far clipping plane value
 290    */
 291   float GetFarClippingPlane( );
 292
 293   /**
 294    * @brief Sets the target position of the camera.
 295    *
 296    * @SINCE_1_0.0
 297    * @param[in] targetPosition The position of the target to look at
 298    * @pre Camera type is LOOK_AT_TARGET.
 299    */
 300   void SetTargetPosition( const Vector3& targetPosition );
 301
 302   /**
 303    * @brief Gets the Camera Target position.
 304    *
 305    * The default target position is Vector3::ZERO.
 306    * @SINCE_1_0.0
 307    * @return The target position of the camera
 308    * @pre Camera type is LOOK_AT_TARGET.
 309    */
 310   Vector3 GetTargetPosition() const;
 311
 312   /**
 313    * @brief Requests for an inversion on the Y axis on the projection calculation.
 314    *
 315    * The default value is not inverted.
 316    * @SINCE_1_0.0
 317    * @param[in] invertYAxis True if the Y axis should be inverted
 318    */
 319   void SetInvertYAxis(bool invertYAxis);
 320
 321   /**
 322    * @brief Gets whether the Y axis is inverted.
 323    *
 324    * @SINCE_1_0.0
 325    * @return @c True if the Y axis is inverted, @c false otherwise
 326    */
 327   bool GetInvertYAxis();
 328
 329   /**
 330    * @brief Sets the default camera perspective projection for the given canvas size.
 331    *
 332    * Sets the near and far clipping planes, the field of view, the aspect ratio,
 333    * and the Z position of the actor based on the canvas size so that 1 unit in
 334    * XY (z=0) plane is 1 pixel on screen.
 335    *
 336    * @SINCE_1_0.0
 337    * @param[in] size The canvas size
 338    * @pre The canvas size must be greater than zero.
 339    *
 340    */
 341   void SetPerspectiveProjection( const Size& size );
 342
 343   /**
 344    * @brief Sets the camera projection to use orthographic projection.
 345    *
 346    * The XY plane is centered on the camera axis. The units in the X/Y
 347    * plane directly equate to pixels on an equivalently sized
 348    * framebuffer.
 349    *
 350    * The Z position of the actor, and the near and far clip planes of the
 351    * bounding box match those that would be created by using
 352    * SetPerspectiveProjection with the same size.
 353    *
 354    * @SINCE_1_0.0
 355    * @param[in] size Size of XY plane (normal to camera axis)
 356    */
 357   void SetOrthographicProjection( const Size& size );
 358
 359   /**
 360    * @brief Sets the camera projection to use orthographic projection with the given clip planes.
 361    *
 362    * This does not change the Z value of the camera actor.
 363    *
 364    * @SINCE_1_0.0
 365    * @param[in] left Distance to left clip plane (normal to camera axis)
 366    * @param[in] right Distance to right clip plane (normal to camera axis)
 367    * @param[in] top Distance to top clip plane (normal to camera axis)
 368    * @param[in] bottom Distance to bottom clip plane (normal to camera axis)
 369    * @param[in] near Distance to the near clip plane (along camera axis)
 370    * @param[in] far Distance to the far clip plane (along camera axis)
 371    */
 372   void SetOrthographicProjection( float left, float right, float top, float bottom, float near, float far );
 373
 374 public: // Not intended for use by Application developers
 375   /// @cond internal
 376   /**
 377    * @brief This constructor is used by CameraActor::New() methods.
 378    *
 379    * @SINCE_1_0.0
 380    * @param[in] actor A pointer to a newly allocated Dali resource
 381    */
 382   explicit DALI_INTERNAL CameraActor(Internal::CameraActor* actor);
 383   /// @endcond
 384 };
 385
 386 /**
 387  * @}
 388  */
 389 } // namespace Dali
 390
 391 #endif // DALI_CAMERA_ACTOR_H