[dali_1.2.60] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / magnifier / magnifier-impl.cpp
1 /*
2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali-toolkit/internal/controls/magnifier/magnifier-impl.h>
20
21 // EXTERNAL INCLUDES
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>
30
31 // INTERNAL INCLUDES
32 #include <dali-toolkit/public-api/visuals/border-visual-properties.h>
33 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
34 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36
37 namespace Dali
38 {
39
40 namespace Toolkit
41 {
42
43 namespace Internal
44 {
45
46 namespace // unnamed namespace
47 {
48
49
50 Dali::BaseHandle Create()
51 {
52   return Toolkit::Magnifier::New();
53 }
54
55 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Magnifier, Toolkit::Control, Create )
56
57 DALI_PROPERTY_REGISTRATION( Toolkit, Magnifier, "frameVisibility",      BOOLEAN, FRAME_VISIBILITY     )
58 DALI_PROPERTY_REGISTRATION( Toolkit, Magnifier, "magnificationFactor",  FLOAT,   MAGNIFICATION_FACTOR )
59
60 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Magnifier, "sourcePosition",  VECTOR3, SOURCE_POSITION )
61
62 DALI_TYPE_REGISTRATION_END()
63
64 const float IMAGE_BORDER_INDENT = 5.0f;            ///< Indent of border in pixels.
65
66 struct CameraActorPositionConstraint
67 {
68   CameraActorPositionConstraint(const Vector2& stageSize, float defaultCameraDistance = 0.0f)
69   : mStageSize(stageSize),
70     mDefaultCameraDistance(defaultCameraDistance)
71   {
72   }
73
74   void operator()( Vector3& current, const PropertyInputContainer& inputs )
75   {
76     const Vector3& sourcePosition = inputs[0]->GetVector3();
77
78     current.x = sourcePosition.x + mStageSize.x * 0.5f;
79     current.y = sourcePosition.y + mStageSize.y * 0.5f;
80     current.z = sourcePosition.z + mDefaultCameraDistance;
81   }
82
83   Vector2 mStageSize;
84   float mDefaultCameraDistance;
85
86 };
87
88 struct RenderTaskViewportPositionConstraint
89 {
90   RenderTaskViewportPositionConstraint(const Vector2& stageSize)
91   : mStageSize(stageSize)
92   {
93   }
94
95   void operator()( Vector2& current, const PropertyInputContainer& inputs )
96   {
97     current = inputs[0]->GetVector3(); // World position?
98
99     // should be updated when:
100     // Magnifier's world position/size/scale/parentorigin/anchorpoint changes.
101     // or Magnifier camera's world position changes.
102     Vector3 size = inputs[1]->GetVector3() * inputs[2]->GetVector3(); /* magnifier-size * magnifier-scale */
103
104     // Reposition, and resize viewport to reflect the world bounds of this Magnifier actor.
105     current.x += ( mStageSize.width - size.width ) * 0.5f;
106     current.y += ( mStageSize.height - size.height ) * 0.5f;
107   }
108
109   Vector2 mStageSize;
110 };
111
112 struct RenderTaskViewportSizeConstraint
113 {
114   RenderTaskViewportSizeConstraint()
115   {
116   }
117
118   void operator()( Vector2& current, const PropertyInputContainer& inputs )
119   {
120     current = inputs[0]->GetVector3() * inputs[1]->GetVector3(); /* magnifier-size * magnifier-scale */
121   }
122 };
123
124 } // unnamed namespace
125
126 ///////////////////////////////////////////////////////////////////////////////////////////////////
127 // Magnifier
128 ///////////////////////////////////////////////////////////////////////////////////////////////////
129
130 Dali::Toolkit::Magnifier Magnifier::New()
131 {
132   // Create the implementation
133   MagnifierPtr magnifier(new Magnifier());
134
135   // Pass ownership to CustomActor via derived handle
136   Dali::Toolkit::Magnifier handle(*magnifier);
137
138   // Second-phase init of the implementation
139   // This can only be done after the CustomActor connection has been made...
140   magnifier->Initialize();
141
142   return handle;
143 }
144
145 Magnifier::Magnifier()
146 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
147   mDefaultCameraDistance(1000.f),
148   mActorSize(Vector3::ZERO),
149   mMagnificationFactor(1.0f)
150 {
151 }
152
153 void Magnifier::SetSourceActor(Actor actor)
154 {
155   mTask.SetSourceActor( actor );
156 }
157
158 void Magnifier::Initialize()
159 {
160   Actor self = Self();
161   Vector2 stageSize(Stage::GetCurrent().GetSize());
162
163   // NOTE:
164   // sourceActor is a dummy delegate actor that takes the source property position,
165   // and generates a WORLD_POSITION, which is 1 frame behind the source property.
166   // This way the constraints for determining the camera position (source) and those
167   // for determining viewport position use the same 1 frame old values.
168   // A simple i) CameraPos = f(B), ii) B = f(A) set of constraints wont suffice as
169   // although CameraPos will use B, which is A's previous value. The constraint will
170   // not realise that B is still dirty as far as constraint (i) is concerned.
171   // Perhaps this is a bug in the way the constraint system factors into what is dirty
172   // and what is not.
173   mSourceActor = Actor::New();
174   Stage().GetCurrent().Add(mSourceActor);
175   mSourceActor.SetParentOrigin(ParentOrigin::CENTER);
176   Constraint constraint = Constraint::New<Vector3>( mSourceActor, Actor::Property::POSITION, EqualToConstraint() );
177   constraint.AddSource( Source( self, Toolkit::Magnifier::Property::SOURCE_POSITION ) );
178   constraint.Apply();
179
180   // create the render task this will render content on top of everything
181   // based on camera source position.
182   InitializeRenderTask();
183
184   // set up some constraints to:
185   // i) reposition (dest) frame actor based on magnifier actor's world position (this is 1 frame delayed)
186   // ii) reposition and resize (dest) the render task's viewport based on magnifier actor's world position (1 frame delayed) & size.
187   // iii) reposition (source) camera actor based on magnifier source actor's world position (this is 1 frame delayed)
188
189   // Apply constraint to camera's position
190   // Position our camera at the same distance from its target as the default camera is.
191   // The camera position doesn't affect how we render, just what we render (due to near and far clip planes)
192   // NOTE: We can't interrogate the default camera's position as it is not known initially (takes 1 frame
193   // for value to update).
194   // But we can determine the initial position using the same formula:
195   // distance = stage.height * 0.5 / tan(FOV * 0.5)
196
197   RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
198   RenderTask renderTask = taskList.GetTask(0u);
199   float fov = renderTask.GetCameraActor().GetFieldOfView();
200   mDefaultCameraDistance = (stageSize.height * 0.5f) / tanf(fov * 0.5f);
201
202   // Use a 1 frame delayed source position to determine the camera actor's position.
203   // This is necessary as the viewport is determined by the Magnifier's Actor's World position (which is computed
204   // at the end of the update cycle i.e. after constraints have been applied.)
205   //Property::Index propertySourcePositionDelayed = mCameraActor.RegisterProperty("delayedSourcePosition",   Vector3::ZERO);
206
207   constraint = Constraint::New<Vector3>( mCameraActor, Actor::Property::POSITION, CameraActorPositionConstraint(stageSize, mDefaultCameraDistance) );
208   constraint.AddSource( Source( mSourceActor, Actor::Property::WORLD_POSITION ) );
209   constraint.Apply();
210
211   // Apply constraint to render-task viewport position
212   constraint = Constraint::New<Vector2>( mTask, RenderTask::Property::VIEWPORT_POSITION, RenderTaskViewportPositionConstraint(stageSize) );
213   constraint.AddSource( Source( self, Actor::Property::WORLD_POSITION ) );
214   constraint.AddSource( Source( self, Actor::Property::SIZE ) );
215   constraint.AddSource( Source( self, Actor::Property::WORLD_SCALE ) );
216   constraint.Apply();
217
218   // Apply constraint to render-task viewport position
219   constraint = Constraint::New<Vector2>( mTask, RenderTask::Property::VIEWPORT_SIZE, RenderTaskViewportSizeConstraint() );
220   constraint.AddSource( Source( self, Actor::Property::SIZE ) );
221   constraint.AddSource( Source( self, Actor::Property::WORLD_SCALE ) );
222   constraint.Apply();
223 }
224
225 Magnifier::~Magnifier()
226 {
227
228 }
229
230 void Magnifier::InitializeRenderTask()
231 {
232   Stage stage = Stage::GetCurrent();
233
234   RenderTaskList taskList = stage.GetRenderTaskList();
235
236   mTask = taskList.CreateTask();
237   mTask.SetInputEnabled(false);
238   mTask.SetClearColor(Vector4(0.5f, 0.5f, 0.5f, 1.0f));
239   mTask.SetClearEnabled(true);
240
241   mCameraActor = CameraActor::New();
242   mCameraActor.SetType(Camera::FREE_LOOK);
243
244   stage.Add(mCameraActor);
245   mTask.SetCameraActor( mCameraActor );
246
247   SetFrameVisibility(true);
248 }
249
250 bool Magnifier::GetFrameVisibility() const
251 {
252   return mFrame;
253 }
254
255 void Magnifier::SetFrameVisibility(bool visible)
256 {
257   if(visible && !mFrame)
258   {
259     Actor self(Self());
260
261     mFrame = Actor::New( );
262     mFrame.SetInheritPosition(false);
263     mFrame.SetInheritScale(true);
264     mFrame.SetResizePolicy( ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT, Dimension::ALL_DIMENSIONS );
265     Vector3 sizeOffset(IMAGE_BORDER_INDENT*2.f - 2.f, IMAGE_BORDER_INDENT*2.f - 2.f, 0.0f);
266     mFrame.SetSizeModeFactor( sizeOffset );
267
268     Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
269
270     Property::Map map;
271     map[ Toolkit::Visual::Property::TYPE ] = Toolkit::Visual::BORDER;
272     map[ Toolkit::BorderVisual::Property::COLOR ] = Color::WHITE;
273     map[ Toolkit::BorderVisual::Property::SIZE   ] = IMAGE_BORDER_INDENT;
274     Toolkit::Visual::Base borderVisual = visualFactory.CreateVisual( map );
275     Toolkit::GetImplementation(borderVisual).SetOnStage( mFrame );
276
277     Constraint constraint = Constraint::New<Vector3>( mFrame, Actor::Property::POSITION, EqualToConstraint() );
278     constraint.AddSource( ParentSource( Actor::Property::WORLD_POSITION ) );
279     constraint.Apply();
280
281     self.Add(mFrame);
282   }
283   else if(!visible && mFrame)
284   {
285     UnparentAndReset(mFrame);
286   }
287 }
288
289 void Magnifier::OnSizeSet(const Vector3& targetSize)
290 {
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;
297   Update();
298
299   Control::OnSizeSet( targetSize );
300 }
301
302 float Magnifier::GetMagnificationFactor() const
303 {
304   return mMagnificationFactor;
305 }
306
307 void Magnifier::SetMagnificationFactor(float value)
308 {
309   mMagnificationFactor = value;
310   Update();
311 }
312
313 void Magnifier::Update()
314 {
315   // TODO: Make Camera settings (fieldofview/aspectratio) as animatable constraints.
316
317   // should be updated when:
318   // Magnifier's world size/scale changes.
319   Actor self(Self());
320   Vector3 worldSize = mActorSize * self.GetCurrentWorldScale();
321
322   // Adjust field of view to scale content
323
324   // size.height / 2
325   // |------/
326   // |d    /
327   // |i   /
328   // |s  /
329   // |t /
330   // |./
331   // |/ <--- fov/2 radians.
332   //
333   const float fov = atanf( 0.5f * worldSize.height / mDefaultCameraDistance / mMagnificationFactor) * 2.0f;
334   mCameraActor.SetFieldOfView( fov );
335
336   // Adjust aspect ratio to compensate for rectangular viewports.
337   mCameraActor.SetAspectRatio( worldSize.width / worldSize.height );
338 }
339
340 void Magnifier::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
341 {
342   Toolkit::Magnifier magnifier = Toolkit::Magnifier::DownCast( Dali::BaseHandle( object ) );
343
344   if( magnifier )
345   {
346     Magnifier& magnifierImpl( GetImpl( magnifier ) );
347     switch( index )
348     {
349       case Toolkit::Magnifier::Property::FRAME_VISIBILITY:
350       {
351         magnifierImpl.SetFrameVisibility( value.Get< bool >() );
352         break;
353       }
354       case Toolkit::Magnifier::Property::MAGNIFICATION_FACTOR:
355       {
356         magnifierImpl.SetMagnificationFactor( value.Get< float >() );
357         break;
358       }
359     }
360   }
361 }
362
363 Property::Value Magnifier::GetProperty( BaseObject* object, Property::Index index )
364 {
365   Property::Value value;
366
367   Toolkit::Magnifier magnifier = Toolkit::Magnifier::DownCast( Dali::BaseHandle( object ) );
368
369   if( magnifier )
370   {
371     Magnifier& magnifierImpl( GetImpl( magnifier ) );
372     switch( index )
373     {
374       case Toolkit::Magnifier::Property::FRAME_VISIBILITY:
375       {
376         value = magnifierImpl.GetFrameVisibility();
377         break;
378       }
379       case Toolkit::Magnifier::Property::MAGNIFICATION_FACTOR:
380       {
381         value = magnifierImpl.GetMagnificationFactor();
382         break;
383       }
384     }
385   }
386
387   return value;
388 }
389
390 } // namespace Internal
391
392 } // namespace Toolkit
393
394 } // namespace Dali