#define DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
class WireframeVisual;
-typedef IntrusivePtr< WireframeVisual > WireframeVisualPtr;
+typedef IntrusivePtr<WireframeVisual> WireframeVisualPtr;
/**
* @brief Renders a wireframe outline to the control's quad.
*/
-class WireframeVisual: public Visual::Base
+class WireframeVisual : public Visual::Base
{
public:
-
/**
* @brief Create a new wireframe visual.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] properties A Property::Map containing settings for this visual
* @return A smart-pointer to the newly allocated visual.
*/
- static WireframeVisualPtr New( VisualFactoryCache& factoryCache );
+ static WireframeVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
-protected:
+ /**
+ * @brief Create a new wireframe visual with an encapsulated actual visual.
+ *
+ * For debugging purpose, the rendering of the encapsulated visual is replaced with wireframe
+ *
+ * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] actualVisual The encapsulated actual visual.
+ * @return A smart-pointer to the newly allocated visual.
+ */
+ static WireframeVisualPtr New(VisualFactoryCache& factoryCache, Visual::BasePtr actualVisual);
/**
+ * @brief Create a new wireframe visual with an encapsulated actual visual.
+ *
+ * For debugging purpose, the rendering of the encapsulated visual is replaced with wireframe
+ *
+ * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] actualVisual The encapsulated actual visual.
+ * @param[in] properties A Property::Map containing settings for this visual
+ * @return A smart-pointer to the newly allocated visual.
+ */
+ static WireframeVisualPtr New(VisualFactoryCache& factoryCache, Visual::BasePtr actualVisual, const Property::Map& properties);
+
+protected:
+ /**
* @brief Constructor.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] actualVisual The encapsulated actual visual.
*/
- WireframeVisual( VisualFactoryCache& factoryCache );
+ WireframeVisual(VisualFactoryCache& factoryCache, Visual::BasePtr actualVisual);
/**
* @brief A reference counted object may only be deleted by calling Unreference().
*/
virtual ~WireframeVisual();
+protected: // from Visual::Base
/**
- * @copydoc Visual::Base::DoSetProperties()
+ * @copydoc Visual::Base::OnInitialize
*/
- virtual void DoSetProperties( const Property::Map& propertyMap );
+ void OnInitialize() override;
/**
- * @copydoc Visual::Base::DoSetOnStage
+ * @copydoc Visual::Base::GetHeightForWidth()
*/
- virtual void DoSetOnStage( Actor& actor );
+ float GetHeightForWidth(float width) override;
/**
- * @copydoc Visual::Base::CreatePropertyMap
+ * @copydoc Visual::Base::GetNaturalSize()
*/
- virtual void DoCreatePropertyMap( Property::Map& map ) const;
+ void GetNaturalSize(Vector2& naturalSize) override;
/**
- * @copydoc Visual::Base::OnSetTransform
+ * @copydoc Visual::Base::CreatePropertyMap()
*/
- virtual void OnSetTransform();
+ void DoCreatePropertyMap(Property::Map& map) const override;
-private:
/**
- * Create the geometry which presents the quad wireframe.
- * @return The border geometry
+ * @copydoc Visual::Base::CreateInstancePropertyMap
*/
- Geometry CreateQuadWireframeGeometry();
+ void DoCreateInstancePropertyMap(Property::Map& map) const override;
/**
- * @brief Initialise the renderer from the cache, if not available, create and save to the cache for sharing.
+ * @copydoc Visual::Base::DoSetProperties()
+ */
+ void DoSetProperties(const Property::Map& propertyMap) override;
+
+ /**
+ * @copydoc Visual::Base::DoSetOnScene
+ */
+ void DoSetOnScene(Actor& actor) override;
+
+ /**
+ * @copydoc Visual::Base::OnSetTransform
*/
- void InitializeRenderer();
+ void OnSetTransform() override;
+
+ /**
+ * @copydoc Visual::Base::GetVisualObject
+ *
+ * Overriding as this visual can sometimes act as a proxy to the actual visual, i.e. when using debug rendering.
+ */
+ Base& GetVisualObject() override;
private:
+ /**
+ * Create the geometry which presents the quad wireframe.
+ * @return The border geometry
+ */
+ Geometry CreateQuadWireframeGeometry();
// Undefined
- WireframeVisual( const WireframeVisual& visual);
+ WireframeVisual(const WireframeVisual& visual);
// Undefined
- WireframeVisual& operator=( const WireframeVisual& visual );
+ WireframeVisual& operator=(const WireframeVisual& visual);
+private:
+ Visual::BasePtr mActualVisual;
};
} // namespace Internal