1 #ifndef DALI_INTERNAL_SCENE_GRAPH_CAMERA_H
2 #define DALI_INTERNAL_SCENE_GRAPH_CAMERA_H
5 * Copyright (c) 2018 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.
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>
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 > {};
45 class SceneController;
48 * Scene-graph camera object
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;
68 * Plane equation container for a plane of the view frustum
77 * @brief Container for six planes in a view frustum
86 * Construct a new Camera.
87 * @return a new camera.
97 * Set the node this scene graph camera belongs to.
98 * @param[in] node The owning node.
100 void SetNode( const Node* node );
103 * @copydoc Dali::Internal::CameraActor::SetType
105 void SetType( Dali::Camera::Type type );
108 * @copydoc Dali::Internal::CameraActor::SetInvertYAxis
110 void SetInvertYAxis( bool invertYAxis );
113 * @copydoc Dali::Internal::CameraActor::SetProjectionMode
115 void SetProjectionMode( Dali::Camera::ProjectionMode projectionMode );
118 * @copydoc Dali::Internal::CameraActor::SetFieldOfView
120 void SetFieldOfView( float fieldOfView );
123 * @copydoc Dali::Internal::CameraActor::SetAspectRatio
125 void SetAspectRatio( float aspectRatio );
128 * @copydoc Dali::Internal::CameraActor::SetLeftClippingPlane
130 void SetLeftClippingPlane( float leftClippingPlane );
133 * @copydoc Dali::Internal::CameraActor::SetRightClippingPlane
135 void SetRightClippingPlane( float rightClippingPlane );
138 * @copydoc Dali::Internal::CameraActor::SetTopClippingPlane
140 void SetTopClippingPlane( float topClippingPlane );
143 * @copydoc Dali::Internal::CameraActor::SetBottomClippingPlane
145 void SetBottomClippingPlane( float bottomClippingPlane );
148 * @copydoc Dali::Internal::CameraActor::SetNearClippingPlane
150 void SetNearClippingPlane( float nearClippingPlane );
153 * @copydoc Dali::Internal::CameraActor::SetFarClippingPlane
155 void SetFarClippingPlane( float farClippingPlane );
158 * @copydoc Dali::Internal::CameraActor::RotateProjection
160 void RotateProjection( int rotationAngle );
163 * @copydoc Dali::Internal::CameraActor::SetTarget
165 void SetTargetPosition( const Vector3& targetPosition );
168 * Sets the reflection plane
169 * @param[in] plane reflection plane
171 void SetReflectByPlane( const Vector4& plane );
174 * Tests whether reflection is used
175 * @return True if used, False otherwise
177 bool GetReflectionUsed() const
179 return mUseReflection;
183 * Retrieve the view-matrix; this is double buffered for input handling.
184 * @param[in] bufferIndex The buffer to read from.
185 * @return The view-matrix.
187 const Matrix& GetViewMatrix( BufferIndex bufferIndex ) const;
190 * @brief Check to see if a sphere lies within the view frustum.
192 * @param bufferIndex The buffer to read from.
193 * @param origin The world position center of the sphere to check.
194 * @param radius The length of the sphere radius in world scale.
196 * @return false if the sphere lies outside of the frustum.
198 bool CheckSphereInFrustum( BufferIndex bufferIndex, const Vector3& origin, float radius );
201 * @brief Check to see if a bounding box lies within the view frustum.
203 * @param bufferIndex The buffer to read from.
204 * @param origin the world position center of the cubeoid to check.
205 * @param halfExtents The half length of the cubeoid in world co-ordinates in each axis.
207 * @return false if the cubeoid lies completely outside of the frustum, true otherwise
209 bool CheckAABBInFrustum( BufferIndex bufferIndex, const Vector3& origin, const Vector3& halfExtents );
212 * Retrieve the projection-matrix; this is double buffered for input handling.
213 * @param[in] bufferIndex The buffer to read from.
214 * @return The projection-matrix.
216 const Matrix& GetProjectionMatrix( BufferIndex bufferIndex ) const;
219 * Retrieve the inverted view-projection-matrix; this is double buffered for input handling.
220 * @param[in] bufferIndex The buffer to read from.
221 * @return The inverse view-projection-matrix.
223 const Matrix& GetInverseViewProjectionMatrix( BufferIndex bufferIndex ) const;
226 * Retrieve the final projection-matrix; this is double buffered for input handling.
227 * @param[in] bufferIndex The buffer to read from.
228 * @return The projection-matrix that should be used to render.
230 const Matrix& GetFinalProjectionMatrix( BufferIndex bufferIndex ) const;
233 * Retrieve the projection-matrix property querying interface.
234 * @pre The camera is on-stage.
235 * @return The projection-matrix property querying interface.
237 const PropertyInputImpl* GetProjectionMatrix() const;
240 * Retrieve the viewMatrix property querying interface.
241 * @pre The camera is on-stage.
242 * @return The viewMatrix property querying interface.
244 const PropertyInputImpl* GetViewMatrix() const;
247 * Updates view and projection matrices.
248 * Called by the render task using the camera
249 * @param[in] updateBufferIndex The buffer to read from.
251 void Update( BufferIndex updateBufferIndex );
254 * @return true if the view matrix of camera is updated this or the previous frame
256 bool ViewMatrixUpdated();
267 Camera(const Camera&);
269 Camera& operator=(const Camera& rhs);
272 * Recalculates the view matrix.
273 * @param[in] bufferIndex The current update buffer index.
274 * @return count how many frames ago the matrix was changed.
276 uint32_t UpdateViewMatrix( BufferIndex updateBufferIndex );
279 * Recalculates the projection matrix.
280 * @param[in] bufferIndex The current update buffer index.
281 * @return count how many frames ago the matrix was changed.
283 uint32_t UpdateProjection( BufferIndex updateBufferIndex );
288 * @brief Extracts the frustum planes.
290 * @param[in] bufferIndex The current update buffer index.
291 * @param[in] normalize will normalize plane equation coefficients by default.
293 void UpdateFrustum( BufferIndex updateBufferIndex, bool normalize = true );
296 * Adjust near plane for reflection
297 * @param perspective Perspective matrix
298 * @param clipPlane Clipping plane
300 void AdjustNearPlaneForPerspective( Matrix& perspective, const Vector4& clipPlane );
302 uint32_t mUpdateViewFlag; ///< This is non-zero if the view matrix requires an update
303 uint32_t mUpdateProjectionFlag; ///< This is non-zero if the projection matrix requires an update
304 int mProjectionRotation; ///< The rotaion angle of the projection
305 const Node* mNode; ///< The node this scene graph camera belongs to
307 public: // PROPERTIES
308 Dali::Camera::Type mType; // Non-animatable
309 Dali::Camera::ProjectionMode mProjectionMode; // Non-animatable
310 bool mInvertYAxis; // Non-animatable
314 float mLeftClippingPlane;
315 float mRightClippingPlane;
316 float mTopClippingPlane;
317 float mBottomClippingPlane;
318 float mNearClippingPlane;
319 float mFarClippingPlane;
320 Vector3 mTargetPosition;
322 Dali::Matrix mReflectionMtx;
323 Dali::Vector4 mReflectionPlane;
324 Dali::Vector4 mReflectionEye;
325 bool mUseReflection{ false };
326 bool mUseReflectionClip{ false };
328 InheritedMatrix mViewMatrix; ///< The viewMatrix; this is double buffered for input handling.
329 InheritedMatrix mProjectionMatrix; ///< The projectionMatrix; this is double buffered for input handling.
331 DoubleBuffered< FrustumPlanes > mFrustum; ///< Clipping frustum; double buffered for input handling
332 DoubleBuffered< Matrix > mInverseViewProjection; ///< Inverted viewprojection; double buffered for input handling
333 DoubleBuffered< Matrix > mFinalProjection; ///< Final projection matrix; double buffered for input handling
337 // Messages for Camera
339 inline void SetTypeMessage( EventThreadServices& eventThreadServices, const Camera& camera, Dali::Camera::Type parameter )
341 typedef MessageValue1< Camera, Dali::Camera::Type > LocalType;
343 // Reserve some memory inside the message queue
344 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
346 // Construct message in the message queue memory; note that delete should not be called on the return value
347 new (slot) LocalType( &camera, &Camera::SetType, parameter );
350 inline void SetProjectionModeMessage( EventThreadServices& eventThreadServices, const Camera& camera, Dali::Camera::ProjectionMode parameter )
352 typedef MessageValue1< Camera, Dali::Camera::ProjectionMode > LocalProjectionMode;
354 // Reserve some memory inside the message queue
355 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalProjectionMode ) );
357 // Construct message in the message queue memory; note that delete should not be called on the return value
358 new (slot) LocalProjectionMode( &camera, &Camera::SetProjectionMode, parameter );
361 inline void SetFieldOfViewMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
363 typedef MessageValue1< Camera, float > LocalType;
365 // Reserve some memory inside the message queue
366 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
368 // Construct message in the message queue memory; note that delete should not be called on the return value
369 new (slot) LocalType( &camera, &Camera::SetFieldOfView, parameter );
372 inline void SetAspectRatioMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
374 typedef MessageValue1< Camera, float > LocalType;
376 // Reserve some memory inside the message queue
377 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
379 // Construct message in the message queue memory; note that delete should not be called on the return value
380 new (slot) LocalType( &camera, &Camera::SetAspectRatio, parameter );
383 inline void SetLeftClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
385 typedef MessageValue1< Camera, float > LocalType;
387 // Reserve some memory inside the message queue
388 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
390 // Construct message in the message queue memory; note that delete should not be called on the return value
391 new (slot) LocalType( &camera, &Camera::SetLeftClippingPlane, parameter );
394 inline void SetRightClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
396 typedef MessageValue1< Camera, float > LocalType;
398 // Reserve some memory inside the message queue
399 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
401 // Construct message in the message queue memory; note that delete should not be called on the return value
402 new (slot) LocalType( &camera, &Camera::SetRightClippingPlane, parameter );
405 inline void SetTopClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
407 typedef MessageValue1< Camera, float > LocalType;
409 // Reserve some memory inside the message queue
410 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
412 // Construct message in the message queue memory; note that delete should not be called on the return value
413 new (slot) LocalType( &camera, &Camera::SetTopClippingPlane, parameter );
416 inline void SetBottomClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
418 typedef MessageValue1< Camera, float > LocalType;
420 // Reserve some memory inside the message queue
421 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
423 // Construct message in the message queue memory; note that delete should not be called on the return value
424 new (slot) LocalType( &camera, &Camera::SetBottomClippingPlane, parameter );
427 inline void SetNearClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
429 typedef MessageValue1< Camera, float > LocalType;
431 // Reserve some memory inside the message queue
432 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
434 // Construct message in the message queue memory; note that delete should not be called on the return value
435 new (slot) LocalType( &camera, &Camera::SetNearClippingPlane, parameter );
438 inline void SetFarClippingPlaneMessage( EventThreadServices& eventThreadServices, const Camera& camera, float parameter )
440 typedef MessageValue1< Camera, float > LocalType;
442 // Reserve some memory inside the message queue
443 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
445 // Construct message in the message queue memory; note that delete should not be called on the return value
446 new (slot) LocalType( &camera, &Camera::SetFarClippingPlane, parameter );
449 inline void SetTargetPositionMessage( EventThreadServices& eventThreadServices, const Camera& camera, const Vector3& parameter )
451 typedef MessageValue1< Camera, Vector3 > LocalType;
453 // Reserve some memory inside the message queue
454 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
456 // Construct message in the message queue memory; note that delete should not be called on the return value
457 new (slot) LocalType( &camera, &Camera::SetTargetPosition, parameter );
460 inline void SetInvertYAxisMessage( EventThreadServices& eventThreadServices, const Camera& camera, bool parameter )
462 typedef MessageValue1< Camera, bool > LocalType;
464 // Reserve some memory inside the message queue
465 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
467 // Construct message in the message queue memory; note that delete should not be called on the return value
468 new (slot) LocalType( &camera, &Camera::SetInvertYAxis, parameter );
471 inline void RotateProjectionMessage( EventThreadServices& eventThreadServices, const Camera& camera, int parameter )
473 typedef MessageValue1< Camera, int > LocalType;
475 // Reserve some memory inside the message queue
476 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
478 // Construct message in the message queue memory; note that delete should not be called on the return value
479 new (slot) LocalType( &camera, &Camera::RotateProjection, parameter );
482 } // namespace SceneGraph
484 } // namespace Internal
488 #endif // DALI_INTERNAL_SCENE_GRAPH_CAMERA_H