2 * Copyright (c) 2016 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-toolkit/internal/controls/magnifier/magnifier-impl.h>
22 #include <dali/public-api/animation/constraint.h>
23 #include <dali/public-api/animation/constraints.h>
24 #include <dali/public-api/common/stage.h>
25 #include <dali/public-api/render-tasks/render-task-list.h>
26 #include <dali/public-api/images/resource-image.h>
27 #include <dali/public-api/object/type-registry.h>
28 #include <dali/public-api/object/type-registry-helper.h>
29 #include <dali/public-api/object/property-map.h>
32 #include <dali-toolkit/public-api/visuals/border-visual-properties.h>
33 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
44 namespace // unnamed namespace
48 Dali::BaseHandle Create()
50 return Toolkit::Magnifier::New();
53 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Magnifier, Toolkit::Control, Create )
55 DALI_PROPERTY_REGISTRATION( Toolkit, Magnifier, "frameVisibility", BOOLEAN, FRAME_VISIBILITY )
56 DALI_PROPERTY_REGISTRATION( Toolkit, Magnifier, "magnificationFactor", FLOAT, MAGNIFICATION_FACTOR )
58 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Magnifier, "sourcePosition", VECTOR3, SOURCE_POSITION )
60 DALI_TYPE_REGISTRATION_END()
62 const float IMAGE_BORDER_INDENT = 5.0f; ///< Indent of border in pixels.
64 struct CameraActorPositionConstraint
66 CameraActorPositionConstraint(const Vector2& stageSize, float defaultCameraDistance = 0.0f)
67 : mStageSize(stageSize),
68 mDefaultCameraDistance(defaultCameraDistance)
72 void operator()( Vector3& current, const PropertyInputContainer& inputs )
74 const Vector3& sourcePosition = inputs[0]->GetVector3();
76 current.x = sourcePosition.x + mStageSize.x * 0.5f;
77 current.y = sourcePosition.y + mStageSize.y * 0.5f;
78 current.z = sourcePosition.z + mDefaultCameraDistance;
82 float mDefaultCameraDistance;
86 struct RenderTaskViewportPositionConstraint
88 RenderTaskViewportPositionConstraint(const Vector2& stageSize)
89 : mStageSize(stageSize)
93 void operator()( Vector2& current, const PropertyInputContainer& inputs )
95 current = inputs[0]->GetVector3(); // World position?
97 // should be updated when:
98 // Magnifier's world position/size/scale/parentorigin/anchorpoint changes.
99 // or Magnifier camera's world position changes.
100 Vector3 size = inputs[1]->GetVector3() * inputs[2]->GetVector3(); /* magnifier-size * magnifier-scale */
102 // Reposition, and resize viewport to reflect the world bounds of this Magnifier actor.
103 current.x += ( mStageSize.width - size.width ) * 0.5f;
104 current.y += ( mStageSize.height - size.height ) * 0.5f;
110 struct RenderTaskViewportSizeConstraint
112 RenderTaskViewportSizeConstraint()
116 void operator()( Vector2& current, const PropertyInputContainer& inputs )
118 current = inputs[0]->GetVector3() * inputs[1]->GetVector3(); /* magnifier-size * magnifier-scale */
122 } // unnamed namespace
124 ///////////////////////////////////////////////////////////////////////////////////////////////////
126 ///////////////////////////////////////////////////////////////////////////////////////////////////
128 Dali::Toolkit::Magnifier Magnifier::New()
130 // Create the implementation
131 MagnifierPtr magnifier(new Magnifier());
133 // Pass ownership to CustomActor via derived handle
134 Dali::Toolkit::Magnifier handle(*magnifier);
136 // Second-phase init of the implementation
137 // This can only be done after the CustomActor connection has been made...
138 magnifier->Initialize();
143 Magnifier::Magnifier()
144 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_NONE ) ),
145 mDefaultCameraDistance(1000.f),
146 mActorSize(Vector3::ZERO),
147 mMagnificationFactor(1.0f)
151 void Magnifier::SetSourceActor(Actor actor)
153 mTask.SetSourceActor( actor );
156 void Magnifier::Initialize()
159 Vector2 stageSize(Stage::GetCurrent().GetSize());
162 // sourceActor is a dummy delegate actor that takes the source property position,
163 // and generates a WORLD_POSITION, which is 1 frame behind the source property.
164 // This way the constraints for determining the camera position (source) and those
165 // for determining viewport position use the same 1 frame old values.
166 // A simple i) CameraPos = f(B), ii) B = f(A) set of constraints wont suffice as
167 // although CameraPos will use B, which is A's previous value. The constraint will
168 // not realise that B is still dirty as far as constraint (i) is concerned.
169 // Perhaps this is a bug in the way the constraint system factors into what is dirty
171 mSourceActor = Actor::New();
172 Stage().GetCurrent().Add(mSourceActor);
173 mSourceActor.SetParentOrigin(ParentOrigin::CENTER);
174 Constraint constraint = Constraint::New<Vector3>( mSourceActor, Actor::Property::POSITION, EqualToConstraint() );
175 constraint.AddSource( Source( self, Toolkit::Magnifier::Property::SOURCE_POSITION ) );
178 // create the render task this will render content on top of everything
179 // based on camera source position.
180 InitializeRenderTask();
182 // set up some constraints to:
183 // i) reposition (dest) frame actor based on magnifier actor's world position (this is 1 frame delayed)
184 // ii) reposition and resize (dest) the render task's viewport based on magnifier actor's world position (1 frame delayed) & size.
185 // iii) reposition (source) camera actor based on magnifier source actor's world position (this is 1 frame delayed)
187 // Apply constraint to camera's position
188 // Position our camera at the same distance from its target as the default camera is.
189 // The camera position doesn't affect how we render, just what we render (due to near and far clip planes)
190 // NOTE: We can't interrogate the default camera's position as it is not known initially (takes 1 frame
191 // for value to update).
192 // But we can determine the initial position using the same formula:
193 // distance = stage.height * 0.5 / tan(FOV * 0.5)
195 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
196 RenderTask renderTask = taskList.GetTask(0u);
197 float fov = renderTask.GetCameraActor().GetFieldOfView();
198 mDefaultCameraDistance = (stageSize.height * 0.5f) / tanf(fov * 0.5f);
200 // Use a 1 frame delayed source position to determine the camera actor's position.
201 // This is necessary as the viewport is determined by the Magnifier's Actor's World position (which is computed
202 // at the end of the update cycle i.e. after constraints have been applied.)
203 //Property::Index propertySourcePositionDelayed = mCameraActor.RegisterProperty("delayedSourcePosition", Vector3::ZERO);
205 constraint = Constraint::New<Vector3>( mCameraActor, Actor::Property::POSITION, CameraActorPositionConstraint(stageSize, mDefaultCameraDistance) );
206 constraint.AddSource( Source( mSourceActor, Actor::Property::WORLD_POSITION ) );
209 // Apply constraint to render-task viewport position
210 constraint = Constraint::New<Vector2>( mTask, RenderTask::Property::VIEWPORT_POSITION, RenderTaskViewportPositionConstraint(stageSize) );
211 constraint.AddSource( Source( self, Actor::Property::WORLD_POSITION ) );
212 constraint.AddSource( Source( self, Actor::Property::SIZE ) );
213 constraint.AddSource( Source( self, Actor::Property::WORLD_SCALE ) );
216 // Apply constraint to render-task viewport position
217 constraint = Constraint::New<Vector2>( mTask, RenderTask::Property::VIEWPORT_SIZE, RenderTaskViewportSizeConstraint() );
218 constraint.AddSource( Source( self, Actor::Property::SIZE ) );
219 constraint.AddSource( Source( self, Actor::Property::WORLD_SCALE ) );
223 Magnifier::~Magnifier()
228 void Magnifier::InitializeRenderTask()
230 Stage stage = Stage::GetCurrent();
232 RenderTaskList taskList = stage.GetRenderTaskList();
234 mTask = taskList.CreateTask();
235 mTask.SetInputEnabled(false);
236 mTask.SetClearColor(Vector4(0.5f, 0.5f, 0.5f, 1.0f));
237 mTask.SetClearEnabled(true);
239 mCameraActor = CameraActor::New();
240 mCameraActor.SetType(Camera::FREE_LOOK);
242 stage.Add(mCameraActor);
243 mTask.SetCameraActor( mCameraActor );
245 SetFrameVisibility(true);
248 bool Magnifier::GetFrameVisibility() const
253 void Magnifier::SetFrameVisibility(bool visible)
255 if(visible && !mFrame)
259 mFrame = Actor::New( );
260 mFrame.SetInheritPosition(false);
261 mFrame.SetInheritScale(true);
262 mFrame.SetResizePolicy( ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT, Dimension::ALL_DIMENSIONS );
263 Vector3 sizeOffset(IMAGE_BORDER_INDENT*2.f - 2.f, IMAGE_BORDER_INDENT*2.f - 2.f, 0.0f);
264 mFrame.SetSizeModeFactor( sizeOffset );
266 Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
269 map[ Toolkit::Visual::Property::TYPE ] = Toolkit::Visual::BORDER;
270 map[ Toolkit::BorderVisual::Property::COLOR ] = Color::WHITE;
271 map[ Toolkit::BorderVisual::Property::SIZE ] = IMAGE_BORDER_INDENT;
272 Toolkit::Visual::Base borderVisual = visualFactory.CreateVisual( map );
273 borderVisual.SetOnStage( mFrame );
275 Constraint constraint = Constraint::New<Vector3>( mFrame, Actor::Property::POSITION, EqualToConstraint() );
276 constraint.AddSource( ParentSource( Actor::Property::WORLD_POSITION ) );
281 else if(!visible && mFrame)
283 UnparentAndReset(mFrame);
287 void Magnifier::OnSizeSet(const Vector3& targetSize)
289 Control::OnSizeSet( targetSize );
291 // TODO: Once Camera/CameraActor properties function as proper animatable properties
292 // this code can disappear.
293 // whenever the size of the magnifier changes, the field of view needs to change
294 // to compensate for the new size of the viewport. this cannot be done within
295 // a constraint yet as Camera/CameraActor properties are not animatable/constrainable.
296 mActorSize = targetSize;
300 float Magnifier::GetMagnificationFactor() const
302 return mMagnificationFactor;
305 void Magnifier::SetMagnificationFactor(float value)
307 mMagnificationFactor = value;
311 void Magnifier::Update()
313 // TODO: Make Camera settings (fieldofview/aspectratio) as animatable constraints.
315 // should be updated when:
316 // Magnifier's world size/scale changes.
318 Vector3 worldSize = mActorSize * self.GetCurrentWorldScale();
320 // Adjust field of view to scale content
329 // |/ <--- fov/2 radians.
331 const float fov = atanf( 0.5f * worldSize.height / mDefaultCameraDistance / mMagnificationFactor) * 2.0f;
332 mCameraActor.SetFieldOfView( fov );
334 // Adjust aspect ratio to compensate for rectangular viewports.
335 mCameraActor.SetAspectRatio( worldSize.width / worldSize.height );
338 void Magnifier::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
340 Toolkit::Magnifier magnifier = Toolkit::Magnifier::DownCast( Dali::BaseHandle( object ) );
344 Magnifier& magnifierImpl( GetImpl( magnifier ) );
347 case Toolkit::Magnifier::Property::FRAME_VISIBILITY:
349 magnifierImpl.SetFrameVisibility( value.Get< bool >() );
352 case Toolkit::Magnifier::Property::MAGNIFICATION_FACTOR:
354 magnifierImpl.SetMagnificationFactor( value.Get< float >() );
361 Property::Value Magnifier::GetProperty( BaseObject* object, Property::Index index )
363 Property::Value value;
365 Toolkit::Magnifier magnifier = Toolkit::Magnifier::DownCast( Dali::BaseHandle( object ) );
369 Magnifier& magnifierImpl( GetImpl( magnifier ) );
372 case Toolkit::Magnifier::Property::FRAME_VISIBILITY:
374 value = magnifierImpl.GetFrameVisibility();
377 case Toolkit::Magnifier::Property::MAGNIFICATION_FACTOR:
379 value = magnifierImpl.GetMagnificationFactor();
388 } // namespace Internal
390 } // namespace Toolkit