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>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/devel-api/controls/magnifier/magnifier.h>
41 typedef IntrusivePtr<Magnifier> MagnifierPtr;
44 * @copydoc Toolkit::Magnifier
46 class Magnifier : public Control
51 * Create a new Magnifier.
52 * @return A public handle to the newly allocated Magnifier.
54 static Dali::Toolkit::Magnifier New();
59 * @copydoc Toolkit::ImageView::SetSourceActor
61 void SetSourceActor(Actor actor);
64 * Returns whether the frame is visible or not.
65 * @return true if frame is visible, false if not.
67 bool GetFrameVisibility() const;
70 * Sets whether the frame part of the magnifier should be visible or not.
71 * @param[in] visible true to display frame, false to hide frame.
73 void SetFrameVisibility(bool visible);
76 * Get the magnification factor of the magnifier
77 * The larger the value the larger the contents magnified.
78 * A value of 1.0f indications 1x magnification.
79 * @return Magnification factor is returned
81 float GetMagnificationFactor() const;
84 * Set the magnification factor of the magnifier
85 * The larger the value the larger the contents magnified.
86 * A value of 1.0f indications 1x magnification.
87 * @param[in] value Magnification factor.
89 void SetMagnificationFactor(float value);
92 * Update magnification
99 * Called when a property of an object of this type is set.
100 * @param[in] object The object whose property is set.
101 * @param[in] index The property index.
102 * @param[in] value The new property value.
104 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
107 * Called to retrieve a property of an object of this type.
108 * @param[in] object The object whose property is to be retrieved.
109 * @param[in] index The property index.
110 * @return The current value of the property.
112 static Property::Value GetProperty( BaseObject* object, Property::Index index );
117 * Construct a new Magnifier.
122 * 2nd-phase initialization.
127 * A reference counted object may only be deleted by calling Unreference()
129 virtual ~Magnifier();
134 * Initializes the render task required to render contents.
136 void InitializeRenderTask();
140 virtual void OnSizeSet(const Vector3& targetSize);
145 Magnifier(const Magnifier&);
148 Magnifier& operator=(const Magnifier& rhs);
152 RenderTask mTask; ///< Render Task to render the source actor contents.
153 CameraActor mCameraActor; ///< CameraActor attached to RenderTask
154 Actor mFrame; ///< The Magnifier Frame
155 Actor mSourceActor; ///< Source Delegate Actor represents the source position to read.
156 float mDefaultCameraDistance; ///< Default RenderTask's camera distance from target.
157 Vector3 mActorSize; ///< The Actor size
158 float mMagnificationFactor; ///< Magnification factor 1.0f is default. same as content.
161 } // namespace Internal
163 // Helpers for public-api forwarding methods
165 inline Toolkit::Internal::Magnifier& GetImpl(Toolkit::Magnifier& pub)
167 DALI_ASSERT_ALWAYS(pub);
169 Dali::RefObject& handle = pub.GetImplementation();
171 return static_cast<Toolkit::Internal::Magnifier&>(handle);
174 inline const Toolkit::Internal::Magnifier& GetImpl(const Toolkit::Magnifier& pub)
176 DALI_ASSERT_ALWAYS(pub);
178 const Dali::RefObject& handle = pub.GetImplementation();
180 return static_cast<const Toolkit::Internal::Magnifier&>(handle);
183 } // namespace Toolkit
187 #endif // __DALI_TOOLKIT_INTERNAL_MAGNIFIER_H__