1 #ifndef __DALI_TOOLKIT_INTERNAL_MAGNIFIER_H__
2 #define __DALI_TOOLKIT_INTERNAL_MAGNIFIER_H__
5 * Copyright (c) 2014 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/actors/camera-actor.h>
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/public-api/render-tasks/render-task.h>
25 #include <dali/public-api/actors/image-actor.h>
28 #include <dali-toolkit/public-api/controls/control-impl.h>
29 #include <dali-toolkit/devel-api/controls/magnifier/magnifier.h>
42 typedef IntrusivePtr<Magnifier> MagnifierPtr;
45 * @copydoc Toolkit::Magnifier
47 class Magnifier : public Control
52 * Create a new Magnifier.
53 * @return A public handle to the newly allocated Magnifier.
55 static Dali::Toolkit::Magnifier New();
60 * @copydoc Toolkit::ImageView::SetSourceActor
62 void SetSourceActor(Actor actor);
65 * Returns whether the frame is visible or not.
66 * @return true if frame is visible, false if not.
68 bool GetFrameVisibility() const;
71 * Sets whether the frame part of the magnifier should be visible or not.
72 * @param[in] visible true to display frame, false to hide frame.
74 void SetFrameVisibility(bool visible);
77 * Get the magnification factor of the magnifier
78 * The larger the value the larger the contents magnified.
79 * A value of 1.0f indications 1x magnification.
80 * @return Magnification factor is returned
82 float GetMagnificationFactor() const;
85 * Set the magnification factor of the magnifier
86 * The larger the value the larger the contents magnified.
87 * A value of 1.0f indications 1x magnification.
88 * @param[in] value Magnification factor.
90 void SetMagnificationFactor(float value);
93 * Update magnification
100 * Called when a property of an object of this type is set.
101 * @param[in] object The object whose property is set.
102 * @param[in] index The property index.
103 * @param[in] value The new property value.
105 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
108 * Called to retrieve a property of an object of this type.
109 * @param[in] object The object whose property is to be retrieved.
110 * @param[in] index The property index.
111 * @return The current value of the property.
113 static Property::Value GetProperty( BaseObject* object, Property::Index index );
118 * Construct a new Magnifier.
123 * 2nd-phase initialization.
128 * A reference counted object may only be deleted by calling Unreference()
130 virtual ~Magnifier();
135 * Initializes the render task required to render contents.
137 void InitializeRenderTask();
141 virtual void OnSizeSet(const Vector3& targetSize);
146 Magnifier(const Magnifier&);
149 Magnifier& operator=(const Magnifier& rhs);
153 RenderTask mTask; ///< Render Task to render the source actor contents.
154 CameraActor mCameraActor; ///< CameraActor attached to RenderTask
155 ImageActor mFrame; ///< The Magnifier Frame
156 Actor mSourceActor; ///< Source Delegate Actor represents the source position to read.
157 float mDefaultCameraDistance; ///< Default RenderTask's camera distance from target.
158 Vector3 mActorSize; ///< The Actor size
159 float mMagnificationFactor; ///< Magnification factor 1.0f is default. same as content.
162 } // namespace Internal
164 // Helpers for public-api forwarding methods
166 inline Toolkit::Internal::Magnifier& GetImpl(Toolkit::Magnifier& pub)
168 DALI_ASSERT_ALWAYS(pub);
170 Dali::RefObject& handle = pub.GetImplementation();
172 return static_cast<Toolkit::Internal::Magnifier&>(handle);
175 inline const Toolkit::Internal::Magnifier& GetImpl(const Toolkit::Magnifier& pub)
177 DALI_ASSERT_ALWAYS(pub);
179 const Dali::RefObject& handle = pub.GetImplementation();
181 return static_cast<const Toolkit::Internal::Magnifier&>(handle);
184 } // namespace Toolkit
188 #endif // __DALI_TOOLKIT_INTERNAL_MAGNIFIER_H__