dali/internal/update/render-tasks/scene-graph-camera.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_CAMERA_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_CAMERA_H
   3
   4 /*
   5  * Copyright (c) 2018 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/math/rect.h>
  23 #include <dali/public-api/actors/camera-actor.h>
  24 #include <dali/internal/common/message.h>
  25 #include <dali/internal/event/common/event-thread-services.h>
  26 #include <dali/internal/update/common/double-buffered.h>
  27 #include <dali/internal/update/common/inherited-property.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 // value types used by messages
  36 template <> struct ParameterType< Dali::Camera::Type >
  37 : public BasicType< Dali::Camera::Type > {};
  38 template <> struct ParameterType< Dali::Camera::ProjectionMode >
  39 : public BasicType< Dali::Camera::ProjectionMode > {};
  40
  41 namespace SceneGraph
  42 {
  43
  44 class Node;
  45 class SceneController;
  46
  47 /**
  48  * Scene-graph camera object
  49  */
  50 class Camera
  51 {
  52 public:
  53   static const Dali::Camera::Type DEFAULT_TYPE;
  54   static const Dali::Camera::ProjectionMode DEFAULT_MODE;
  55   static const bool  DEFAULT_INVERT_Y_AXIS;
  56   static const float DEFAULT_FIELD_OF_VIEW;
  57   static const float DEFAULT_ASPECT_RATIO;
  58   static const float DEFAULT_LEFT_CLIPPING_PLANE;
  59   static const float DEFAULT_RIGHT_CLIPPING_PLANE;
  60   static const float DEFAULT_TOP_CLIPPING_PLANE;
  61   static const float DEFAULT_BOTTOM_CLIPPING_PLANE;
  62   static const float DEFAULT_NEAR_CLIPPING_PLANE;
  63   static const float DEFAULT_FAR_CLIPPING_PLANE;
  64   static const Vector2 DEFAULT_STEREO_BIAS;
  65   static const Vector3 DEFAULT_TARGET_POSITION;
  66
  67   /**
  68    * Plane equation container for a plane of the view frustum
  69    */
  70   struct Plane
  71   {
  72     Vector3 mNormal;
  73     float mDistance;
  74   };
  75
  76   /**
  77    * @brief Container for six planes in a view frustum
  78    */
  79   struct FrustumPlanes
  80   {
  81     Plane mPlanes[ 6 ];
  82     Vector3 mSign[ 6 ];
  83   };
  84
  85   /**
  86    * Construct a new Camera.
  87    * @return a new camera.
  88    */
  89   static Camera* New();
  90
  91   /**
  92    * Destructor
  93    */
  94   ~Camera();
  95
  96   /**
  97    * Set the node this scene graph camera belongs to.
  98    * @param[in] node The owning node.
  99    */
 100   void SetNode( const Node* node );
 101
 102   /**
 103    * @copydoc Dali::Internal::CameraActor::SetType
 104    */
 105   void SetType( Dali::Camera::Type type );
 106
 107   /**
 108    * @copydoc Dali::Internal::CameraActor::SetInvertYAxis
 109    */
 110   void SetInvertYAxis( bool invertYAxis );
 111
 112   /**
 113    * @copydoc Dali::Internal::CameraActor::SetProjectionMode
 114    */
 115   void SetProjectionMode( Dali::Camera::ProjectionMode projectionMode );
 116
 117   /**
 118    * @copydoc Dali::Internal::CameraActor::SetFieldOfView
 119    */
 120   void SetFieldOfView( float fieldOfView );
 121
 122   /**
 123    * @copydoc Dali::Internal::CameraActor::SetAspectRatio
 124    */
 125   void SetAspectRatio( float aspectRatio );
 126
 127    /**
 128    * @copydoc Dali::Internal::CameraActor::SetLeftClippingPlane
 129    */
 130   void SetLeftClippingPlane( float leftClippingPlane );
 131
 132   /**
 133    * @copydoc Dali::Internal::CameraActor::SetRightClippingPlane
 134    */
 135   void SetRightClippingPlane( float rightClippingPlane );
 136
 137   /**
 138    * @copydoc Dali::Internal::CameraActor::SetTopClippingPlane
 139    */
 140   void SetTopClippingPlane( float topClippingPlane );
 141
 142   /**
 143    * @copydoc Dali::Internal::CameraActor::SetBottomClippingPlane
 144    */
 145   void SetBottomClippingPlane( float bottomClippingPlane );
 146
 147   /**
 148    * @copydoc Dali::Internal::CameraActor::SetNearClippingPlane
 149    */
 150   void SetNearClippingPlane( float nearClippingPlane );
 151
 152   /**
 153    * @copydoc Dali::Internal::CameraActor::SetFarClippingPlane
 154    */
 155   void SetFarClippingPlane( float farClippingPlane );
 156
 157   /**
 158    * @copydoc Dali::Internal::CameraActor::RotateProjection
 159    */
 160   void RotateProjection( int rotationAngle );
 161
 162   /**
 163    * @copydoc Dali::Internal::CameraActor::SetTarget
 164    */
 165   void SetTargetPosition( const Vector3& targetPosition );
 166
 167   /**
 168    * Retrieve the view-matrix; this is double buffered for input handling.
 169    * @param[in] bufferIndex The buffer to read from.
 170    * @return The view-matrix.
 171    */
 172   const Matrix& GetViewMatrix( BufferIndex bufferIndex ) const;
 173
 174   /**
 175    * @brief Check to see if a sphere lies within the view frustum.
 176    *
 177    * @param bufferIndex The buffer to read from.
 178    * @param origin The world position center of the sphere to check.
 179    * @param radius The length of the sphere radius in world scale.
 180    *
 181    * @return false if the sphere lies outside of the frustum.
 182    */
 183   bool CheckSphereInFrustum( BufferIndex bufferIndex, const Vector3& origin, float radius );
 184
 185   /**
 186    * @brief Check to see if a bounding box lies within the view frustum.
 187    *
 188    * @param bufferIndex The buffer to read from.
 189    * @param origin the world position center of the cubeoid to check.
 190    * @param halfExtents The half length of the cubeoid in world co-ordinates in each axis.
 191    *
 192    * @return false if the cubeoid lies completely outside of the frustum, true otherwise
 193    */
 194   bool CheckAABBInFrustum( BufferIndex bufferIndex, const Vector3& origin, const Vector3& halfExtents );
 195
 196   /**
 197    * Retrieve the projection-matrix; this is double buffered for input handling.
 198    * @param[in] bufferIndex The buffer to read from.
 199    * @return The projection-matrix.
 200    */
 201   const Matrix& GetProjectionMatrix( BufferIndex bufferIndex ) const;
 202
 203   /**
 204    * Retrieve the inverted view-projection-matrix; this is double buffered for input handling.
 205    * @param[in] bufferIndex The buffer to read from.
 206    * @return The inverse view-projection-matrix.
 207    */
 208   const Matrix& GetInverseViewProjectionMatrix( BufferIndex bufferIndex ) const;
 209
 210   /**
 211    * Retrieve the final projection-matrix; this is double buffered for input handling.
 212    * @param[in] bufferIndex The buffer to read from.
 213    * @return The projection-matrix that should be used to render.
 214    */
 215   const Matrix& GetFinalProjectionMatrix( BufferIndex bufferIndex ) const;
 216
 217   /**
 218    * Retrieve the projection-matrix property querying interface.
 219    * @pre The camera is on-stage.
 220    * @return The projection-matrix property querying interface.
 221    */
 222   const PropertyInputImpl* GetProjectionMatrix() const;
 223
 224   /**
 225    * Retrieve the viewMatrix property querying interface.
 226    * @pre The camera is on-stage.
 227    * @return The viewMatrix property querying interface.
 228    */
 229   const PropertyInputImpl* GetViewMatrix() const;
 230
 231   /**
 232    * Updates view and projection matrices.
 233    * Called by the render task using the camera
 234    * @param[in] updateBufferIndex The buffer to read from.
 235    */
 236   void Update( BufferIndex updateBufferIndex );
 237
 238   /**
 239    * @return true if the view matrix of camera is updated this or the previous frame
 240    */
 241   bool ViewMatrixUpdated();
 242
 243 private:
 244
 245   /**
 246    * Constructor
 247    */
 248   Camera();
 249
 250   // Non copyable
 251   // Undefined
 252   Camera(const Camera&);
 253   // Undefined
 254   Camera& operator=(const Camera& rhs);
 255
 256   /**
 257    * Recalculates the view matrix.
 258    * @param[in] bufferIndex The current update buffer index.
 259    * @return count how many frames ago the matrix was changed.
 260    */
 261   uint32_t UpdateViewMatrix( BufferIndex updateBufferIndex );
 262
 263   /**
 264    * Recalculates the projection matrix.
 265    * @param[in] bufferIndex The current update buffer index.
 266    * @return count how many frames ago the matrix was changed.
 267    */
 268   uint32_t UpdateProjection( BufferIndex updateBufferIndex );
 269
 270 private:
 271
 272   /**
 273    * @brief Extracts the frustum planes.
 274    *
 275    * @param[in] bufferIndex The current update buffer index.
 276    * @param[in] normalize will normalize plane equation coefficients by default.
 277    */
 278   void UpdateFrustum( BufferIndex updateBufferIndex, bool normalize = true );
 279
 280   uint32_t                  mUpdateViewFlag;       ///< This is non-zero if the view matrix requires an update
 281   uint32_t                  mUpdateProjectionFlag; ///< This is non-zero if the projection matrix requires an update
 282   int                       mProjectionRotation;   ///< The rotaion angle of the projection
 283   const Node*                   mNode;                 ///< The node this scene graph camera belongs to
 284
 285 public:  // PROPERTIES
 286   Dali::Camera::Type            mType;                 // Non-animatable
 287   Dali::Camera::ProjectionMode  mProjectionMode;       // Non-animatable
 288   bool                          mInvertYAxis;          // Non-animatable
 289
 290   float                         mFieldOfView;
 291   float                         mAspectRatio;
 292   float                         mLeftClippingPlane;
 293   float                         mRightClippingPlane;
 294   float                         mTopClippingPlane;
 295   float                         mBottomClippingPlane;
 296   float                         mNearClippingPlane;
 297   float                         mFarClippingPlane;
 298   Vector3                       mTargetPosition;
 299
 300   InheritedMatrix mViewMatrix;           ///< The viewMatrix; this is double buffered for input handling.
 301   InheritedMatrix mProjectionMatrix;     ///< The projectionMatrix; this is double buffered for input handling.
 302
 303   DoubleBuffered< FrustumPlanes > mFrustum;               ///< Clipping frustum; double buffered for input handling
 304   DoubleBuffered< Matrix >        mInverseViewProjection; ///< Inverted viewprojection; double buffered for input handling
 305   DoubleBuffered< Matrix >        mFinalProjection;       ///< Final projection matrix; double buffered for input handling
 306
 307 };
 308
 309 // Messages for Camera
 310
 311 inline void SetTypeMessage( EventThreadServices& eventThreadServices, const Camera& camera, Dali::Camera::Type parameter )
 312 {
 313   typedef MessageValue1< Camera, Dali::Camera::Type > LocalType;
 314
 315   // Reserve some memory inside the message queue
 316   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 317
 318   // Construct message in the message queue memory; note that delete should not be called on the return value
 319   new (slot) LocalType( &camera, &Camera::SetType, parameter );
 320 }
 321
 322 inline void SetProjectionModeMessage( EventThreadServices& eventThreadServices, const Camera& camera, Dali::Camera::ProjectionMode parameter )
 323 {
 324   typedef MessageValue1< Camera, Dali::Camera::ProjectionMode > LocalProjectionMode;
 325
 326   // Reserve some memory inside the message queue
 327   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalProjectionMode ) );
 328
 329   // Construct message in the message queue memory; note that delete should not be called on the return value
 330   new (slot) LocalProjectionMode( &camera, &Camera::SetProjectionMode, parameter );
 331 }
 332
 333 inline void SetFieldOfViewMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 334 {
 335   typedef MessageValue1< Camera, float > LocalType;
 336
 337   // Reserve some memory inside the message queue
 338   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 339
 340   // Construct message in the message queue memory; note that delete should not be called on the return value
 341   new (slot) LocalType( &camera, &Camera::SetFieldOfView, parameter );
 342 }
 343
 344 inline void SetAspectRatioMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 345 {
 346   typedef MessageValue1< Camera, float > LocalType;
 347
 348   // Reserve some memory inside the message queue
 349   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 350
 351   // Construct message in the message queue memory; note that delete should not be called on the return value
 352   new (slot) LocalType( &camera, &Camera::SetAspectRatio, parameter );
 353 }
 354
 355 inline void SetLeftClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 356 {
 357   typedef MessageValue1< Camera, float > LocalType;
 358
 359   // Reserve some memory inside the message queue
 360   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 361
 362   // Construct message in the message queue memory; note that delete should not be called on the return value
 363   new (slot) LocalType( &camera, &Camera::SetLeftClippingPlane, parameter );
 364 }
 365
 366 inline void SetRightClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 367 {
 368   typedef MessageValue1< Camera, float > LocalType;
 369
 370   // Reserve some memory inside the message queue
 371   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 372
 373   // Construct message in the message queue memory; note that delete should not be called on the return value
 374   new (slot) LocalType( &camera, &Camera::SetRightClippingPlane, parameter );
 375 }
 376
 377 inline void SetTopClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 378 {
 379   typedef MessageValue1< Camera, float > LocalType;
 380
 381   // Reserve some memory inside the message queue
 382   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 383
 384   // Construct message in the message queue memory; note that delete should not be called on the return value
 385   new (slot) LocalType( &camera, &Camera::SetTopClippingPlane, parameter );
 386 }
 387
 388 inline void SetBottomClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 389 {
 390   typedef MessageValue1< Camera, float > LocalType;
 391
 392   // Reserve some memory inside the message queue
 393   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 394
 395   // Construct message in the message queue memory; note that delete should not be called on the return value
 396   new (slot) LocalType( &camera, &Camera::SetBottomClippingPlane, parameter );
 397 }
 398
 399 inline void SetNearClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 400 {
 401   typedef MessageValue1< Camera, float > LocalType;
 402
 403   // Reserve some memory inside the message queue
 404   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 405
 406   // Construct message in the message queue memory; note that delete should not be called on the return value
 407   new (slot) LocalType( &camera, &Camera::SetNearClippingPlane, parameter );
 408 }
 409
 410 inline void SetFarClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 411 {
 412   typedef MessageValue1< Camera, float > LocalType;
 413
 414   // Reserve some memory inside the message queue
 415   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 416
 417   // Construct message in the message queue memory; note that delete should not be called on the return value
 418   new (slot) LocalType( &camera, &Camera::SetFarClippingPlane, parameter );
 419 }
 420
 421 inline void SetTargetPositionMessage( EventThreadServices& eventThreadServices, const Camera& camera, const Vector3& parameter )
 422 {
 423   typedef MessageValue1< Camera, Vector3 > LocalType;
 424
 425   // Reserve some memory inside the message queue
 426   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 427
 428   // Construct message in the message queue memory; note that delete should not be called on the return value
 429   new (slot) LocalType( &camera, &Camera::SetTargetPosition, parameter );
 430 }
 431
 432 inline void SetInvertYAxisMessage( EventThreadServices& eventThreadServices, const Camera& camera, bool parameter )
 433 {
 434   typedef MessageValue1< Camera, bool > LocalType;
 435
 436   // Reserve some memory inside the message queue
 437   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 438
 439   // Construct message in the message queue memory; note that delete should not be called on the return value
 440   new (slot) LocalType( &camera, &Camera::SetInvertYAxis, parameter );
 441 }
 442
 443 inline void RotateProjectionMessage( EventThreadServices& eventThreadServices, const Camera& camera, int parameter )
 444 {
 445   typedef MessageValue1< Camera, int > LocalType;
 446
 447   // Reserve some memory inside the message queue
 448   unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 449
 450   // Construct message in the message queue memory; note that delete should not be called on the return value
 451   new (slot) LocalType( &camera, &Camera::RotateProjection, parameter );
 452 }
 453
 454 } // namespace SceneGraph
 455
 456 } // namespace Internal
 457
 458 } // namespace Dali
 459
 460 #endif // DALI_INTERNAL_SCENE_GRAPH_CAMERA_H