namespace Visual
{
-class ResourceObserver;
+class EventObserver;
using FittingMode = DevelVisual::FittingMode;
int GetDepthIndex() const;
/**
- * @copydoc Toolkit::Visual::Base::SetOnStage
+ * @copydoc Toolkit::Visual::Base::SetOnScene
* @pre Impl->mGeometry must be created before this method is called
*/
- void SetOnStage( Actor& actor );
+ void SetOnScene( Actor& actor );
/**
- * @copydoc Toolkit::Visual::Base::SetOffStage
+ * @copydoc Toolkit::Visual::Base::SetOffScene
*/
- void SetOffStage( Actor& actor );
+ void SetOffScene( Actor& actor );
/**
* @copydoc Toolkit::Visual::Base::CreatePropertyMap
void SetMixColor( const Vector3& color );
/**
- * Gets the mix color of the visual.
- * @return The mix color
- */
- const Vector4& GetMixColor() const;
-
- /**
* Animate the property if it exists in the visual or renderer.
*
* If it's a visual property such as mix color or a transform property,
Internal::TransitionData::Animator& animator );
/**
- * @brief Add an observer to watch for when the Visuals resources are loaded.
+ * @brief Add an observer to watch for when the Visuals have events to notify
* Currently only supports a single observer
- *
*/
- void AddResourceObserver( Visual::ResourceObserver& observer );
+ void AddEventObserver( Visual::EventObserver& observer );
/**
* @brief Remove an observer
*/
- void RemoveResourceObserver( Visual::ResourceObserver& observer );
+ void RemoveEventObserver( Visual::EventObserver& observer );
/**
* @brief Called when the visuals resources are loaded / ready
*/
FittingMode GetFittingMode() const;
- protected:
+ /**
+ * @brief Get the actual Visual Object.
+ * @return The actual visual object
+ * @note Should be overridden by deriving controls if they are acting as a proxy to other visual objects.
+ */
+ virtual Base& GetVisualObject();
+
+ /**
+ * @brief Query whether resources requires to be loaded synchronously.
+ * @return Returns true if synchronous resource loading is required, false otherwise.
+ */
+ bool IsSynchronousLoadingRequired() const;
+
+ /**
+ * @brief Get the type of this visual.
+ *
+ * @return The the type of this visual.
+ */
+ Toolkit::Visual::Type GetType() const;
/**
+ * @brief Retrieve the property object associated with the property key.
+ *
+ * @param[in] key The Property key of the visual.
+ * @return The Property object
+ */
+ Dali::Property GetPropertyObject(Dali::Property::Key key);
+
+protected:
+ /**
* @brief Constructor.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] fittingMode The value that determines how the visual should be fit to the view
+ * @param[in] type The type of the this visual
*/
- Base( VisualFactoryCache& factoryCache, FittingMode fittingMode );
+ Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type );
/**
* @brief A reference counted object may only be deleted by calling Unreference().
*/
- virtual ~Base();
+ ~Base() override;
protected:
virtual void OnSetTransform() = 0;
/**
- * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
+ * @brief Called by SetOnScene() allowing sub classes to respond to the SetOnScene event
*
* @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
*
* @param[in] actor The actor applying this visual.
*/
- virtual void DoSetOnStage( Actor& actor ) = 0;
+ virtual void DoSetOnScene( Actor& actor ) = 0;
/**
- * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
+ * @brief Called by SetOffScene() allowing sub classes to respond to the SetOffScene event
*
* @param[in] actor The actor applying this visual.
*/
- virtual void DoSetOffStage( Actor& actor );
+ virtual void DoSetOffScene( Actor& actor );
/**
* @brief Called by DoAction() allowing sub classes to do the given action.
*/
virtual void OnDoAction( const Property::Index actionId, const Property::Value& attributes );
+ /**
+ * @brief Update the shader when some properties are changed.
+ */
+ virtual void UpdateShader()
+ {
+ }
+
+ /**
+ * @brief Called by GetPropertyObject() allowing sub classes to respond to the GetPropertyObject event
+ * @note The derived class is required to register the given property.
+ * @param[in] key The key of the visual's property.
+ * @return The Property object
+ */
+ virtual Dali::Property OnGetPropertyObject(Dali::Property::Key key)
+ {
+ Handle handle;
+ return Dali::Property(handle, Property::INVALID_INDEX);
+ }
+
protected:
/**
- * @brief Gets the on stage state for this Visual
+ * @brief Gets the on scene state for this Visual
*
- * @return Returns true if this Visual is on stage, false if it is off the stage
+ * @return Returns true if this Visual is on the scene, false if it is off the scene
*/
- bool IsOnStage() const;
+ bool IsOnScene() const;
+
+ /**
+ * @brief Query whether the corners of the visual requires to be rounded.
+ *
+ * @return Returns true if the rounded corner is required, false otherwise.
+ */
+ bool IsRoundedCornerRequired() const;
private:
void AnimateMixColorProperty( Dali::Animation& transition,
Internal::TransitionData::Animator& animator );
- /**
- * Set up the right blend mode if the opacity is being animated.
- * Also ensure that when the animation finishes, the blend mode is
- * set to the appropriate value. It also uses the target value as
- * set into mMixColor.
- *
- * @param[in] transition The transition to listen to
- * @param[in] isInitialOpaque Whether the initial value is opaque
- * @param[in] animating If the transition animates the value.
- */
- void SetupBlendMode( Dali::Animation& transition,
- bool isInitialOpaque, bool animating );
-
- /**
- * When a mix color animation has finished, ensure the blend mode is set back
- * to the right value for the target opacity.
- */
- void OnMixColorFinished( Animation& animation );
-
// Undefined
Base( const Visual::Base& visual );
projects / platform / core / uifw / dali-toolkit.git / blobdiff