2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/event/actors/camera-actor-impl.h>
23 #include <cstring> // for strcmp
26 #include <dali/devel-api/actors/camera-actor-devel.h>
27 #include <dali/internal/event/common/projection.h>
28 #include <dali/internal/event/common/property-helper.h>
29 #include <dali/internal/event/common/thread-local-storage.h>
30 #include <dali/public-api/object/type-registry.h>
32 #include <dali/internal/update/manager/update-manager.h>
43 * We want to discourage the use of property strings (minimize string comparisons),
44 * particularly for the default properties.
45 * Name Type writable animatable constraint-input enum for index-checking
48 DALI_PROPERTY_TABLE_BEGIN
49 DALI_PROPERTY( "type", STRING, true, false, true, Dali::CameraActor::Property::TYPE )
50 DALI_PROPERTY( "projectionMode", STRING, true, false, true, Dali::CameraActor::Property::PROJECTION_MODE )
51 DALI_PROPERTY( "fieldOfView", FLOAT, true, false, true, Dali::CameraActor::Property::FIELD_OF_VIEW )
52 DALI_PROPERTY( "aspectRatio", FLOAT, true, false, true, Dali::CameraActor::Property::ASPECT_RATIO )
53 DALI_PROPERTY( "nearPlaneDistance", FLOAT, true, false, true, Dali::CameraActor::Property::NEAR_PLANE_DISTANCE )
54 DALI_PROPERTY( "farPlaneDistance", FLOAT, true, false, true, Dali::CameraActor::Property::FAR_PLANE_DISTANCE )
55 DALI_PROPERTY( "leftPlaneDistance", FLOAT, true, false, true, Dali::CameraActor::Property::LEFT_PLANE_DISTANCE )
56 DALI_PROPERTY( "rightPlaneDistance", FLOAT, true, false, true, Dali::CameraActor::Property::RIGHT_PLANE_DISTANCE )
57 DALI_PROPERTY( "topPlaneDistance", FLOAT, true, false, true, Dali::CameraActor::Property::TOP_PLANE_DISTANCE )
58 DALI_PROPERTY( "bottomPlaneDistance", FLOAT, true, false, true, Dali::CameraActor::Property::BOTTOM_PLANE_DISTANCE )
59 DALI_PROPERTY( "targetPosition", VECTOR3, true, false, true, Dali::CameraActor::Property::TARGET_POSITION )
60 DALI_PROPERTY( "projectionMatrix", MATRIX, false, false, true, Dali::CameraActor::Property::PROJECTION_MATRIX )
61 DALI_PROPERTY( "viewMatrix", MATRIX, false, false, true, Dali::CameraActor::Property::VIEW_MATRIX )
62 DALI_PROPERTY( "invertYAxis", BOOLEAN, true, false, true, Dali::CameraActor::Property::INVERT_Y_AXIS )
63 DALI_PROPERTY_TABLE_END( DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, CameraDefaultProperties )
66 // calculate the far plane distance for a 16bit depth buffer with 4 bits per unit precision
67 void CalculateClippingAndZ(float width, float height, float& nearClippingPlane, float& farClippingPlane, float& cameraZ)
69 nearClippingPlane = std::max(width, height);
70 farClippingPlane = nearClippingPlane + static_cast<float>(0xFFFF >> 4);
71 cameraZ = 2.0f * nearClippingPlane;
76 return Dali::CameraActor::New();
79 TypeRegistration mType(typeid(Dali::CameraActor), typeid(Dali::Actor), Create, CameraDefaultProperties);
82 * Builds the picking ray in the world reference system from an orthographic camera
83 * The ray origin is the screen coordinate in the near plane translated to a parallel
84 * plane at the camera origin. The ray direction is the direction the camera is facing
85 * (i.e. Z=-1 in view space).
87 void BuildOrthoPickingRay(const Matrix& viewMatrix,
88 const Matrix& projectionMatrix,
89 const Viewport& viewport,
94 float nearPlaneDistance)
96 // inv( modelMatrix ) inv( viewMatrix ) inv( projectionMatrix ) normalize
97 // <----------------- <----------------- <-------------- <-------------
98 // Local World Camera Normalized Screen
99 // reference reference reference clip coordinates
100 // system system system coordinates
101 // -----------------> -----------------> --------------> ------------->
102 // modelMatrix viewMatrix projectionMatrix viewport
104 // Transforms the touch point from the screen reference system to the world reference system.
105 Matrix invViewProjection(false); // Don't initialize.
106 Matrix::Multiply(invViewProjection, viewMatrix, projectionMatrix);
107 if(!invViewProjection.Invert())
109 DALI_ASSERT_DEBUG(false);
112 Vector4 near(screenX - static_cast<float>(viewport.x),
113 static_cast<float>(viewport.height) - (screenY - static_cast<float>(viewport.y)),
116 if(!Unproject(near, invViewProjection, static_cast<float>(viewport.width), static_cast<float>(viewport.height), rayOrigin))
118 DALI_ASSERT_DEBUG(false);
121 Matrix invView = viewMatrix;
122 if(!invView.Invert())
124 DALI_ASSERT_DEBUG(false);
127 Vector4 cameraOrigin = invView * Vector4(0.f, 0.f, 0.f, 1.f);
128 Vector4 nearPlaneOrigin = invView * Vector4(0.0f, 0.0f, -nearPlaneDistance, 1.0f);
130 // Vector pointing from the camera to the near plane
131 rayDir = cameraOrigin - nearPlaneOrigin;
139 CameraActorPtr CameraActor::New(const Size& size)
141 CameraActorPtr actor(new CameraActor(*CreateNode()));
143 // Second-phase construction
146 actor->SetName("DefaultCamera");
147 actor->SetPerspectiveProjection(size);
149 // By default Actors face in the positive Z direction in world space
150 // CameraActors should face in the negative Z direction, towards the other actors
151 actor->SetOrientation(Quaternion(Dali::ANGLE_180, Vector3::YAXIS));
156 CameraActor::CameraActor(const SceneGraph::Node& node)
157 : Actor(Actor::BASIC, node),
158 mSceneObject(nullptr),
159 mTarget(SceneGraph::Camera::DEFAULT_TARGET_POSITION),
160 mType(SceneGraph::Camera::DEFAULT_TYPE),
161 mProjectionMode(SceneGraph::Camera::DEFAULT_MODE),
162 mFieldOfView(SceneGraph::Camera::DEFAULT_FIELD_OF_VIEW),
163 mAspectRatio(SceneGraph::Camera::DEFAULT_ASPECT_RATIO),
164 mNearClippingPlane(SceneGraph::Camera::DEFAULT_NEAR_CLIPPING_PLANE),
165 mFarClippingPlane(SceneGraph::Camera::DEFAULT_FAR_CLIPPING_PLANE),
166 mLeftClippingPlane(SceneGraph::Camera::DEFAULT_LEFT_CLIPPING_PLANE),
167 mRightClippingPlane(SceneGraph::Camera::DEFAULT_RIGHT_CLIPPING_PLANE),
168 mTopClippingPlane(SceneGraph::Camera::DEFAULT_TOP_CLIPPING_PLANE),
169 mBottomClippingPlane(SceneGraph::Camera::DEFAULT_BOTTOM_CLIPPING_PLANE),
170 mInvertYAxis(SceneGraph::Camera::DEFAULT_INVERT_Y_AXIS)
174 CameraActor::~CameraActor()
176 if(EventThreadServices::IsCoreRunning())
178 // Create scene-object and transfer ownership through message
179 RemoveCameraMessage(GetEventThreadServices().GetUpdateManager(), mSceneObject);
183 void CameraActor::OnInitialize()
185 // Create scene-object and keep raw pointer for message passing.
186 SceneGraph::Camera* sceneGraphCamera = SceneGraph::Camera::New();
188 // Store a pointer to this camera node inside the scene-graph camera.
189 sceneGraphCamera->SetNode(&GetNode());
191 mSceneObject = sceneGraphCamera;
192 OwnerPointer<SceneGraph::Camera> sceneGraphCameraOwner(sceneGraphCamera);
194 // Send message to inform update of this camera (and move ownership).
195 AddCameraMessage(GetEventThreadServices().GetUpdateManager(), sceneGraphCameraOwner);
198 void CameraActor::OnSceneConnectionInternal()
200 // If the canvas size has not been set, then use the size of the scene we've been added to to set up the perspective projection
201 if((mCanvasSize.width < Math::MACHINE_EPSILON_1000) || (mCanvasSize.height < Math::MACHINE_EPSILON_1000))
203 SetPerspectiveProjection(GetScene().GetSize());
207 void CameraActor::SetReflectByPlane(const Vector4& plane)
209 SceneGraph::Camera* cam = const_cast<SceneGraph::Camera*>(GetCamera());
212 cam->SetReflectByPlane(plane);
216 void CameraActor::SetTarget(const Vector3& target)
218 if(target != mTarget) // using range epsilon
222 SetTargetPositionMessage(GetEventThreadServices(), *mSceneObject, mTarget);
226 Vector3 CameraActor::GetTarget() const
231 void CameraActor::SetType(Dali::Camera::Type type)
237 // sceneObject is being used in a separate thread; queue a message to set
238 SetTypeMessage(GetEventThreadServices(), *mSceneObject, mType);
242 Dali::Camera::Type CameraActor::GetType() const
247 void CameraActor::SetProjectionMode(Dali::Camera::ProjectionMode mode)
249 if(mode != mProjectionMode)
251 mProjectionMode = mode;
253 // sceneObject is being used in a separate thread; queue a message to set
254 SetProjectionModeMessage(GetEventThreadServices(), *mSceneObject, mProjectionMode);
258 Dali::Camera::ProjectionMode CameraActor::GetProjectionMode() const
260 return mProjectionMode;
263 void CameraActor::SetFieldOfView(float fieldOfView)
265 if(!Equals(fieldOfView, mFieldOfView))
267 mFieldOfView = fieldOfView;
269 // sceneObject is being used in a separate thread; queue a message to set
270 SetFieldOfViewMessage(GetEventThreadServices(), *mSceneObject, mFieldOfView);
274 float CameraActor::GetFieldOfView() const
279 void CameraActor::SetAspectRatio(float aspectRatio)
281 if(!Equals(aspectRatio, mAspectRatio))
283 mAspectRatio = aspectRatio;
285 // sceneObject is being used in a separate thread; queue a message to set
286 SetAspectRatioMessage(GetEventThreadServices(), *mSceneObject, mAspectRatio);
290 float CameraActor::GetAspectRatio() const
295 void CameraActor::SetNearClippingPlane(float nearClippingPlane)
297 if(!Equals(nearClippingPlane, mNearClippingPlane))
299 mNearClippingPlane = nearClippingPlane;
301 // sceneObject is being used in a separate thread; queue a message to set
302 SetNearClippingPlaneMessage(GetEventThreadServices(), *mSceneObject, mNearClippingPlane);
306 float CameraActor::GetNearClippingPlane() const
308 return mNearClippingPlane;
311 void CameraActor::SetFarClippingPlane(float farClippingPlane)
313 if(!Equals(farClippingPlane, mFarClippingPlane))
315 mFarClippingPlane = farClippingPlane;
317 // sceneObject is being used in a separate thread; queue a message to set
318 SetFarClippingPlaneMessage(GetEventThreadServices(), *mSceneObject, mFarClippingPlane);
322 float CameraActor::GetFarClippingPlane() const
324 return mFarClippingPlane;
327 void CameraActor::SetLeftClippingPlane(float leftClippingPlane)
329 if(!Equals(leftClippingPlane, mLeftClippingPlane))
331 mLeftClippingPlane = leftClippingPlane;
333 // sceneObject is being used in a separate thread; queue a message to set
334 SetLeftClippingPlaneMessage(GetEventThreadServices(), *mSceneObject, mLeftClippingPlane);
338 void CameraActor::SetRightClippingPlane(float rightClippingPlane)
340 if(!Equals(rightClippingPlane, mRightClippingPlane))
342 mRightClippingPlane = rightClippingPlane;
344 // sceneObject is being used in a separate thread; queue a message to set
345 SetRightClippingPlaneMessage(GetEventThreadServices(), *mSceneObject, mRightClippingPlane);
349 void CameraActor::SetTopClippingPlane(float topClippingPlane)
351 if(!Equals(topClippingPlane, mTopClippingPlane))
353 mTopClippingPlane = topClippingPlane;
355 // sceneObject is being used in a separate thread; queue a message to set
356 SetTopClippingPlaneMessage(GetEventThreadServices(), *mSceneObject, mTopClippingPlane);
360 void CameraActor::SetBottomClippingPlane(float bottomClippingPlane)
362 if(!Equals(bottomClippingPlane, mBottomClippingPlane))
364 mBottomClippingPlane = bottomClippingPlane;
366 // sceneObject is being used in a separate thread; queue a message to set
367 SetBottomClippingPlaneMessage(GetEventThreadServices(), *mSceneObject, mBottomClippingPlane);
371 void CameraActor::SetInvertYAxis(bool invertYAxis)
373 if(invertYAxis != mInvertYAxis)
375 mInvertYAxis = invertYAxis;
377 // sceneObject is being used in a separate thread; queue a message to set
378 SetInvertYAxisMessage(GetEventThreadServices(), *mSceneObject, mInvertYAxis);
382 bool CameraActor::GetInvertYAxis() const
387 void CameraActor::SetPerspectiveProjection(const Size& size)
391 if((size.width < Math::MACHINE_EPSILON_1000) || (size.height < Math::MACHINE_EPSILON_1000))
393 // If the size given is invalid, i.e. ZERO, then check if we've been added to a scene
396 // We've been added to a scene already, set the canvas size to the scene's size
397 mCanvasSize = GetScene().GetSize();
401 // We've not been added to a scene yet, so just return.
402 // We'll set the canvas size when we get added to a scene later
407 float width = mCanvasSize.width;
408 float height = mCanvasSize.height;
410 float nearClippingPlane;
411 float farClippingPlane;
413 CalculateClippingAndZ(width, height, nearClippingPlane, farClippingPlane, cameraZ);
415 // calculate the position of the camera to have the desired aspect ratio
416 const float fieldOfView = 2.0f * std::atan(height * 0.5f / cameraZ);
418 // unless it is too small, we want at least as much space to the back as we have torwards the front
419 const float minClippingFarPlane = 2.f * nearClippingPlane;
420 if(farClippingPlane < minClippingFarPlane)
422 farClippingPlane = minClippingFarPlane;
425 const float aspectRatio = width / height;
427 // sceneObject is being used in a separate thread; queue a message to set
428 SetProjectionMode(Dali::Camera::PERSPECTIVE_PROJECTION);
429 SetFieldOfView(fieldOfView);
430 SetNearClippingPlane(nearClippingPlane);
431 SetFarClippingPlane(farClippingPlane);
432 SetAspectRatio(aspectRatio);
436 void CameraActor::SetOrthographicProjection(const Vector2& size)
438 // Choose near, far and Z parameters to match the SetPerspectiveProjection above.
439 float nearClippingPlane;
440 float farClippingPlane;
442 CalculateClippingAndZ(size.width, size.height, nearClippingPlane, farClippingPlane, cameraZ);
443 SetOrthographicProjection(-size.x * 0.5f, size.x * 0.5f, size.y * 0.5f, -size.y * 0.5f, nearClippingPlane, farClippingPlane);
447 void CameraActor::SetOrthographicProjection(float left, float right, float top, float bottom, float near, float far)
449 SetLeftClippingPlane(left);
450 SetRightClippingPlane(right);
451 SetTopClippingPlane(top);
452 SetBottomClippingPlane(bottom);
453 SetNearClippingPlane(near);
454 SetFarClippingPlane(far);
455 SetProjectionMode(Dali::Camera::ORTHOGRAPHIC_PROJECTION);
458 bool CameraActor::BuildPickingRay(const Vector2& screenCoordinates,
459 const Viewport& viewport,
461 Vector4& rayDirection)
464 if(mProjectionMode == Dali::Camera::PERSPECTIVE_PROJECTION)
466 // Build a picking ray in the world reference system.
467 // ray starts from the camera world position
468 rayOrigin = GetNode().GetWorldMatrix(0).GetTranslation();
471 // Transform the touch point from the screen coordinate system to the world coordinates system.
472 Vector4 near(screenCoordinates.x - static_cast<float>(viewport.x),
473 static_cast<float>(viewport.height) - (screenCoordinates.y - static_cast<float>(viewport.y)),
476 const Matrix& inverseViewProjection = mSceneObject->GetInverseViewProjectionMatrix(GetEventThreadServices().GetEventBufferIndex());
477 success = Unproject(near, inverseViewProjection, static_cast<float>(viewport.width), static_cast<float>(viewport.height), near);
479 // Compute the ray's director vector.
480 rayDirection.x = near.x - rayOrigin.x;
481 rayDirection.y = near.y - rayOrigin.y;
482 rayDirection.z = near.z - rayOrigin.z;
483 rayDirection.Normalize();
484 rayDirection.w = 1.f;
488 float nearPlaneDistance = GetNearClippingPlane();
489 BuildOrthoPickingRay(GetViewMatrix(),
490 GetProjectionMatrix(),
502 const Matrix& CameraActor::GetViewMatrix() const
506 return mSceneObject->GetViewMatrix(GetEventThreadServices().GetEventBufferIndex());
510 return Matrix::IDENTITY;
514 const Matrix& CameraActor::GetProjectionMatrix() const
518 return mSceneObject->GetProjectionMatrix(GetEventThreadServices().GetEventBufferIndex());
522 return Matrix::IDENTITY;
525 const SceneGraph::Camera* CameraActor::GetCamera() const
530 void CameraActor::RotateProjection(int rotationAngle)
532 // sceneObject is being used in a separate thread; queue a message to set
533 RotateProjectionMessage(GetEventThreadServices(), *mSceneObject, rotationAngle);
536 void CameraActor::SetDefaultProperty(Property::Index index, const Property::Value& propertyValue)
538 if(index < DEFAULT_ACTOR_PROPERTY_MAX_COUNT)
540 Actor::SetDefaultProperty(index, propertyValue);
546 case Dali::CameraActor::Property::TYPE:
548 std::string s(propertyValue.Get<std::string>());
549 if(s == "LOOK_AT_TARGET")
551 SetType(Dali::Camera::LOOK_AT_TARGET);
553 else if(s == "FREE_LOOK")
555 SetType(Dali::Camera::FREE_LOOK);
559 case Dali::CameraActor::Property::PROJECTION_MODE:
561 std::string s(propertyValue.Get<std::string>());
562 if(s == "PERSPECTIVE_PROJECTION")
564 SetProjectionMode(Dali::Camera::PERSPECTIVE_PROJECTION);
566 else if(s == "ORTHOGRAPHIC_PROJECTION")
568 SetProjectionMode(Dali::Camera::ORTHOGRAPHIC_PROJECTION);
572 case Dali::CameraActor::Property::FIELD_OF_VIEW:
574 SetFieldOfView(propertyValue.Get<float>()); // set to 0 in case property is not float
577 case Dali::CameraActor::Property::ASPECT_RATIO:
579 SetAspectRatio(propertyValue.Get<float>()); // set to 0 in case property is not float
582 case Dali::CameraActor::Property::NEAR_PLANE_DISTANCE:
584 SetNearClippingPlane(propertyValue.Get<float>()); // set to 0 in case property is not float
587 case Dali::CameraActor::Property::FAR_PLANE_DISTANCE:
589 SetFarClippingPlane(propertyValue.Get<float>()); // set to 0 in case property is not float
592 case Dali::CameraActor::Property::LEFT_PLANE_DISTANCE:
594 SetLeftClippingPlane(propertyValue.Get<float>()); // set to 0 in case property is not float
597 case Dali::CameraActor::Property::RIGHT_PLANE_DISTANCE:
599 SetRightClippingPlane(propertyValue.Get<float>()); // set to 0 in case property is not float
602 case Dali::CameraActor::Property::TOP_PLANE_DISTANCE:
604 SetTopClippingPlane(propertyValue.Get<float>()); // set to 0 in case property is not float
607 case Dali::CameraActor::Property::BOTTOM_PLANE_DISTANCE:
609 SetBottomClippingPlane(propertyValue.Get<float>()); // set to 0 in case property is not float
612 case Dali::CameraActor::Property::TARGET_POSITION:
614 SetTarget(propertyValue.Get<Vector3>()); // set to 0 in case property is not Vector3
617 case Dali::CameraActor::Property::PROJECTION_MATRIX:
619 DALI_LOG_WARNING("projection-matrix is read-only\n");
622 case Dali::CameraActor::Property::VIEW_MATRIX:
624 DALI_LOG_WARNING("view-matrix is read-only\n");
627 case Dali::CameraActor::Property::INVERT_Y_AXIS:
629 SetInvertYAxis(propertyValue.Get<bool>()); // set to false in case property is not bool
632 case Dali::DevelCameraActor::Property::REFLECTION_PLANE:
634 SetReflectByPlane(propertyValue.Get<Vector4>());
640 DALI_LOG_WARNING("Unknown property (%d)\n", index);
648 Property::Value CameraActor::GetDefaultProperty(Property::Index index) const
651 if(index < DEFAULT_ACTOR_PROPERTY_MAX_COUNT)
653 ret = Actor::GetDefaultProperty(index);
659 case Dali::CameraActor::Property::TYPE:
661 if(Dali::Camera::LOOK_AT_TARGET == mType)
663 ret = "LOOK_AT_TARGET";
665 else if(Dali::Camera::FREE_LOOK == mType)
671 case Dali::CameraActor::Property::PROJECTION_MODE:
673 if(Dali::Camera::PERSPECTIVE_PROJECTION == mProjectionMode)
675 ret = "PERSPECTIVE_PROJECTION";
677 else if(Dali::Camera::ORTHOGRAPHIC_PROJECTION == mProjectionMode)
679 ret = "ORTHOGRAPHIC_PROJECTION";
683 case Dali::CameraActor::Property::FIELD_OF_VIEW:
688 case Dali::CameraActor::Property::ASPECT_RATIO:
693 case Dali::CameraActor::Property::NEAR_PLANE_DISTANCE:
695 ret = mNearClippingPlane;
698 case Dali::CameraActor::Property::FAR_PLANE_DISTANCE:
700 ret = mFarClippingPlane;
703 case Dali::CameraActor::Property::LEFT_PLANE_DISTANCE:
705 ret = mLeftClippingPlane;
708 case Dali::CameraActor::Property::RIGHT_PLANE_DISTANCE:
710 ret = mRightClippingPlane;
713 case Dali::CameraActor::Property::TOP_PLANE_DISTANCE:
715 ret = mTopClippingPlane;
718 case Dali::CameraActor::Property::BOTTOM_PLANE_DISTANCE:
720 ret = mBottomClippingPlane;
723 case Dali::CameraActor::Property::TARGET_POSITION:
728 case Dali::CameraActor::Property::PROJECTION_MATRIX:
730 ret = GetProjectionMatrix(); // Only on scene-graph
733 case Dali::CameraActor::Property::VIEW_MATRIX:
735 ret = GetViewMatrix(); // Only on scene-graph
738 case Dali::CameraActor::Property::INVERT_Y_AXIS:
749 Property::Value CameraActor::GetDefaultPropertyCurrentValue(Property::Index index) const
752 if(index < DEFAULT_ACTOR_PROPERTY_MAX_COUNT)
754 ret = Actor::GetDefaultPropertyCurrentValue(index);
758 ret = GetDefaultProperty(index); // Most are event-side properties, the scene-graph properties are only on the scene-graph
764 const PropertyInputImpl* CameraActor::GetSceneObjectInputProperty(Property::Index index) const
766 const PropertyInputImpl* property(nullptr);
770 case Dali::CameraActor::Property::PROJECTION_MATRIX:
772 property = mSceneObject->GetProjectionMatrix();
775 case Dali::CameraActor::Property::VIEW_MATRIX:
777 property = mSceneObject->GetViewMatrix();
780 // no default on purpose as we chain method up to actor
784 property = Actor::GetSceneObjectInputProperty(index);
790 } // namespace Internal