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

   1 #ifndef DALI_TOOLKIT_INTERNAL_PRIMITIVE_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_PRIMITIVE_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 /*
  22  * The geometry creation logic was based off similar methods provided by freeGLUT.
  23  * Original copyright and licence information:
  24  *
  25  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
  26  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
  27  * Creation date: Fri Dec 3 1999
  28  *
  29  * Permission is hereby granted, free of charge, to any person obtaining a
  30  * copy of this software and associated documentation files (the "Software"),
  31  * to deal in the Software without restriction, including without limitation
  32  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  33  * and/or sell copies of the Software, and to permit persons to whom the
  34  * Software is furnished to do so, subject to the following conditions:
  35  *
  36  * The above copyright notice and this permission notice shall be included
  37  * in all copies or substantial portions of the Software.
  38  *
  39  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  40  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  41  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  42  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  43  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  44  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  45  */
  46
  47
  48 // INTERNAL INCLUDES
  49 #include <dali-toolkit/public-api/visuals/primitive-visual-properties.h>
  50 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  51
  52 namespace Dali
  53 {
  54
  55 namespace Toolkit
  56 {
  57
  58 namespace Internal
  59 {
  60
  61 /**
  62  * The visual which renders a simple 3D shape to the control's quad
  63  *
  64  * Primitives are created with clockwise winding and back-face culling by default.
  65  *
  66  * The following properties are required to create a PrimitiveRender
  67  *
  68  * | %Property Name  | Type        |
  69  * |-----------------|-------------|
  70  * | shape           | STRING      |
  71  *
  72  * In addition, the following properties can be (optionally) supplied to modify the shape's parameters
  73  *
  74  * | %Property Name    | Type        | Shapes Affected                          |
  75  * |-------------------|-------------|------------------------------------------|
  76  * | shapeColor        | VECTOR4     | all                                      |
  77  * | slices            | INTEGER     | sphere, cone, conical frustrum, cylinder |
  78  * | stacks            | INTEGER     | sphere                                   |
  79  * | scaleTopRadius    | FLOAT       | conical frustrum                         |
  80  * | scaleBottomRadius | FLOAT       | cone, conical frustrum                   |
  81  * | scaleHeight       | FLOAT       | cone, conical frustrum, cylinder         |
  82  * | scaleRadius       | FLOAT       | cylinder                                 |
  83  * | scaleDimensions   | VECTOR3     | cube, octahedron, bevelled cube          |
  84  * | bevelPercentage   | FLOAT       | bevelled cube                            |
  85  * | bevelSmoothness   | FLOAT       | bevelled cube                            |
  86  *
  87  * Note: slices and stacks both have an upper limit of 255.
  88  *
  89  * Finally, the following can be used to affect the visual's shader
  90  *
  91  * | %Property Name  | Type        | Representing                            |
  92  * |-----------------|-------------|-----------------------------------------|
  93  * | lightPosition   | VECTOR3     | The position (on stage) of the light    |
  94  */
  95 class PrimitiveVisual: public Visual::Base
  96 {
  97 public:
  98
  99   /**
 100    * @brief Constructor.
 101    *
 102    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 103    */
 104   PrimitiveVisual( VisualFactoryCache& factoryCache );
 105
 106   /**
 107    * @brief A reference counted object may only be deleted by calling Unreference().
 108    */
 109   virtual ~PrimitiveVisual();
 110
 111 public:  // from Visual
 112
 113   /**
 114    * @copydoc Visual::SetSize
 115    */
 116   virtual void SetSize( const Vector2& size );
 117
 118   /**
 119    * @copydoc Visual::SetClipRect
 120    */
 121   virtual void SetClipRect( const Rect<int>& clipRect );
 122
 123   /**
 124    * @copydoc Visual::SetOffset
 125    */
 126   virtual void SetOffset( const Vector2& offset );
 127
 128   /**
 129    * @copydoc Visual::CreatePropertyMap
 130    */
 131   virtual void DoCreatePropertyMap( Property::Map& map ) const;
 132
 133 protected:
 134
 135   /**
 136    * @copydoc Visual::DoInitialize
 137    */
 138   virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
 139
 140   /**
 141    * @copydoc Visual::DoSetOnStage
 142    */
 143   virtual void DoSetOnStage( Actor& actor );
 144
 145 private:
 146
 147   //Simple struct to store the position and normal of a single vertex.
 148   struct Vertex
 149   {
 150     Vertex()
 151     {}
 152
 153     Vertex( const Vector3& position, const Vector3& normal, const Vector2& textureCoord )
 154     : position( position ), normal( normal )
 155     {}
 156
 157     Vector3 position;
 158     Vector3 normal;
 159   };
 160
 161   /**
 162    * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
 163    */
 164   void InitializeRenderer();
 165
 166   /**
 167      * @brief Create a shader for the object to use.
 168      */
 169   void CreateShader();
 170
 171   /**
 172    * @brief Update shader related info, uniforms, etc. for the new shader.
 173    */
 174   void UpdateShaderUniforms();
 175
 176   /**
 177    * @brief Create the geometry of the given primitive type.
 178    */
 179   void CreateGeometry();
 180
 181   /**
 182    * @brief Compute the vertices and the triangles for a sphere.
 183    * @param[in, out] vertices The vector of vertices.
 184    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 185    * @param[in] slices The number of slices as you go around the sphere. Affects the smoothness of the surface.
 186    * @param[in] stacks The number of stacks as you go down the sphere. Affects the smoothness of the surface.
 187    */
 188   void CreateSphere( Vector<Vertex>& vertices, Vector<unsigned short>& indices, int slices, int stacks );
 189
 190   /**
 191    * @brief Compute the vertices and the triangles for a conic shape.
 192    * @param[in, out] vertices The vector of vertices.
 193    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 194    * @param[in] scaleTopRadius The scale of the radius of the top circle, compared to the other dimensions.
 195    * @param[in] scaleBottomRadius The scale of the radius of the bottom circle, compared to the other dimensions.
 196    * @param[in] scaleHeight The scale of the height of the object, compared to the other dimensions.
 197    * @param[in] slices The number of slices as you go around the conic shape. Affects the smoothness of the surface.
 198    */
 199   void CreateConic( Vector<Vertex>& vertices, Vector<unsigned short>& indices, float scaleTopRadius,
 200                            float scaleBottomRadius, float scaleHeight, int slices );
 201
 202   /**
 203    * @brief Compute the vertices and the triangles for a bevelled cube.
 204    * @param[in, out] vertices The vector of vertices.
 205    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 206    * @Param[in] dimensions The dimensions of the object. Scales in the same fashion as a 9-patch image.
 207    * @param[in] bevelPercentage The ratio of the outer face widths to the cube's width. Between 0.0 and 1.0.
 208    * @param[in] bevelSmoothness The smoothness of the bevelled edges. Between 0.0 and 1.0.
 209    */
 210   void CreateBevelledCube( Vector<Vertex>& vertices, Vector<unsigned short>& indices, Vector3 dimensions,
 211                            float bevelPercentage, float bevelSmoothness );
 212
 213   /**
 214    * @brief Computes look-up tables for sin and cos, over angle divisions of (2 * Pi) / divisions
 215    * @param[in, out] sinTable The table of sin values.
 216    * @param[in, out] cosTable The table of cos values.
 217    * @param[in] divisions Determines the angle coverage of the table. E.g divisions of '4' will have the sin values 0 = sin(0), 1 = sin(Pi/2), 2 = sin(Pi), 3 = sin(3Pi/2)
 218    * @Param[in] halfCircle If true, go from 0 to Pi instead of 0 to 2Pi.
 219    */
 220   void ComputeCircleTables( Vector<float>& sinTable, Vector<float>& cosTable, int divisions, bool halfCircle );
 221
 222   /**
 223    * @brief Compute the vertices for a sphere.
 224    * @param[in, out] vertices The vector of vertices.
 225    * @param[in] slices The number of slices as you go around the sphere. Affects the smoothness of the surface.
 226    * @param[in] stacks The number of stacks as you go down the sphere. Affects the smoothness of the surface.
 227    */
 228   void ComputeSphereVertices( Vector<Vertex>& vertices, int slices, int stacks );
 229
 230   /**
 231    * @brief Compute the triangles for a sphere.
 232    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 233    * @param[in] slices The number of slices as you go around the sphere. Affects the smoothness of the surface.
 234    * @param[in] stacks The number of stacks as you go down the sphere. Affects the smoothness of the surface.
 235    */
 236   void FormSphereTriangles( Vector<unsigned short>& indices, int slices, int stacks );
 237
 238   /**
 239    * @brief Compute the vertices for a conical.
 240    * @param[in, out] vertices The vector of vertices.
 241    * @param[in] scaleTopRadius The scale of the radius of the top circle, compared to the other dimensions.
 242    * @param[in] scaleBottomRadius The scale of the radius of the bottom circle, compared to the other dimensions.
 243    * @param[in] scaleHeight The scale of the height of the object, compared to the other dimensions.
 244    * @param[in] slices The number of slices as you go around the conical. Affects the smoothness of the surface.
 245    */
 246   void ComputeConicVertices( Vector<Vertex>& vertices, float scaleTopRadius, float scaleBottomRadius,
 247                                     float scaleHeight, int slices );
 248
 249   /**
 250    * @brief Compute the triangles for a conic.
 251    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 252    * @param[in] coneTop True if the top circle has a radius of zero, i.e. the object is a complete cone.
 253    * @param[in] coneBottom True if the bottom circle has a radius of zero, i.e. the object is an inverted complete cone.
 254    * @param[in] slices The number of slices as you go around the conic. Affects the smoothness of the surface.
 255    */
 256   void FormConicTriangles( Vector<unsigned short>& indices, float scaleTopRadius, float scaleBottomRadius,
 257                                   int slices );
 258
 259   /**
 260    * @brief Compute the vertices for a cube.
 261    * @param[in, out] vertices The vector of vertices.
 262    * @Param[in] dimensions The dimensions of the object.
 263    */
 264   void ComputeCubeVertices( Vector<Vertex>& vertices, Vector3 dimensions );
 265
 266   /**
 267    * @brief Compute the triangles for a cube.
 268    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 269    */
 270   void FormCubeTriangles( Vector<unsigned short>& indices );
 271
 272   /**
 273    * @brief Compute the vertices for an octahedron (maximumly bevelled cube).
 274    * @param[in, out] vertices The vector of vertices.
 275    * @Param[in] dimensions The dimensions of the object.
 276    * @Param[in] smoothness Defines how rounded the edges appear under lighting. Between 0.0 and 1.0.
 277    */
 278   void ComputeOctahedronVertices( Vector<Vertex>& vertices, Vector3 dimensions, float smoothness );
 279
 280   /**
 281    * @brief Compute the triangles for an octahedron.
 282    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 283    */
 284   void FormOctahedronTriangles( Vector<unsigned short>& indices );
 285
 286   /**
 287    * @brief Compute the vertices for a bevelled cube.
 288    * @param[in, out] vertices The vector of vertices.
 289    * @Param[in] dimensions The dimensions of the object. Scales in the same fashion as a 9-patch image.
 290    * @param[in] bevelPercentage The ratio of the outer face widths to the cube's width. Between 0.0 and 1.0.
 291    * @param[in] bevelSmoothness The smoothness of the bevelled edges. Between 0.0 and 1.0.
 292    */
 293   void ComputeBevelledCubeVertices( Vector<Vertex>& vertices, Vector3 dimensions, float bevelPercentage,
 294                                     float bevelSmoothness );
 295
 296   /**
 297    * @brief Compute the triangles for a bevelled cube.
 298    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
 299    */
 300   void FormBevelledCubeTriangles( Vector<unsigned short>& indices );
 301
 302 private:
 303
 304   // Undefined
 305   PrimitiveVisual( const PrimitiveVisual& PrimitiveVisual );
 306
 307   // Undefined
 308   PrimitiveVisual& operator=( const PrimitiveVisual& PrimitiveVisual );
 309
 310 private:
 311   Shader mShader;
 312   Geometry mGeometry;
 313
 314   Vector4 mColor;                //Color of shape.
 315   Vector3 mObjectDimensions;     //Dimensions of shape, scaled to be between 0.0 and 1.0.
 316
 317   Vector3 mSceneCenter;
 318   Vector3 mSceneSize;
 319
 320   //Shader properties.
 321   Vector3 mLightPosition;
 322
 323   //Shape properties.
 324   Vector3 mScaleDimensions;      ///< Scale of dimensions of bevelled cube and sub-shapes.
 325   float   mScaleTopRadius;       ///< Scale of radius of top circle, to use when creating certain objects.
 326   float   mScaleBottomRadius;    ///< Scale of radius of bottom circle, to use when creating certain objects.
 327   float   mScaleHeight;          ///< Scale of height, to use when creating certain objects.
 328   float   mScaleRadius;          ///< Scale of radius, to use when creating certain objects.
 329   float   mBevelPercentage;      ///< Used to determine bevel amount when creating certain objects.
 330   float   mBevelSmoothness;      ///< Used to determine the smoothness of bevelled edges.
 331   int     mSlices;               ///< Number of slices to use when creating certain objects.
 332   int     mStacks;               ///< Number of stacks to use when creating certain objects.
 333
 334   Toolkit::PrimitiveVisual::Shape::Type mPrimitiveType;  //Shape to render, as enum.
 335 };
 336
 337 } // namespace Internal
 338
 339 } // namespace Toolkit
 340
 341 } // namespace Dali
 342
 343 #endif /* DALI_TOOLKIT_INTERNAL_PRIMITIVE_VISUAL_H */