X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Frendering%2Fgeometry.h;h=5f266e00efaa029470e463494853b13cf6f7a731;hb=4f8a68bd4cf1212b9bfbfe19dd48aa945527e7fb;hp=14ecb117e3e58f7dce01d1711d88a9f9b55ed763;hpb=7e670cd9cb16d7b93787a147088d67f87086f8b8;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/rendering/geometry.h b/dali/public-api/rendering/geometry.h index 14ecb11..5f266e0 100644 --- a/dali/public-api/rendering/geometry.h +++ b/dali/public-api/rendering/geometry.h @@ -44,23 +44,23 @@ class DALI_IMPORT_API Geometry : public BaseHandle public: /** - * @brief Describes the type of geometry, used to determine how the coordinates will be used. - * @SINCE_1_1.43 + * @brief Enumeration for the description of the type of geometry, used to determine how the coordinates will be used. + * @SINCE_1_1.45 */ - enum GeometryType + enum Type { - POINTS, ///< Individual points @SINCE_1_1.43 - LINES, ///< Individual lines (made of 2 points each) @SINCE_1_1.43 - LINE_LOOP, ///< A strip of lines (made of 1 point each) which also joins the first and last point @SINCE_1_1.43 - LINE_STRIP, ///< A strip of lines (made of 1 point each) @SINCE_1_1.43 - TRIANGLES, ///< Individual triangles (made of 3 points each) @SINCE_1_1.43 - TRIANGLE_FAN, ///< A fan of triangles around a centre point (after the first triangle, following triangles need only 1 point) @SINCE_1_1.43 - TRIANGLE_STRIP ///< A strip of triangles (after the first triangle, following triangles need only 1 point) @SINCE_1_1.43 + POINTS, ///< Individual points @SINCE_1_1.45 + LINES, ///< Individual lines (made of 2 points each) @SINCE_1_1.45 + LINE_LOOP, ///< A strip of lines (made of 1 point each) which also joins the first and last point @SINCE_1_1.45 + LINE_STRIP, ///< A strip of lines (made of 1 point each) @SINCE_1_1.45 + TRIANGLES, ///< Individual triangles (made of 3 points each) @SINCE_1_1.45 + TRIANGLE_FAN, ///< A fan of triangles around a centre point (after the first triangle, following triangles need only 1 point) @SINCE_1_1.45 + TRIANGLE_STRIP ///< A strip of triangles (after the first triangle, following triangles need only 1 point) @SINCE_1_1.45 }; /** - * @brief Creates a new Geometry object + * @brief Creates a new Geometry object. * * @SINCE_1_1.43 * @return A handle to a newly allocated Geometry object @@ -68,21 +68,21 @@ public: static Geometry New(); /** - * @brief Default constructor, creates an empty handle + * @brief Default constructor, creates an empty handle. * * @SINCE_1_1.43 */ Geometry(); /** - * @brief Destructor + * @brief Destructor. * * @SINCE_1_1.43 */ ~Geometry(); /** - * @brief Copy constructor, creates a new handle to the same object + * @brief Copy constructor, creates a new handle to the same object. * * @SINCE_1_1.43 * @param[in] handle Handle to an object @@ -90,17 +90,17 @@ public: Geometry( const Geometry& handle ); /** - * @brief Downcast to a geometry. - * If not the returned handle is left uninitialized. + * @brief Downcasts to a geometry. + * If not, the returned handle is left uninitialized. * * @SINCE_1_1.43 * @param[in] handle Handle to an object - * @return geometry Handle or an uninitialized handle + * @return Geometry handle or an uninitialized handle */ static Geometry DownCast( BaseHandle handle ); /** - * @brief Assignment operator, changes this handle to point at the same object + * @brief Assignment operator, changes this handle to point at the same object. * * @SINCE_1_1.43 * @param[in] handle Handle to an object @@ -109,7 +109,7 @@ public: Geometry& operator=( const Geometry& handle ); /** - * @brief Add a PropertyBuffer to be used as source of geometry vertices + * @brief Adds a PropertyBuffer to be used as source of geometry vertices. * * @SINCE_1_1.43 * @param[in] vertexBuffer PropertyBuffer to be used as source of geometry vertices @@ -119,7 +119,7 @@ public: std::size_t AddVertexBuffer( PropertyBuffer& vertexBuffer ); /** - * @brief Retrieve the number of vertex buffers that have been added to this geometry + * @brief Retrieves the number of vertex buffers that have been added to this geometry. * * @SINCE_1_1.43 * @return Number of vertex buffers that have been added to this geometry @@ -127,8 +127,8 @@ public: std::size_t GetNumberOfVertexBuffers() const; /** - * @brief Remove a vertex buffer - * The index must be between 0 and GetNumberOfVertexBuffers() + * @brief Removes a vertex buffer. + * The index must be between 0 and GetNumberOfVertexBuffers(). * * @SINCE_1_1.43 * @param[in] index Index to the vertex buffer to remove @@ -136,9 +136,9 @@ public: void RemoveVertexBuffer( std::size_t index ); /** - * @brief Set a the index data to be used as a source of indices for the geometry + * @brief Sets a the index data to be used as a source of indices for the geometry * Setting this buffer will cause the geometry to be rendered using indices. - * To unset call SetIndexBuffer with a null pointer or count 0 + * To unset call SetIndexBuffer with a null pointer or count 0. * * @SINCE_1_1.43 * @param[in] indices Array of indices @@ -147,26 +147,26 @@ public: void SetIndexBuffer( const unsigned short* indices, size_t count ); /** - * @brief Set the type of primitives this geometry contains + * @brief Sets the type of primitives this geometry contains. * * @SINCE_1_1.43 * @param[in] geometryType Type of primitives this geometry contains */ - void SetGeometryType( GeometryType geometryType ); + void SetType( Type geometryType ); /** - * @brief Get the type of primitives this geometry contains - * Calling this function sets the property GEOMETRY_TYPE + * @brief Gets the type of primitives this geometry contains. + * Calling this function sets the property GEOMETRY_TYPE. * * @SINCE_1_1.43 * @return Type of primitives this geometry contains */ - GeometryType GetGeometryType() const; + Type GetType() const; public: /** - * @brief The constructor + * @brief The constructor. * @note Not intended for application developers. * @SINCE_1_1.43 * @param[in] pointer A pointer to a newly allocated Geometry