#include <dali/devel-api/object/weak-handle.h>
// INTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/visual-base-impl.h>
#include <dali-toolkit/devel-api/image-loader/atlas-upload-observer.h>
+#include <dali-toolkit/internal/visuals/texture-upload-observer.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
+#include <dali-toolkit/internal/visuals/visual-url.h>
namespace Dali
{
typedef IntrusivePtr< ImageVisual > ImageVisualPtr;
/**
- * The visual which renders an image to the control's quad
+ * The visual which renders an image to a quad geometry
*
* The following properties are optional
*
- * | %Property Name | Type |
- * |--------------------|------------------|
- * | url | STRING |
- * | fittingMode | STRING |
- * | samplingMode | STRING |
- * | desiredWidth | INT |
- * | desiredHeight | INT |
- * | synchronousLoading | BOOLEAN |
+ * | %Property Name | Type |
+ * |--------------------|-------------------|
+ * | url | STRING |
+ * | alphaMaskUrl | STRING |
+ * | fittingMode | INTEGER OR STRING |
+ * | samplingMode | INTEGER OR STRING |
+ * | desiredWidth | INTEGER |
+ * | desiredHeight | INTEGER |
+ * | synchronousLoading | BOOLEAN |
+ * | pixelArea | VECTOR4 |
+ * | wrapModeU | INTEGER OR STRING |
+ * | wrapModeV | INTEGER OR STRING |
+ *
+ * where pixelArea is a rectangular area.
+ * In its Vector4 value, the first two elements indicate the top-left position of the area,
+ * and the last two elements are the area width and height respectively.
+ * If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image.
+ *
+ * where wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.
+ * Its value should be one of the following wrap mode:
+ * "DEFAULT"
+ * "CLAMP_TO_EDGE"
+ * "REPEAT"
+ * "MIRRORED_REPEAT"
*
* where imageFittingMode should be one of the following fitting modes:
* "SHRINK_TO_FIT"
* "DONT_CARE"
* "DEFAULT"
*
+ *
+ * If the Visual is in a LayerUI it will pixel align the image, using a Layer3D will disable pixel alignment.
+ * Changing layer behaviour between LayerUI to Layer3D whilst the visual is already staged will not have an effect.
*/
-class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver
+class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver, public TextureUploadObserver
{
public:
* @return A smart-pointer to the newly allocated visual.
*/
static ImageVisualPtr New( VisualFactoryCache& factoryCache,
- const std::string& imageUrl,
+ const VisualUrl& imageUrl,
const Property::Map& properties,
ImageDimensions size = ImageDimensions(),
FittingMode::Type fittingMode = FittingMode::DEFAULT,
* @return A smart-pointer to the newly allocated visual.
*/
static ImageVisualPtr New( VisualFactoryCache& factoryCache,
- const std::string& imageUrl,
+ const VisualUrl& imageUrl,
ImageDimensions size = ImageDimensions(),
FittingMode::Type fittingMode = FittingMode::DEFAULT,
Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
*/
virtual void DoCreatePropertyMap( Property::Map& map ) const;
+ /**
+ * @copydoc Visual::Base::CreateInstancePropertyMap
+ */
+ virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
+
protected:
/**
* @param[in] samplingMode The SamplingMode of the resource to load
*/
ImageVisual( VisualFactoryCache& factoryCache,
- const std::string& imageUrl,
+ const VisualUrl& imageUrl,
ImageDimensions size,
FittingMode::Type fittingMode,
Dali::SamplingMode::Type samplingMode );
*/
virtual void UploadCompleted();
+ /**
+ * @copydoc TextureUploadObserver::UploadCompleted
+ *
+ * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
+ * This callback is the place to add the renderer as it would be called once the loading is finished.
+ */
+ virtual void UploadComplete( bool success, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle );
+
private:
/**
void ApplyImageToSampler( const Image& image );
/**
- * @brief Initializes the Dali::Renderer from an image url string
- *
- * @param[in] imageUrl The image url string to intialize this ImageVisual from
+ * @brief Initializes the Dali::Renderer from the image url
*/
- void InitializeRenderer( const std::string& imageUrl );
+ void InitializeRenderer();
/**
* @brief Initializes the Dali::Renderer from an image handle
* @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture
* @return the texture set to use
*/
- TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing );
-
- /**
- * Callback function of image resource loading succeed
- * @param[in] image The Image content that we attempted to load from mImageUrl
- */
- void OnImageLoaded( ResourceImage image );
+ TextureSet CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing );
/**
* Set the value to the uTextureRect uniform
void SetTextureRectUniform( const Vector4& textureRect );
/**
- * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
+ * Remove the texture if it is not used anymore.
+ */
+ void RemoveTexture(const std::string& url);
+
+ /**
+ * Helper method to set individual values by index key.
+ * @param[in] index The index key of the value
+ * @param[in] value The value
*/
- void CleanCache(const std::string& url);
+ void DoSetProperty( Property::Index index, const Property::Value& value );
private:
PixelData mPixels;
Vector4 mPixelArea;
WeakHandle<Actor> mPlacementActor;
- std::string mImageUrl;
+ VisualUrl mImageUrl;
+ VisualUrl mAlphaMaskUrl;
Dali::ImageDimensions mDesiredSize;
+ TextureManager::TextureId mTextureId;
+ TextureManager::TextureId mAlphaMaskId;
+
Dali::FittingMode::Type mFittingMode:3;
Dali::SamplingMode::Type mSamplingMode:4;
Dali::WrapMode::Type mWrapModeU:3;
Dali::WrapMode::Type mWrapModeV:3;
-
+ bool mAttemptAtlasing:1; ///< If true will attempt atlasing, otherwise create unique texture
+ bool mTextureLoading:1; ///< True if the texture is being loaded asynchronously, or false when it has loaded.
};
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff