dali-toolkit/internal/controls/image-view/image-view-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
   2 #define __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/property-map.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/controls/renderers/image/image-visual.h>
  26 #include <dali-toolkit/public-api/controls/control-impl.h>
  27 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 class ImageView;
  36
  37 namespace Internal
  38 {
  39 class ImageView : public Control
  40 {
  41 protected:
  42
  43   /**
  44    * Construct a new ImageView.
  45    */
  46   ImageView();
  47
  48   /**
  49    * A reference counted object may only be deleted by calling Unreference()
  50    */
  51   virtual ~ImageView();
  52
  53 public:
  54   /**
  55    * Create a new ImageView.
  56    * @return A smart-pointer to the newly allocated ImageView.
  57    */
  58   static Toolkit::ImageView New();
  59
  60   /**
  61    * @copydoc Dali::Toolkit::SetImage
  62    */
  63   void SetImage( Image image );
  64
  65   /**
  66    * @brief Sets this ImageView from an Dali::Property::Map
  67    *
  68    * If the handle is empty, ImageView will display nothing
  69    * @param[in] map The Dali::Property::Map to use for to display.
  70    */
  71   void SetImage( Dali::Property::Map map );
  72
  73   /**
  74    * @copydoc Dali::Toolkit::SetImage
  75    */
  76   void SetImage( const std::string& imageUrl, ImageDimensions size );
  77
  78   /**
  79    * @copydoc Dali::Toolkit::GetImage
  80    */
  81   Image GetImage() const;
  82
  83   /**
  84    * @brief Set whether the Pre-multiplied Alpha Blending is required
  85    *
  86    * @param[in] preMultipled whether alpha is pre-multiplied.
  87    */
  88   void EnablePreMultipliedAlpha( bool preMultipled );
  89
  90   /**
  91    * @brief Query whether alpha is pre-multiplied.
  92    *
  93    * @return True is alpha is pre-multiplied, false otherwise.
  94    */
  95   bool IsPreMultipliedAlphaEnabled() const;
  96
  97   // Properties
  98   /**
  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.
 103    */
 104   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 105
 106   /**
 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.
 111    */
 112   static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
 113
 114   /**
 115    * @brief Set the depth index of this image renderer
 116    *
 117    * Renderer with higher depth indices are rendered in front of other renderers with smaller values
 118    *
 119    * @param[in] depthIndex The depth index of this renderer
 120    */
 121   void SetDepthIndex( int depthIndex );
 122
 123 private: // From Control
 124
 125   /**
 126    * @copydoc Toolkit::Control::OnStageConnect()
 127    */
 128   virtual void OnStageConnection( int depth );
 129
 130   /**
 131    * @copydoc Toolkit::Control::OnStageDisconnection()
 132    */
 133   virtual void OnStageDisconnection();
 134
 135   /**
 136    * @copydoc Toolkit::Control::OnSizeSet()
 137    */
 138   virtual void OnSizeSet( const Vector3& targetSize );
 139
 140   /**
 141    * @copydoc Toolkit::Control::GetNaturalSize
 142    */
 143   virtual Vector3 GetNaturalSize();
 144
 145   /**
 146    * @copydoc Toolkit::Control::GetHeightForWidth()
 147    */
 148   virtual float GetHeightForWidth( float width );
 149
 150   /**
 151    * @copydoc Toolkit::Control::GetWidthForHeight()
 152    */
 153   virtual float GetWidthForHeight( float height );
 154
 155 private:
 156   // Undefined
 157   ImageView( const ImageView& );
 158   ImageView& operator=( const ImageView& );
 159
 160 private:
 161   Toolkit::Visual  mRenderer;
 162   ImageDimensions  mImageSize;
 163   Vector2 mSizeSet;
 164
 165   std::string      mUrl;          ///< the url for the image if the image came from a URL, empty otherwise
 166   Image            mImage;        ///< the Image if the image came from a Image, null otherwise
 167   Property::Map    mPropertyMap;  ///< the Property::Map if the image came from a Property::Map, empty otherwise
 168 };
 169
 170 } // namespace Internal
 171
 172 // Helpers for public-api forwarding methods
 173 inline Toolkit::Internal::ImageView& GetImpl( Toolkit::ImageView& obj )
 174 {
 175   DALI_ASSERT_ALWAYS(obj);
 176   Dali::RefObject& handle = obj.GetImplementation();
 177   return static_cast<Toolkit::Internal::ImageView&>(handle);
 178 }
 179
 180 inline const Toolkit::Internal::ImageView& GetImpl( const Toolkit::ImageView& obj )
 181 {
 182   DALI_ASSERT_ALWAYS(obj);
 183   const Dali::RefObject& handle = obj.GetImplementation();
 184   return static_cast<const Toolkit::Internal::ImageView&>(handle);
 185 }
 186
 187 } // namespace Toolkit
 188
 189 } // namespace Dali
 190
 191 #endif // __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__