dali-toolkit/internal/visuals/wireframe/wireframe-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2016 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/common/intrusive-ptr.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Internal
  34 {
  35
  36 class WireframeVisual;
  37 typedef IntrusivePtr< WireframeVisual > WireframeVisualPtr;
  38
  39 /**
  40  * @brief Renders a wireframe outline to the control's quad.
  41  */
  42 class WireframeVisual: public Visual::Base
  43 {
  44 public:
  45
  46   /**
  47    * @brief Create a new wireframe visual.
  48    *
  49    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  50    * @param[in] properties A Property::Map containing settings for this visual
  51    * @return A smart-pointer to the newly allocated visual.
  52    */
  53   static WireframeVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
  54
  55   /**
  56    * @brief Create a new wireframe visual with an encapsulated actual visual.
  57    *
  58    * For debugging purpose, the rendering of the encapsulated visual is replaced with wireframe
  59    *
  60    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  61    * @param[in] actualVisual The encapsulated actual visual.
  62    * @return A smart-pointer to the newly allocated visual.
  63    */
  64   static WireframeVisualPtr New( VisualFactoryCache& factoryCache, Visual::BasePtr actualVisual );
  65
  66   /**
  67    * @brief Create a new wireframe visual with an encapsulated actual visual.
  68    *
  69    * For debugging purpose, the rendering of the encapsulated visual is replaced with wireframe
  70    *
  71    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  72    * @param[in] actualVisual The encapsulated actual visual.
  73    * @param[in] properties A Property::Map containing settings for this visual
  74    * @return A smart-pointer to the newly allocated visual.
  75    */
  76   static WireframeVisualPtr New( VisualFactoryCache& factoryCache, Visual::BasePtr actualVisual, const Property::Map& properties );
  77
  78
  79 protected:
  80
  81   /**
  82    * @brief Constructor.
  83    *
  84    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  85    * @param[in] actualVisual The encapsulated actual visual.
  86    */
  87   WireframeVisual( VisualFactoryCache& factoryCache, Visual::BasePtr actualVisual );
  88
  89   /**
  90    * @brief A reference counted object may only be deleted by calling Unreference().
  91    */
  92   virtual ~WireframeVisual();
  93
  94 protected: // from Visual::Base
  95
  96   /**
  97    * @copydoc Visual::Base::GetHeightForWidth()
  98    */
  99   virtual float GetHeightForWidth( float width );
 100
 101   /**
 102    * @copydoc Visual::Base::GetNaturalSize()
 103    */
 104   virtual void GetNaturalSize( Vector2& naturalSize );
 105
 106   /**
 107    * @copydoc Visual::Base::CreatePropertyMap()
 108    */
 109   virtual void DoCreatePropertyMap( Property::Map& map ) const;
 110
 111   /**
 112    * @copydoc Visual::Base::DoSetProperties()
 113    */
 114   virtual void DoSetProperties( const Property::Map& propertyMap );
 115
 116   /**
 117    * @copydoc Visual::Base::DoSetOnStage
 118    */
 119   virtual void DoSetOnStage( Actor& actor );
 120
 121   /**
 122    * @copydoc Visual::Base::OnSetTransform
 123    */
 124   virtual void OnSetTransform();
 125
 126 private:
 127   /**
 128    * Create the geometry which presents the quad wireframe.
 129    * @return The border geometry
 130    */
 131   Geometry CreateQuadWireframeGeometry();
 132
 133   /**
 134    * @brief Initialise the renderer from the cache, if not available, create and save to the cache for sharing.
 135    */
 136   void InitializeRenderer();
 137
 138   // Undefined
 139   WireframeVisual( const WireframeVisual& visual);
 140
 141   // Undefined
 142   WireframeVisual& operator=( const WireframeVisual& visual );
 143
 144 private:
 145
 146   Visual::BasePtr mActualVisual;
 147
 148 };
 149
 150 } // namespace Internal
 151
 152 } // namespace Toolkit
 153
 154 } // namespace Dali
 155
 156 #endif // DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H