1 #ifndef DALI_GEOMETRY_H
2 #define DALI_GEOMETRY_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <cstddef> // std::size_t
25 #include <dali/public-api/object/handle.h> // Dali::Handle
26 #include <dali/public-api/object/property-index-ranges.h> // DEFAULT_DERIVED_HANDLE_PROPERTY_START_INDEX
27 #include <dali/public-api/rendering/property-buffer.h> // Dali::PropertyBuffer
32 namespace Internal DALI_INTERNAL
38 * @brief Geometry is handle to an object that can be used to define a geometric elements.
42 class DALI_IMPORT_API Geometry : public BaseHandle
47 * @brief Enumeration for the description of the type of geometry, used to determine how the coordinates will be used.
52 POINTS, ///< Individual points @SINCE_1_1.45
53 LINES, ///< Individual lines (made of 2 points each) @SINCE_1_1.45
54 LINE_LOOP, ///< A strip of lines (made of 1 point each) which also joins the first and last point @SINCE_1_1.45
55 LINE_STRIP, ///< A strip of lines (made of 1 point each) @SINCE_1_1.45
56 TRIANGLES, ///< Individual triangles (made of 3 points each) @SINCE_1_1.45
57 TRIANGLE_FAN, ///< A fan of triangles around a centre point (after the first triangle, following triangles need only 1 point) @SINCE_1_1.45
58 TRIANGLE_STRIP ///< A strip of triangles (after the first triangle, following triangles need only 1 point) @SINCE_1_1.45
63 * @brief Creates a new Geometry object.
66 * @return A handle to a newly allocated Geometry object
68 static Geometry New();
71 * @brief Default constructor, creates an empty handle.
85 * @brief Copy constructor, creates a new handle to the same object.
88 * @param[in] handle Handle to an object
90 Geometry( const Geometry& handle );
93 * @brief Downcasts to a geometry.
94 * If not, the returned handle is left uninitialized.
97 * @param[in] handle Handle to an object
98 * @return Geometry handle or an uninitialized handle
100 static Geometry DownCast( BaseHandle handle );
103 * @brief Assignment operator, changes this handle to point at the same object.
106 * @param[in] handle Handle to an object
107 * @return Reference to the assigned object
109 Geometry& operator=( const Geometry& handle );
112 * @brief Adds a PropertyBuffer to be used as source of geometry vertices.
115 * @param[in] vertexBuffer PropertyBuffer to be used as source of geometry vertices
116 * @return Index of the newly added buffer, can be used with RemoveVertexBuffer to remove
117 * this buffer if no longer required
119 std::size_t AddVertexBuffer( PropertyBuffer& vertexBuffer );
122 * @brief Retrieves the number of vertex buffers that have been added to this geometry.
125 * @return Number of vertex buffers that have been added to this geometry
127 std::size_t GetNumberOfVertexBuffers() const;
130 * @brief Removes a vertex buffer.
131 * The index must be between 0 and GetNumberOfVertexBuffers().
134 * @param[in] index Index to the vertex buffer to remove
136 void RemoveVertexBuffer( std::size_t index );
139 * @brief Sets a the index data to be used as a source of indices for the geometry
140 * Setting this buffer will cause the geometry to be rendered using indices.
141 * To unset call SetIndexBuffer with a null pointer or count 0.
144 * @param[in] indices Array of indices
145 * @param[in] count Number of indices in the array
147 void SetIndexBuffer( const unsigned short* indices, size_t count );
150 * @brief Sets the type of primitives this geometry contains.
153 * @param[in] geometryType Type of primitives this geometry contains
155 void SetType( Type geometryType );
158 * @brief Gets the type of primitives this geometry contains.
159 * Calling this function sets the property GEOMETRY_TYPE.
162 * @return Type of primitives this geometry contains
164 Type GetType() const;
169 * @brief The constructor.
170 * @note Not intended for application developers.
172 * @param[in] pointer A pointer to a newly allocated Geometry
174 explicit DALI_INTERNAL Geometry( Internal::Geometry* pointer );
179 #endif // DALI_GEOMETRY_H