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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal
  31 {
  32
  33 /**
  34  * The visual which renders a wireframe outline to the control's quad.
  35  *
  36  */
  37 class WireframeVisual: public Visual::Base
  38 {
  39 public:
  40
  41   /**
  42    * @brief Constructor.
  43    *
  44    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  45    */
  46   WireframeVisual( VisualFactoryCache& factoryCache );
  47
  48   /**
  49    * @brief A reference counted object may only be deleted by calling Unreference().
  50    */
  51   virtual ~WireframeVisual();
  52
  53 protected:
  54
  55   /**
  56    * @copydoc Visual::Base::DoSetOnStage
  57    */
  58   virtual void DoSetOnStage( Actor& actor );
  59
  60   /**
  61    * @copydoc Visual::Base::CreatePropertyMap
  62    */
  63   virtual void DoCreatePropertyMap( Property::Map& map ) const;
  64
  65   /**
  66    * @copydoc Visual::Base::DoSetProperty
  67    */
  68   virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
  69
  70   /**
  71    * @copydoc Visual::Base::DoGetProperty
  72    */
  73   virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
  74
  75 private:
  76   /**
  77    * Create the geometry which presents the quad wireframe.
  78    * @return The border geometry
  79    */
  80   Geometry CreateQuadWireframeGeometry();
  81
  82   /**
  83    * @brief Initialise the renderer from the cache, if not available, create and save to the cache for sharing.
  84    */
  85   void InitializeRenderer();
  86
  87 private:
  88
  89   // Undefined
  90   WireframeVisual( const WireframeVisual& visual);
  91
  92   // Undefined
  93   WireframeVisual& operator=( const WireframeVisual& visual );
  94
  95 };
  96
  97 } // namespace Internal
  98
  99 } // namespace Toolkit
 100
 101 } // namespace Dali
 102
 103 #endif // DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H