diff options
Diffstat (limited to 'libghack/CSFML-2.1-windows-32bits/CSFML-2.1/include/SFML/Graphics/CircleShape.h')
| -rwxr-xr-x | libghack/CSFML-2.1-windows-32bits/CSFML-2.1/include/SFML/Graphics/CircleShape.h | 431 |
1 files changed, 431 insertions, 0 deletions
diff --git a/libghack/CSFML-2.1-windows-32bits/CSFML-2.1/include/SFML/Graphics/CircleShape.h b/libghack/CSFML-2.1-windows-32bits/CSFML-2.1/include/SFML/Graphics/CircleShape.h new file mode 100755 index 0000000..a37277b --- /dev/null +++ b/libghack/CSFML-2.1-windows-32bits/CSFML-2.1/include/SFML/Graphics/CircleShape.h @@ -0,0 +1,431 @@ +//////////////////////////////////////////////////////////// +// +// SFML - Simple and Fast Multimedia Library +// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com) +// +// This software is provided 'as-is', without any express or implied warranty. +// In no event will the authors be held liable for any damages arising from the use of this software. +// +// Permission is granted to anyone to use this software for any purpose, +// including commercial applications, and to alter it and redistribute it freely, +// subject to the following restrictions: +// +// 1. The origin of this software must not be misrepresented; +// you must not claim that you wrote the original software. +// If you use this software in a product, an acknowledgment +// in the product documentation would be appreciated but is not required. +// +// 2. Altered source versions must be plainly marked as such, +// and must not be misrepresented as being the original software. +// +// 3. This notice may not be removed or altered from any source distribution. +// +//////////////////////////////////////////////////////////// + +#ifndef SFML_CIRCLESHAPE_H +#define SFML_CIRCLESHAPE_H + +//////////////////////////////////////////////////////////// +// Headers +//////////////////////////////////////////////////////////// +#include <SFML/Graphics/Export.h> +#include <SFML/Graphics/Color.h> +#include <SFML/Graphics/Rect.h> +#include <SFML/Graphics/Transform.h> +#include <SFML/Graphics/Types.h> +#include <SFML/System/Vector2.h> + + +//////////////////////////////////////////////////////////// +/// \brief Create a new circle shape +/// +/// \return A new sfCircleShape object, or NULL if it failed +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfCircleShape* sfCircleShape_create(void); + +//////////////////////////////////////////////////////////// +/// \brief Copy an existing circle shape +/// +/// \param shape Shape to copy +/// +/// \return Copied object +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfCircleShape* sfCircleShape_copy(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Destroy an existing circle Shape +/// +/// \param Shape Shape to delete +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_destroy(sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Set the position of a circle shape +/// +/// This function completely overwrites the previous position. +/// See sfCircleShape_move to apply an offset based on the previous position instead. +/// The default position of a circle Shape object is (0, 0). +/// +/// \param shape Shape object +/// \param position New position +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setPosition(sfCircleShape* shape, sfVector2f position); + +//////////////////////////////////////////////////////////// +/// \brief Set the orientation of a circle shape +/// +/// This function completely overwrites the previous rotation. +/// See sfCircleShape_rotate to add an angle based on the previous rotation instead. +/// The default rotation of a circle Shape object is 0. +/// +/// \param shape Shape object +/// \param angle New rotation, in degrees +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setRotation(sfCircleShape* shape, float angle); + +//////////////////////////////////////////////////////////// +/// \brief Set the scale factors of a circle shape +/// +/// This function completely overwrites the previous scale. +/// See sfCircleShape_scale to add a factor based on the previous scale instead. +/// The default scale of a circle Shape object is (1, 1). +/// +/// \param shape Shape object +/// \param scale New scale factors +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setScale(sfCircleShape* shape, sfVector2f scale); + +//////////////////////////////////////////////////////////// +/// \brief Set the local origin of a circle shape +/// +/// The origin of an object defines the center point for +/// all transformations (position, scale, rotation). +/// The coordinates of this point must be relative to the +/// top-left corner of the object, and ignore all +/// transformations (position, scale, rotation). +/// The default origin of a circle Shape object is (0, 0). +/// +/// \param shape Shape object +/// \param origin New origin +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setOrigin(sfCircleShape* shape, sfVector2f origin); + +//////////////////////////////////////////////////////////// +/// \brief Get the position of a circle shape +/// +/// \param shape Shape object +/// +/// \return Current position +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfVector2f sfCircleShape_getPosition(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the orientation of a circle shape +/// +/// The rotation is always in the range [0, 360]. +/// +/// \param shape Shape object +/// +/// \return Current rotation, in degrees +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API float sfCircleShape_getRotation(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the current scale of a circle shape +/// +/// \param shape Shape object +/// +/// \return Current scale factors +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfVector2f sfCircleShape_getScale(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the local origin of a circle shape +/// +/// \param shape Shape object +/// +/// \return Current origin +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfVector2f sfCircleShape_getOrigin(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Move a circle shape by a given offset +/// +/// This function adds to the current position of the object, +/// unlike sfCircleShape_setPosition which overwrites it. +/// +/// \param shape Shape object +/// \param offset Offset +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_move(sfCircleShape* shape, sfVector2f offset); + +//////////////////////////////////////////////////////////// +/// \brief Rotate a circle shape +/// +/// This function adds to the current rotation of the object, +/// unlike sfCircleShape_setRotation which overwrites it. +/// +/// \param shape Shape object +/// \param angle Angle of rotation, in degrees +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_rotate(sfCircleShape* shape, float angle); + +//////////////////////////////////////////////////////////// +/// \brief Scale a circle shape +/// +/// This function multiplies the current scale of the object, +/// unlike sfCircleShape_setScale which overwrites it. +/// +/// \param shape Shape object +/// \param factors Scale factors +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_scale(sfCircleShape* shape, sfVector2f factors); + +//////////////////////////////////////////////////////////// +/// \brief Get the combined transform of a circle shape +/// +/// \param shape Shape object +/// +/// \return Transform combining the position/rotation/scale/origin of the object +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfTransform sfCircleShape_getTransform(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the inverse of the combined transform of a circle shape +/// +/// \param shape Shape object +/// +/// \return Inverse of the combined transformations applied to the object +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfTransform sfCircleShape_getInverseTransform(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Change the source texture of a circle shape +/// +/// The \a texture argument refers to a texture that must +/// exist as long as the shape uses it. Indeed, the shape +/// doesn't store its own copy of the texture, but rather keeps +/// a pointer to the one that you passed to this function. +/// If the source texture is destroyed and the shape tries to +/// use it, the behaviour is undefined. +/// \a texture can be NULL to disable texturing. +/// If \a resetRect is true, the TextureRect property of +/// the shape is automatically adjusted to the size of the new +/// texture. If it is false, the texture rect is left unchanged. +/// +/// \param shape Shape object +/// \param texture New texture +/// \param resetRect Should the texture rect be reset to the size of the new texture? +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setTexture(sfCircleShape* shape, const sfTexture* texture, sfBool resetRect); + +//////////////////////////////////////////////////////////// +/// \brief Set the sub-rectangle of the texture that a circle shape will display +/// +/// The texture rect is useful when you don't want to display +/// the whole texture, but rather a part of it. +/// By default, the texture rect covers the entire texture. +/// +/// \param shape Shape object +/// \param rect Rectangle defining the region of the texture to display +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setTextureRect(sfCircleShape* shape, sfIntRect rect); + +//////////////////////////////////////////////////////////// +/// \brief Set the fill color of a circle shape +/// +/// This color is modulated (multiplied) with the shape's +/// texture if any. It can be used to colorize the shape, +/// or change its global opacity. +/// You can use sfTransparent to make the inside of +/// the shape transparent, and have the outline alone. +/// By default, the shape's fill color is opaque white. +/// +/// \param shape Shape object +/// \param color New color of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setFillColor(sfCircleShape* shape, sfColor color); + +//////////////////////////////////////////////////////////// +/// \brief Set the outline color of a circle shape +/// +/// You can use sfTransparent to disable the outline. +/// By default, the shape's outline color is opaque white. +/// +/// \param shape Shape object +/// \param color New outline color of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setOutlineColor(sfCircleShape* shape, sfColor color); + +//////////////////////////////////////////////////////////// +/// \brief Set the thickness of a circle shape's outline +/// +/// This number cannot be negative. Using zero disables +/// the outline. +/// By default, the outline thickness is 0. +/// +/// \param shape Shape object +/// \param thickness New outline thickness +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setOutlineThickness(sfCircleShape* shape, float thickness); + +//////////////////////////////////////////////////////////// +/// \brief Get the source texture of a circle shape +/// +/// If the shape has no source texture, a NULL pointer is returned. +/// The returned pointer is const, which means that you can't +/// modify the texture when you retrieve it with this function. +/// +/// \param shape Shape object +/// +/// \return Pointer to the shape's texture +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API const sfTexture* sfCircleShape_getTexture(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the sub-rectangle of the texture displayed by a circle shape +/// +/// \param shape Shape object +/// +/// \return Texture rectangle of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfIntRect sfCircleShape_getTextureRect(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the fill color of a circle shape +/// +/// \param shape Shape object +/// +/// \return Fill color of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfColor sfCircleShape_getFillColor(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the outline color of a circle shape +/// +/// \param shape Shape object +/// +/// \return Outline color of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfColor sfCircleShape_getOutlineColor(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the outline thickness of a circle shape +/// +/// \param shape Shape object +/// +/// \return Outline thickness of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API float sfCircleShape_getOutlineThickness(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the total number of points of a circle shape +/// +/// \param shape Shape object +/// +/// \return Number of points of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API unsigned int sfCircleShape_getPointCount(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get a point of a circle shape +/// +/// The result is undefined if \a index is out of the valid range. +/// +/// \param shape Shape object +/// \param index Index of the point to get, in range [0 .. getPointCount() - 1] +/// +/// \return Index-th point of the shape +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfVector2f sfCircleShape_getPoint(const sfCircleShape* shape, unsigned int index); + +//////////////////////////////////////////////////////////// +/// \brief Set the radius of a circle +/// +/// \param shape Shape object +/// \param radius New radius of the circle +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setRadius(sfCircleShape* shape, float radius); + +//////////////////////////////////////////////////////////// +/// \brief Get the radius of a circle +/// +/// \param shape Shape object +/// +/// \return Radius of the circle +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API float sfCircleShape_getRadius(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Set the number of points of a circle +/// +/// \param shape Shape object +/// \param count New number of points of the circle +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API void sfCircleShape_setPointCount(sfCircleShape* shape, unsigned int count); + +//////////////////////////////////////////////////////////// +/// \brief Get the local bounding rectangle of a circle shape +/// +/// The returned rectangle is in local coordinates, which means +/// that it ignores the transformations (translation, rotation, +/// scale, ...) that are applied to the entity. +/// In other words, this function returns the bounds of the +/// entity in the entity's coordinate system. +/// +/// \param shape Shape object +/// +/// \return Local bounding rectangle of the entity +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfFloatRect sfCircleShape_getLocalBounds(const sfCircleShape* shape); + +//////////////////////////////////////////////////////////// +/// \brief Get the global bounding rectangle of a circle shape +/// +/// The returned rectangle is in global coordinates, which means +/// that it takes in account the transformations (translation, +/// rotation, scale, ...) that are applied to the entity. +/// In other words, this function returns the bounds of the +/// sprite in the global 2D world's coordinate system. +/// +/// \param shape Shape object +/// +/// \return Global bounding rectangle of the entity +/// +//////////////////////////////////////////////////////////// +CSFML_GRAPHICS_API sfFloatRect sfCircleShape_getGlobalBounds(const sfCircleShape* shape); + + +#endif // SFML_CIRCLESHAPE_H |