1 #ifndef __DALI_TOOLKIT_IMAGE_VIEW_H__
2 #define __DALI_TOOLKIT_IMAGE_VIEW_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-toolkit/public-api/controls/control.h>
24 namespace Dali DALI_IMPORT_API
30 namespace Internal DALI_INTERNAL
38 * ImageView control loads and displays the correct
39 * image for the current level of detail (LOD) required.
40 * LOD is typically calculated from the Camera distance.
44 * ImageView imageView = ImageView::New();
45 * imageView.SetCameraActor( mCamera );
46 * imageView.SetSize( Vector2(64.0f, 64.0f) );
47 * imageView.SetImage( "my-image.png", ImageView::BitmapType, 0.125f, 4.0f );
48 * layer.Add(imageView);
50 * The above creates an ImageView at 64x64 in size. Images of 12.5% the size up
51 * to 400% the size of imageView are created
52 * i.e. 8x8, 16x16, 32x32, 64x64, 128x128, and 256x256
54 * based on the distance imageView is from mCamera an appropriate, different
55 * image will be loaded and dispayed.
57 class ImageView : public Control
62 * Image Types, determines how image should be rendered.
66 BitmapType, ///< Standard Bitmap image
67 DistanceFieldType ///< Distance Field encoded image
70 static const std::string DETAIL_PROPERTY_NAME; ///< The level of detail property
75 * Creates an empty ImageView handle
80 * Copy constructor. Creates another handle that points to the same real object
81 * @param handle to copy from
83 ImageView( const ImageView& handle );
86 * Assignment operator. Changes this handle to point to another real object
88 ImageView& operator=( const ImageView& handle );
92 * Dali::Object derived classes typically do not contain member data.
97 * Create the Poup control
98 * @return A handle to the ImageView control.
100 static ImageView New();
103 * Downcast an Object handle to ImageView. If handle points to an ImageView the
104 * downcast produces valid handle. If not the returned handle is left uninitialized.
105 * @param[in] handle Handle to an object
106 * @return handle to a ImageView or an uninitialized handle
108 static ImageView DownCast( BaseHandle handle );
113 * Load image into ImageView for level of detail scaling.
114 * Will automatically create different sized versions
115 * of the source image.
117 * @param[in] filename The image path to load
118 * @param[in] type The type of image e.g. BitmapType or DistanceFieldType
120 void SetImage(const std::string& filename, ImageType type);
123 * Load image into ImageView for level of detail scaling.
124 * The minimum scale is a percentage of the size of the
125 * image view, and represents the smallest version of the
126 * source image to display e.g. 0.125 for 12.5%
127 * While the maximum scale represents the largest version of
128 * the source image to display e.g. 1.00 for 100% (original
131 * @note ImageView SetSize must be set specified prior to
134 * @param[in] filename The image path to load
135 * @param[in] type The type of image e.g. BitmapImage or DistanceFieldImage
136 * @param[in] min The minimum scale detail to load.
137 * @param[in] max The maximum scale detail to load.
139 void SetImage(const std::string& filename, ImageType type, float min, float max);
142 * Sets an image to displayed for the entire detail range.
143 * Regardless of the detail level this image will be displayed.
145 * @param[in] image The image to display
147 void SetImage(Image image);
150 * Sets the camera to use for determining level of detail.
151 * Which is based on distance from camera to this ImageView.
152 * The detailFactor is the distance at which the ImageView
153 * should appear at 100% scale. Which may differ based on
154 * Projection, and ShaderEffect settings.
155 * @param[in] camera The camera
157 void SetCameraActor(CameraActor camera);
160 * Sets the camera to use for determining level of detail.
161 * Which is based on distance from camera to this ImageView.
162 * The detailFactor is the distance at which the ImageView
163 * should appear at 100% scale. Which may differ based on
164 * Projection, and ShaderEffect settings.
165 * @param[in] camera The camera
166 * @param[in] detailFactor The Camera distance where detail should be 1.0
167 * (ImageView should appear at 100% scale)
169 void SetCameraActor(CameraActor camera, float detailFactor);
172 * Sets the current detail level.
173 * @note This sets the detail property value.
174 * @param[in] detail The level of detail to be viewed at.
176 void SetDetail(float detail);
178 public: // Not intended for application developers
181 * Creates a handle using the Toolkit::Internal implementation.
182 * @param[in] implementation The Control implementation.
184 ImageView(Internal::ImageView& implementation);
187 * Allows the creation of this Control from an Internal::CustomActor pointer.
188 * @param[in] internal A pointer to the internal CustomActor.
190 ImageView(Dali::Internal::CustomActor* internal);
193 } // namespace Toolkit
197 #endif // __DALI_TOOLKIT_IMAGE_VIEW_H__