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::SetTarget
 159    */
 160   void SetTargetPosition( const Vector3& targetPosition );
 161
 162   /**
 163    * Sets the reflection plane
 164    * @param[in] plane reflection plane
 165    */
 166   void SetReflectByPlane( const Vector4& plane );
 167
 168   /**
 169    * Tests whether reflection is used
 170    * @return True if used, False otherwise
 171    */
 172   bool GetReflectionUsed() const
 173   {
 174     return mUseReflection;
 175   }
 176
 177   /**
 178    * Retrieve the view-matrix; this is double buffered for input handling.
 179    * @param[in] bufferIndex The buffer to read from.
 180    * @return The view-matrix.
 181    */
 182   const Matrix& GetViewMatrix( BufferIndex bufferIndex ) const;
 183
 184   /**
 185    * @brief Check to see if a sphere lies within the view frustum.
 186    *
 187    * @param bufferIndex The buffer to read from.
 188    * @param origin The world position center of the sphere to check.
 189    * @param radius The length of the sphere radius in world scale.
 190    *
 191    * @return false if the sphere lies outside of the frustum.
 192    */
 193   bool CheckSphereInFrustum( BufferIndex bufferIndex, const Vector3& origin, float radius );
 194
 195   /**
 196    * @brief Check to see if a bounding box lies within the view frustum.
 197    *
 198    * @param bufferIndex The buffer to read from.
 199    * @param origin the world position center of the cubeoid to check.
 200    * @param halfExtents The half length of the cubeoid in world co-ordinates in each axis.
 201    *
 202    * @return false if the cubeoid lies completely outside of the frustum, true otherwise
 203    */
 204   bool CheckAABBInFrustum( BufferIndex bufferIndex, const Vector3& origin, const Vector3& halfExtents );
 205
 206   /**
 207    * Retrieve the projection-matrix; this is double buffered for input handling.
 208    * @param[in] bufferIndex The buffer to read from.
 209    * @return The projection-matrix.
 210    */
 211   const Matrix& GetProjectionMatrix( BufferIndex bufferIndex ) const;
 212
 213   /**
 214    * Retrieve the inverted view-projection-matrix; this is double buffered for input handling.
 215    * @param[in] bufferIndex The buffer to read from.
 216    * @return The inverse view-projection-matrix.
 217    */
 218   const Matrix& GetInverseViewProjectionMatrix( BufferIndex bufferIndex ) const;
 219
 220   /**
 221    * Retrieve the projection-matrix property querying interface.
 222    * @pre The camera is on-stage.
 223    * @return The projection-matrix property querying interface.
 224    */
 225   const PropertyInputImpl* GetProjectionMatrix() const;
 226
 227   /**
 228    * Retrieve the viewMatrix property querying interface.
 229    * @pre The camera is on-stage.
 230    * @return The viewMatrix property querying interface.
 231    */
 232   const PropertyInputImpl* GetViewMatrix() const;
 233
 234   /**
 235    * Updates view and projection matrices.
 236    * Called by the render task using the camera
 237    * @param[in] updateBufferIndex The buffer to read from.
 238    */
 239   void Update( BufferIndex updateBufferIndex );
 240
 241   /**
 242    * @return true if the view matrix of camera is updated this or the previous frame
 243    */
 244   bool ViewMatrixUpdated();
 245
 246 private:
 247
 248   /**
 249    * Constructor
 250    */
 251   Camera();
 252
 253   // Non copyable
 254   // Undefined
 255   Camera(const Camera&);
 256   // Undefined
 257   Camera& operator=(const Camera& rhs);
 258
 259   /**
 260    * Recalculates the view matrix.
 261    * @param[in] bufferIndex The current update buffer index.
 262    * @return count how many frames ago the matrix was changed.
 263    */
 264   uint32_t UpdateViewMatrix( BufferIndex updateBufferIndex );
 265
 266   /**
 267    * Recalculates the projection matrix.
 268    * @param[in] bufferIndex The current update buffer index.
 269    * @return count how many frames ago the matrix was changed.
 270    */
 271   uint32_t UpdateProjection( BufferIndex updateBufferIndex );
 272
 273 private:
 274
 275   /**
 276    * @brief Extracts the frustum planes.
 277    *
 278    * @param[in] bufferIndex The current update buffer index.
 279    * @param[in] normalize will normalize plane equation coefficients by default.
 280    */
 281   void UpdateFrustum( BufferIndex updateBufferIndex, bool normalize = true );
 282
 283   /**
 284    * Adjust near plane for reflection
 285    * @param perspective Perspective matrix
 286    * @param clipPlane Clipping plane
 287    */
 288   void AdjustNearPlaneForPerspective( Matrix& perspective, const Vector4& clipPlane );
 289
 290   uint32_t                  mUpdateViewFlag;       ///< This is non-zero if the view matrix requires an update
 291   uint32_t                  mUpdateProjectionFlag; ///< This is non-zero if the projection matrix requires an update
 292   const Node*                   mNode;                 ///< The node this scene graph camera belongs to
 293
 294 public:  // PROPERTIES
 295   Dali::Camera::Type            mType;                 // Non-animatable
 296   Dali::Camera::ProjectionMode  mProjectionMode;       // Non-animatable
 297   bool                          mInvertYAxis;          // Non-animatable
 298
 299   float                         mFieldOfView;
 300   float                         mAspectRatio;
 301   float                         mLeftClippingPlane;
 302   float                         mRightClippingPlane;
 303   float                         mTopClippingPlane;
 304   float                         mBottomClippingPlane;
 305   float                         mNearClippingPlane;
 306   float                         mFarClippingPlane;
 307   Vector3                       mTargetPosition;
 308
 309   Dali::Matrix                  mReflectionMtx;
 310   Dali::Vector4                 mReflectionPlane;
 311   Dali::Vector4                 mReflectionEye;
 312   bool                          mUseReflection{ false };
 313   bool                          mUseReflectionClip{ false };
 314
 315   InheritedMatrix mViewMatrix;           ///< The viewMatrix; this is double buffered for input handling.
 316   InheritedMatrix mProjectionMatrix;     ///< The projectionMatrix; this is double buffered for input handling.
 317
 318   DoubleBuffered< FrustumPlanes > mFrustum;               ///< Clipping frustum; double buffered for input handling
 319   DoubleBuffered< Matrix >        mInverseViewProjection; ///< Inverted viewprojection; double buffered for input handling
 320
 321 };
 322
 323 // Messages for Camera
 324
 325 inline void SetTypeMessage( EventThreadServices& eventThreadServices, const Camera& camera, Dali::Camera::Type parameter )
 326 {
 327   typedef MessageValue1< Camera, Dali::Camera::Type > LocalType;
 328
 329   // Reserve some memory inside the message queue
 330   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 331
 332   // Construct message in the message queue memory; note that delete should not be called on the return value
 333   new (slot) LocalType( &camera, &Camera::SetType, parameter );
 334 }
 335
 336 inline void SetProjectionModeMessage( EventThreadServices& eventThreadServices, const Camera& camera, Dali::Camera::ProjectionMode parameter )
 337 {
 338   typedef MessageValue1< Camera, Dali::Camera::ProjectionMode > LocalProjectionMode;
 339
 340   // Reserve some memory inside the message queue
 341   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalProjectionMode ) );
 342
 343   // Construct message in the message queue memory; note that delete should not be called on the return value
 344   new (slot) LocalProjectionMode( &camera, &Camera::SetProjectionMode, parameter );
 345 }
 346
 347 inline void SetFieldOfViewMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 348 {
 349   typedef MessageValue1< Camera, float > LocalType;
 350
 351   // Reserve some memory inside the message queue
 352   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 353
 354   // Construct message in the message queue memory; note that delete should not be called on the return value
 355   new (slot) LocalType( &camera, &Camera::SetFieldOfView, parameter );
 356 }
 357
 358 inline void SetAspectRatioMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 359 {
 360   typedef MessageValue1< Camera, float > LocalType;
 361
 362   // Reserve some memory inside the message queue
 363   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 364
 365   // Construct message in the message queue memory; note that delete should not be called on the return value
 366   new (slot) LocalType( &camera, &Camera::SetAspectRatio, parameter );
 367 }
 368
 369 inline void SetLeftClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 370 {
 371   typedef MessageValue1< Camera, float > LocalType;
 372
 373   // Reserve some memory inside the message queue
 374   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 375
 376   // Construct message in the message queue memory; note that delete should not be called on the return value
 377   new (slot) LocalType( &camera, &Camera::SetLeftClippingPlane, parameter );
 378 }
 379
 380 inline void SetRightClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 381 {
 382   typedef MessageValue1< Camera, float > LocalType;
 383
 384   // Reserve some memory inside the message queue
 385   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 386
 387   // Construct message in the message queue memory; note that delete should not be called on the return value
 388   new (slot) LocalType( &camera, &Camera::SetRightClippingPlane, parameter );
 389 }
 390
 391 inline void SetTopClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 392 {
 393   typedef MessageValue1< Camera, float > LocalType;
 394
 395   // Reserve some memory inside the message queue
 396   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 397
 398   // Construct message in the message queue memory; note that delete should not be called on the return value
 399   new (slot) LocalType( &camera, &Camera::SetTopClippingPlane, parameter );
 400 }
 401
 402 inline void SetBottomClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 403 {
 404   typedef MessageValue1< Camera, float > LocalType;
 405
 406   // Reserve some memory inside the message queue
 407   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 408
 409   // Construct message in the message queue memory; note that delete should not be called on the return value
 410   new (slot) LocalType( &camera, &Camera::SetBottomClippingPlane, parameter );
 411 }
 412
 413 inline void SetNearClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 414 {
 415   typedef MessageValue1< Camera, float > LocalType;
 416
 417   // Reserve some memory inside the message queue
 418   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 419
 420   // Construct message in the message queue memory; note that delete should not be called on the return value
 421   new (slot) LocalType( &camera, &Camera::SetNearClippingPlane, parameter );
 422 }
 423
 424 inline void SetFarClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
 425 {
 426   typedef MessageValue1< Camera, float > LocalType;
 427
 428   // Reserve some memory inside the message queue
 429   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 430
 431   // Construct message in the message queue memory; note that delete should not be called on the return value
 432   new (slot) LocalType( &camera, &Camera::SetFarClippingPlane, parameter );
 433 }
 434
 435 inline void SetTargetPositionMessage( EventThreadServices& eventThreadServices, const Camera& camera, const Vector3& parameter )
 436 {
 437   typedef MessageValue1< Camera, Vector3 > LocalType;
 438
 439   // Reserve some memory inside the message queue
 440   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 441
 442   // Construct message in the message queue memory; note that delete should not be called on the return value
 443   new (slot) LocalType( &camera, &Camera::SetTargetPosition, parameter );
 444 }
 445
 446 inline void SetInvertYAxisMessage( EventThreadServices& eventThreadServices, const Camera& camera, bool parameter )
 447 {
 448   typedef MessageValue1< Camera, bool > LocalType;
 449
 450   // Reserve some memory inside the message queue
 451   uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
 452
 453   // Construct message in the message queue memory; note that delete should not be called on the return value
 454   new (slot) LocalType( &camera, &Camera::SetInvertYAxis, parameter );
 455 }
 456
 457 } // namespace SceneGraph
 458
 459 } // namespace Internal
 460
 461 } // namespace Dali
 462
 463 #endif // DALI_INTERNAL_SCENE_GRAPH_CAMERA_H