#define DALI_TOOLKIT_INTERNAL_VISUAL_H
/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <dali-toolkit/internal/visuals/visual-factory-cache.h>
#include <dali-toolkit/devel-api/direction-enums.h>
#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
namespace Dali
{
namespace Visual
{
-class ResourceObserver;
+class EventObserver;
+
+using FittingMode = DevelVisual::FittingMode;
/**
* Base class for all Control rendering logic. A control may have multiple visuals.
/**
* @copydoc Toolkit::Visual::Base::GetName
*/
- const std::string& GetName();
+ const std::string& GetName() const;
/**
* @copydoc Toolkit::Visual::Base::SetSize
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
bool IsPreMultipliedAlphaEnabled() const;
/**
+ * @brief Query whether advanced blend equation is applied.
+ *
+ * @return True is advanced blend equation is applied, false otherwise.
+ */
+ bool IsAdvancedBlendEquationApplied() const;
+
+ /**
* @brief Sets properties of custom shader
* @param[in] propertyMap Property map containing the custom shader data
*/
* If the visual isn't staged (i.e. it doesn't have a renderer),
* then this will not add an animation.
*
+ * If the animator is valid and the transition handle is empty - it will
+ * be created.
+ *
* @param[in] transition The animation to create or attach to
* @param[in] animator The animation parameters of the 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
*/
Toolkit::Visual::ResourceStatus GetResourceStatus() const;
-protected:
+ /**
+ * @brief Get the fitting mode for the visual
+ */
+ FittingMode GetFittingMode() const;
+
+ /**
+ * @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;
+
+ 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 );
+ 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.
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 the scene, false if it is off the scene
+ */
+ bool IsOnScene() const;
+
+ /**
+ * @brief Query whether the corners of the visual requires to be rounded.
*
- * @return Returns true if this Visual is on stage, false if it is off the stage
+ * @return Returns true if the rounded corner is required, false otherwise.
*/
- bool IsOnStage() const;
+ bool IsRoundedCornerRequired() const;
private:
projects / platform / core / uifw / dali-toolkit.git / blobdiff