[dali_1.2.12] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / 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 // EXTERNAL INCLUDES
48 #include <dali/public-api/common/intrusive-ptr.h>
49
50 // INTERNAL INCLUDES
51 #include <dali-toolkit/public-api/visuals/primitive-visual-properties.h>
52 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
53
54 namespace Dali
55 {
56
57 namespace Toolkit
58 {
59
60 namespace Internal
61 {
62
63 class PrimitiveVisual;
64 typedef IntrusivePtr< PrimitiveVisual > PrimitiveVisualPtr;
65
66 /**
67  * The visual which renders a simple 3D shape to the control's quad
68  *
69  * Primitives are created with clockwise winding and back-face culling by default.
70  *
71  * The following properties are required to create a PrimitiveRender
72  *
73  * | %Property Name  | Type        |
74  * |-----------------|-------------|
75  * | shape           | STRING      |
76  *
77  * In addition, the following properties can be (optionally) supplied to modify the shape's parameters
78  *
79  * | %Property Name    | Type        | Shapes Affected                          |
80  * |-------------------|-------------|------------------------------------------|
81  * | shapeColor        | VECTOR4     | all                                      |
82  * | slices            | INTEGER     | sphere, cone, conical frustrum, cylinder |
83  * | stacks            | INTEGER     | sphere                                   |
84  * | scaleTopRadius    | FLOAT       | conical frustrum                         |
85  * | scaleBottomRadius | FLOAT       | cone, conical frustrum                   |
86  * | scaleHeight       | FLOAT       | cone, conical frustrum, cylinder         |
87  * | scaleRadius       | FLOAT       | cylinder                                 |
88  * | scaleDimensions   | VECTOR3     | cube, octahedron, bevelled cube          |
89  * | bevelPercentage   | FLOAT       | bevelled cube                            |
90  * | bevelSmoothness   | FLOAT       | bevelled cube                            |
91  *
92  * Note: slices and stacks both have an upper limit of 255.
93  *
94  * Finally, the following can be used to affect the visual's shader
95  *
96  * | %Property Name  | Type        | Representing                            |
97  * |-----------------|-------------|-----------------------------------------|
98  * | lightPosition   | VECTOR3     | The position (on stage) of the light    |
99  */
100 class PrimitiveVisual: public Visual::Base
101 {
102 public:
103
104   /**
105    * @brief Create a new primitive visual.
106    *
107    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
108    * @return A smart-pointer to the newly allocated visual.
109    */
110   static PrimitiveVisualPtr New( VisualFactoryCache& factoryCache );
111
112 public:  // from Visual
113
114   /**
115    * @copydoc Visual::Base::SetSize
116    */
117   virtual void SetSize( const Vector2& size );
118
119   /**
120    * @copydoc Visual::Base::GetNaturalSize
121    */
122   virtual void GetNaturalSize( Vector2& naturalSize ) const;
123
124   /**
125    * @copydoc Visual::Base::CreatePropertyMap
126    */
127   virtual void DoCreatePropertyMap( Property::Map& map ) const;
128
129   /**
130    * @copydoc Visual::Base::DoSetProperty
131    */
132   virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
133
134   /**
135    * @copydoc Visual::Base::DoGetProperty
136    */
137   virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
138
139 protected:
140
141   /**
142    * @brief Constructor.
143    *
144    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
145    */
146   PrimitiveVisual( VisualFactoryCache& factoryCache );
147
148   /**
149    * @brief A reference counted object may only be deleted by calling Unreference().
150    */
151   virtual ~PrimitiveVisual();
152
153   /**
154    * @copydoc Visual::Base::DoSetProperties
155    */
156   virtual void DoSetProperties( const Property::Map& propertyMap );
157
158   /**
159    * @copydoc Visual::Base::DoSetOnStage
160    */
161   virtual void DoSetOnStage( Actor& actor );
162
163 private:
164
165   //Simple struct to store the position and normal of a single vertex.
166   struct Vertex
167   {
168     Vertex()
169     {}
170
171     Vertex( const Vector3& position, const Vector3& normal, const Vector2& textureCoord )
172     : position( position ), normal( normal )
173     {}
174
175     Vector3 position;
176     Vector3 normal;
177   };
178
179   /**
180    * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
181    */
182   void InitializeRenderer();
183
184   /**
185      * @brief Create a shader for the object to use.
186      */
187   void CreateShader();
188
189   /**
190    * @brief Update shader related info, uniforms, etc. for the new shader.
191    */
192   void UpdateShaderUniforms();
193
194   /**
195    * @brief Create the geometry of the given primitive type.
196    */
197   void CreateGeometry();
198
199   /**
200    * @brief Compute the vertices and the triangles for a sphere.
201    * @param[in, out] vertices The vector of vertices.
202    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
203    * @param[in] slices The number of slices as you go around the sphere. Affects the smoothness of the surface.
204    * @param[in] stacks The number of stacks as you go down the sphere. Affects the smoothness of the surface.
205    */
206   void CreateSphere( Vector<Vertex>& vertices, Vector<unsigned short>& indices, int slices, int stacks );
207
208   /**
209    * @brief Compute the vertices and the triangles for a conic shape.
210    * @param[in, out] vertices The vector of vertices.
211    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
212    * @param[in] scaleTopRadius The scale of the radius of the top circle, compared to the other dimensions.
213    * @param[in] scaleBottomRadius The scale of the radius of the bottom circle, compared to the other dimensions.
214    * @param[in] scaleHeight The scale of the height of the object, compared to the other dimensions.
215    * @param[in] slices The number of slices as you go around the conic shape. Affects the smoothness of the surface.
216    */
217   void CreateConic( Vector<Vertex>& vertices, Vector<unsigned short>& indices, float scaleTopRadius,
218                            float scaleBottomRadius, float scaleHeight, int slices );
219
220   /**
221    * @brief Compute the vertices and the triangles for a bevelled cube.
222    * @param[in, out] vertices The vector of vertices.
223    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
224    * @Param[in] dimensions The dimensions of the object. Scales in the same fashion as a 9-patch image.
225    * @param[in] bevelPercentage The ratio of the outer face widths to the cube's width. Between 0.0 and 1.0.
226    * @param[in] bevelSmoothness The smoothness of the bevelled edges. Between 0.0 and 1.0.
227    */
228   void CreateBevelledCube( Vector<Vertex>& vertices, Vector<unsigned short>& indices, Vector3 dimensions,
229                            float bevelPercentage, float bevelSmoothness );
230
231   /**
232    * @brief Computes look-up tables for sin and cos, over angle divisions of (2 * Pi) / divisions
233    * @param[in, out] sinTable The table of sin values.
234    * @param[in, out] cosTable The table of cos values.
235    * @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)
236    * @Param[in] halfCircle If true, go from 0 to Pi instead of 0 to 2Pi.
237    */
238   void ComputeCircleTables( Vector<float>& sinTable, Vector<float>& cosTable, int divisions, bool halfCircle );
239
240   /**
241    * @brief Compute the vertices for a sphere.
242    * @param[in, out] vertices The vector of vertices.
243    * @param[in] slices The number of slices as you go around the sphere. Affects the smoothness of the surface.
244    * @param[in] stacks The number of stacks as you go down the sphere. Affects the smoothness of the surface.
245    */
246   void ComputeSphereVertices( Vector<Vertex>& vertices, int slices, int stacks );
247
248   /**
249    * @brief Compute the triangles for a sphere.
250    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
251    * @param[in] slices The number of slices as you go around the sphere. Affects the smoothness of the surface.
252    * @param[in] stacks The number of stacks as you go down the sphere. Affects the smoothness of the surface.
253    */
254   void FormSphereTriangles( Vector<unsigned short>& indices, int slices, int stacks );
255
256   /**
257    * @brief Compute the vertices for a conical.
258    * @param[in, out] vertices The vector of vertices.
259    * @param[in] scaleTopRadius The scale of the radius of the top circle, compared to the other dimensions.
260    * @param[in] scaleBottomRadius The scale of the radius of the bottom circle, compared to the other dimensions.
261    * @param[in] scaleHeight The scale of the height of the object, compared to the other dimensions.
262    * @param[in] slices The number of slices as you go around the conical. Affects the smoothness of the surface.
263    */
264   void ComputeConicVertices( Vector<Vertex>& vertices, float scaleTopRadius, float scaleBottomRadius,
265                                     float scaleHeight, int slices );
266
267   /**
268    * @brief Compute the triangles for a conic.
269    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
270    * @param[in] coneTop True if the top circle has a radius of zero, i.e. the object is a complete cone.
271    * @param[in] coneBottom True if the bottom circle has a radius of zero, i.e. the object is an inverted complete cone.
272    * @param[in] slices The number of slices as you go around the conic. Affects the smoothness of the surface.
273    */
274   void FormConicTriangles( Vector<unsigned short>& indices, float scaleTopRadius, float scaleBottomRadius,
275                                   int slices );
276
277   /**
278    * @brief Compute the vertices for a cube.
279    * @param[in, out] vertices The vector of vertices.
280    * @Param[in] dimensions The dimensions of the object.
281    */
282   void ComputeCubeVertices( Vector<Vertex>& vertices, Vector3 dimensions );
283
284   /**
285    * @brief Compute the triangles for a cube.
286    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
287    */
288   void FormCubeTriangles( Vector<unsigned short>& indices );
289
290   /**
291    * @brief Compute the vertices for an octahedron (maximumly bevelled cube).
292    * @param[in, out] vertices The vector of vertices.
293    * @Param[in] dimensions The dimensions of the object.
294    * @Param[in] smoothness Defines how rounded the edges appear under lighting. Between 0.0 and 1.0.
295    */
296   void ComputeOctahedronVertices( Vector<Vertex>& vertices, Vector3 dimensions, float smoothness );
297
298   /**
299    * @brief Compute the triangles for an octahedron.
300    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
301    */
302   void FormOctahedronTriangles( Vector<unsigned short>& indices );
303
304   /**
305    * @brief Compute the vertices for a bevelled cube.
306    * @param[in, out] vertices The vector of vertices.
307    * @Param[in] dimensions The dimensions of the object. Scales in the same fashion as a 9-patch image.
308    * @param[in] bevelPercentage The ratio of the outer face widths to the cube's width. Between 0.0 and 1.0.
309    * @param[in] bevelSmoothness The smoothness of the bevelled edges. Between 0.0 and 1.0.
310    */
311   void ComputeBevelledCubeVertices( Vector<Vertex>& vertices, Vector3 dimensions, float bevelPercentage,
312                                     float bevelSmoothness );
313
314   /**
315    * @brief Compute the triangles for a bevelled cube.
316    * @param[in, out] indices The vector of triangles, consisting of groups of three vertex indices.
317    */
318   void FormBevelledCubeTriangles( Vector<unsigned short>& indices );
319
320 private:
321
322   // Undefined
323   PrimitiveVisual( const PrimitiveVisual& PrimitiveVisual );
324
325   // Undefined
326   PrimitiveVisual& operator=( const PrimitiveVisual& PrimitiveVisual );
327
328 private:
329   Shader mShader;
330   Geometry mGeometry;
331
332   Vector4 mColor;                //Color of shape.
333   Vector3 mObjectDimensions;     //Dimensions of shape, scaled to be between 0.0 and 1.0.
334
335   Vector3 mSceneCenter;
336   Vector3 mSceneSize;
337
338   //Shader properties.
339   Vector3 mLightPosition;
340
341   //Shape properties.
342   Vector3 mScaleDimensions;      ///< Scale of dimensions of bevelled cube and sub-shapes.
343   float   mScaleTopRadius;       ///< Scale of radius of top circle, to use when creating certain objects.
344   float   mScaleBottomRadius;    ///< Scale of radius of bottom circle, to use when creating certain objects.
345   float   mScaleHeight;          ///< Scale of height, to use when creating certain objects.
346   float   mScaleRadius;          ///< Scale of radius, to use when creating certain objects.
347   float   mBevelPercentage;      ///< Used to determine bevel amount when creating certain objects.
348   float   mBevelSmoothness;      ///< Used to determine the smoothness of bevelled edges.
349   int     mSlices;               ///< Number of slices to use when creating certain objects.
350   int     mStacks;               ///< Number of stacks to use when creating certain objects.
351
352   Toolkit::PrimitiveVisual::Shape::Type mPrimitiveType;  //Shape to render, as enum.
353 };
354
355 } // namespace Internal
356
357 } // namespace Toolkit
358
359 } // namespace Dali
360
361 #endif /* DALI_TOOLKIT_INTERNAL_PRIMITIVE_VISUAL_H */