documentation/3.0.1/Shape_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)

//

// 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.

//


#pragma once


// Headers

#include <SFML/Graphics/Export.hpp>


#include <SFML/Graphics/Color.hpp>

#include <SFML/Graphics/Drawable.hpp>

#include <SFML/Graphics/PrimitiveType.hpp>

#include <SFML/Graphics/Rect.hpp>

#include <SFML/Graphics/RenderStates.hpp>

#include <SFML/Graphics/Transformable.hpp>

#include <SFML/Graphics/VertexArray.hpp>


#include <SFML/System/Vector2.hpp>


#include <cstddef>


namespace sf

{

class Texture;

class RenderTarget;


class SFML_GRAPHICS_API Shape : public Drawable, public Transformable

{

public:

    void setTexture(const Texture* texture, bool resetRect = false);


    void setTextureRect(const IntRect& rect);


    void setFillColor(Color color);


    void setOutlineColor(Color color);


    void setOutlineThickness(float thickness);


    [[nodiscard]] const Texture* getTexture() const;


    [[nodiscard]] const IntRect& getTextureRect() const;


    [[nodiscard]] Color getFillColor() const;


    [[nodiscard]] Color getOutlineColor() const;


    [[nodiscard]] float getOutlineThickness() const;


    [[nodiscard]] virtual std::size_t getPointCount() const = 0;


    [[nodiscard]] virtual Vector2f getPoint(std::size_t index) const = 0;


    [[nodiscard]] virtual Vector2f getGeometricCenter() const;


    [[nodiscard]] FloatRect getLocalBounds() const;


    [[nodiscard]] FloatRect getGlobalBounds() const;


protected:

    void update();


private:

    void draw(RenderTarget& target, RenderStates states) const override;


    void updateFillColors();


    void updateTexCoords();


    void updateOutline();


    void updateOutlineColors();


    // Member data

    const Texture* m_texture{};

    IntRect        m_textureRect;

    Color          m_fillColor{Color::White};

    Color          m_outlineColor{Color::White};

    float          m_outlineThickness{};

    VertexArray    m_vertices{PrimitiveType::TriangleFan};

    VertexArray    m_outlineVertices{PrimitiveType::TriangleStrip};

    FloatRect      m_insideBounds;

    FloatRect      m_bounds;

};


} // namespace sf


Color.hpp

Drawable.hpp

Export.hpp

SFML_GRAPHICS_API
#define SFML_GRAPHICS_API
Definition Graphics/Export.hpp:42

PrimitiveType.hpp

Rect.hpp

RenderStates.hpp

Transformable.hpp

Vector2.hpp

VertexArray.hpp

sf::Color
Utility class for manipulating RGBA colors.
Definition Color.hpp:40

sf::Color::White
static const Color White
White predefined color.
Definition Color.hpp:83

sf::Drawable
Abstract base class for objects that can be drawn to a render target.
Definition Drawable.hpp:44

sf::Drawable::RenderTarget
friend class RenderTarget
Definition Drawable.hpp:53

sf::RenderTarget
Base class for all render targets (window, texture, ...)
Definition RenderTarget.hpp:63

sf::Shape
Base class for textured shapes with outline.
Definition Shape.hpp:55

sf::Shape::getOutlineThickness
float getOutlineThickness() const
Get the outline thickness of the shape.

sf::Shape::setTextureRect
void setTextureRect(const IntRect &rect)
Set the sub-rectangle of the texture that the shape will display.

sf::Shape::getPoint
virtual Vector2f getPoint(std::size_t index) const =0
Get a point of the shape.

sf::Shape::setFillColor
void setFillColor(Color color)
Set the fill color of the shape.

sf::Shape::getGeometricCenter
virtual Vector2f getGeometricCenter() const
Get the geometric center of the shape.

sf::Shape::setOutlineThickness
void setOutlineThickness(float thickness)
Set the thickness of the shape's outline.

sf::Shape::getFillColor
Color getFillColor() const
Get the fill color of the shape.

sf::Shape::setOutlineColor
void setOutlineColor(Color color)
Set the outline color of the shape.

sf::Shape::getOutlineColor
Color getOutlineColor() const
Get the outline color of the shape.

sf::Shape::getGlobalBounds
FloatRect getGlobalBounds() const
Get the global (non-minimal) bounding rectangle of the entity.

sf::Shape::getTextureRect
const IntRect & getTextureRect() const
Get the sub-rectangle of the texture displayed by the shape.

sf::Shape::update
void update()
Recompute the internal geometry of the shape.

sf::Shape::getLocalBounds
FloatRect getLocalBounds() const
Get the local bounding rectangle of the entity.

sf::Shape::getTexture
const Texture * getTexture() const
Get the source texture of the shape.

sf::Shape::setTexture
void setTexture(const Texture *texture, bool resetRect=false)
Change the source texture of the shape.

sf::Shape::getPointCount
virtual std::size_t getPointCount() const =0
Get the total number of points of the shape.

sf::Texture
Image living on the graphics card that can be used for drawing.
Definition Texture.hpp:56

sf::Transformable::Transformable
Transformable()=default
Default constructor.

sf
Definition AudioResource.hpp:36

sf::FloatRect
Rect< float > FloatRect
Definition Rect.hpp:147

sf::IntRect
Rect< int > IntRect
Definition Rect.hpp:146

sf::Vector2f
Vector2< float > Vector2f
Definition Vector2.hpp:210

sf::RenderStates
Define the states used for drawing to a RenderTarget
Definition RenderStates.hpp:48