mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-28 22:31:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improved documentation for sf::Shape and derived classes

Browse Source
This commit is contained in:
Jan Haller 2014-04-19 11:19:16 +02:00
parent 19012c66ea
commit e9243b7ef6
4 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/SFML/Graphics/CircleShape.hpp
View File

@ -82,9 +82,9 @@ public :
void setPointCount(unsigned int count); void setPointCount(unsigned int count);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of points of the shape /// \brief Get the number of points of the circle
/// ///
/// \return Number of points of the shape /// \return Number of points of the circle
/// ///
/// \see setPointCount /// \see setPointCount
/// ///
@ -92,13 +92,16 @@ public :
virtual unsigned int getPointCount() const; virtual unsigned int getPointCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a point of the shape /// \brief Get a point of the circle
/// ///
/// The returned point is in local coordinates, that is,
/// the shape's transforms (position, rotation, scale) are
/// not taken into account.
/// The result is undefined if \a index is out of the valid range. /// The result is undefined if \a index is out of the valid range.
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
/// ///
/// \return Index-th point of the shape /// \return index-th point of the shape
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2f getPoint(unsigned int index) const; virtual Vector2f getPoint(unsigned int index) const;

3
include/SFML/Graphics/ConvexShape.hpp
View File

@ -93,6 +93,9 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the position of a point /// \brief Get the position of a point
/// ///
/// The returned point is in local coordinates, that is,
/// the shape's transforms (position, rotation, scale) are
/// not taken into account.
/// The result is undefined if \a index is out of the valid range. /// The result is undefined if \a index is out of the valid range.
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]

12
include/SFML/Graphics/RectangleShape.hpp
View File

@ -73,19 +73,23 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get the number of points defining the shape /// \brief Get the number of points defining the shape
/// ///
/// \return Number of points of the shape /// \return Number of points of the shape. For rectangle
/// shapes, this number is always 4.
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual unsigned int getPointCount() const; virtual unsigned int getPointCount() const;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a point of the shape /// \brief Get a point of the rectangle
/// ///
/// The returned point is in local coordinates, that is,
/// the shape's transforms (position, rotation, scale) are
/// not taken into account.
/// The result is undefined if \a index is out of the valid range. /// The result is undefined if \a index is out of the valid range.
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \param index Index of the point to get, in range [0 .. 3]
/// ///
/// \return Index-th point of the shape /// \return index-th point of the shape
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
virtual Vector2f getPoint(unsigned int index) const; virtual Vector2f getPoint(unsigned int index) const;

5
include/SFML/Graphics/Shape.hpp
View File

@ -198,11 +198,14 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \brief Get a point of the shape /// \brief Get a point of the shape
/// ///
/// The returned point is in local coordinates, that is,
/// the shape's transforms (position, rotation, scale) are
/// not taken into account.
/// The result is undefined if \a index is out of the valid range. /// The result is undefined if \a index is out of the valid range.
/// ///
/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
/// ///
/// \return Index-th point of the shape /// \return index-th point of the shape
/// ///
/// \see getPointCount /// \see getPointCount
/// ///