Rectangle Class Reference

Class for creating rectangles. More...

#include <Rectangle.hpp>

Inheritance diagram for Rectangle:

Public Member Functions
MYGL_EXPORT	Rectangle ()
	Default constructor for the Rectangle class, constructs a grey 10*10 square.
MYGL_EXPORT	Rectangle (int width, int height)
	Constructs a width * height rectangle.
MYGL_EXPORT	Rectangle (int width, int height, int x, int y)
	Constructs a width * heigth rectangle whose center's coordinate is (x,y)
MYGL_EXPORT	~Rectangle () override
	Default destructor.
virtual MYGL_EXPORT void	draw (const glm::mat4 &lookAt, const glm::mat4 &projection) const override
	Draws a rectangle, this method is called by a window.
Public Member Functions inherited from AbstractShape
MYGL_EXPORT	AbstractShape ()
	Default constructor, Initializes a 10 * 10 grey object.
MYGL_EXPORT	AbstractShape (int width, int height)
	Intializes a grey object which dimensions are width * height.
MYGL_EXPORT	AbstractShape (int width, int height, int x, int y)
	Initializes a width * height object whose center is at (x, y);.
virtual MYGL_EXPORT	~AbstractShape ()
	Default destructor.
MYGL_EXPORT glm::vec2	getSize () const noexcept
	Returns the size of the shape.
virtual MYGL_EXPORT void	setPosition (int x, int y, bool center=false)
	Moves the shape to (x,y)
virtual MYGL_EXPORT void	setPosition (const glm::vec2 &pos, bool center=false)
	Moves the shape to a specified position.
virtual MYGL_EXPORT void	setRelativePosition (int x, int y, const my::Camera &camera, bool center=false)
	Moves the shape to a certain position, relative to a camera's position.
virtual MYGL_EXPORT void	setRelativePosition (const glm::vec2 &pos, const my::Camera &camera, bool center=false)
	Moves the shape to a certain position, relative to a camera's position.
virtual MYGL_EXPORT void	move (float x, float y) noexcept
	Moves the shape relative to it's current position.
MYGL_EXPORT glm::vec2	getPosition () const noexcept
	Gives the current position of the shape's center.
MYGL_EXPORT void	setScale (float x, float y) noexcept
	Sets the scale factor applied to the shape.
MYGL_EXPORT void	scale (float x, float y) noexcept
	Modifies the scaling factor.
MYGL_EXPORT glm::vec2	getScale () const noexcept
	Gives the current scaling factor applied to the shape.
MYGL_EXPORT void	setRotation (float angle)
	Sets the rotation applied to the shape.
MYGL_EXPORT void	rotate (float angle)
	Rotates the shape.
MYGL_EXPORT float	getRotation () const noexcept
	Returns the shapes's angle of rotation.
virtual MYGL_EXPORT void	setColor (uint8_t r, uint8_t g, uint8_t b, uint8_t alpha=255) noexcept
	Sets the shape's color from its individual components (ints between 0 and 255)
virtual MYGL_EXPORT void	setColor (const my::Color &color) noexcept
	Sets the shape's color from an existing color.
MYGL_EXPORT my::Color	getColor () const noexcept
	Returns the shape's color.
MYGL_EXPORT void	setOutlineThickness (unsigned int thickness)
	Sets the shape's outline's thickness.
MYGL_EXPORT void	setOutlineColor (const my::Color &color) noexcept
	Sets the shape's outline color.
MYGL_EXPORT void	setOutlineColor (uint8_t r, uint8_t g, uint8_t b, uint8_t alpha=255) noexcept
	Sets the shape's outline color from its individual components (ints between 0 and 255)
MYGL_EXPORT bool	SATCollides (const AbstractShape &shape) const
	Tells wether 2 shapes are overlapping using the separating axis theorem (SAT)
MYGL_EXPORT bool	BBoxCollides (const AbstractShape &shape) const noexcept
	Tells whether 2 shapes are overlapping using their bounding boxes.
virtual MYGL_EXPORT void	setTexture (const my::Texture &texture)
	Attaches a texture to the shape.
MYGL_EXPORT void	setTexture (const std::string &filename)
	Attaches a texture to the shape.
MYGL_EXPORT void	setShader (const ShaderProgram &program)
	Sets the shader used to draw the shape.
MYGL_EXPORT void	setOutlineShader (const ShaderProgram &program)
	Sets the shader used to draw the shape's outline.

Protected Member Functions
virtual std::vector< glm::vec2 >	points () const override
	Gives a list of the rectangle's points.

Static Protected Member Functions
static void	glInit ()
	Initializes the OpenGL buffer objects.

Static Protected Attributes
static unsigned int	VAO
static unsigned int	VBO
static unsigned int	EBO
static const std::array< float, 20 >	vertices
static const std::array< unsigned int, 4 >	indices
Static Protected Attributes inherited from AbstractShape
static constexpr float	pi = std::numbers::pi_v<float>
static my::ShaderProgram	shader
static my::ShaderProgram	texShader

Related Symbols
(Note that these are not member symbols.)
my::Rectangle	line (int x1, int y1, int x2, int y2)
	Creates a line between two points.

Additional Inherited Members
Static Public Attributes inherited from AbstractShape
static const ShaderProgram &	defaultShader
Protected Attributes inherited from AbstractShape
glm::vec2	m_position
glm::vec2	m_originalScale
glm::vec2	m_scaleFactor
float	m_rotationAngle
bool	m_updateMatrix
glm::mat4	m_model
my::Color	m_color
float	m_outlineThickness
my::Color	m_outlineColor
glm::mat4	m_outlineModel
my::Texture	m_texture
bool	m_isTextured
my::ShaderProgram	m_shader
my::ShaderProgram	m_outlineShader

Detailed Description

Class for creating rectangles.

Definition at line 15 of file Rectangle.hpp.

Constructor & Destructor Documentation

Rectangle() [1/2]

MYGL_EXPORT Rectangle	(	int	width,
		int	height )

Constructs a width * height rectangle.

Parameters

width	The rectangle's width
height	The rectangle's height

Rectangle() [2/2]

MYGL_EXPORT Rectangle	(	int	width,
		int	height,
		int	x,
		int	y )

Constructs a width * heigth rectangle whose center's coordinate is (x,y)

Parameters

width	The rectangle's width
height	The rectangle's heigth
x	The x coordinate of the rectangle's center
y	The y coordinate of the rectangle's center

Member Function Documentation

draw()

virtual MYGL_EXPORT void draw ( const glm::mat4 & lookAt, const glm::mat4 & projection ) const

overridevirtual

Draws a rectangle, this method is called by a window.

Parameters

lookAt	The view matrix (usually provided by the window)
projection	The projection matrix (also provided by the window)

Implements AbstractShape.

points()

virtual std::vector< glm::vec2 > points ( ) const

overrideprotectedvirtual

Gives a list of the rectangle's points.

Returns

A std::vector containing every point (represented by a glm::vec2) in clockwise order

Implements AbstractShape.

Friends And Related Symbol Documentation

line()

my::Rectangle line ( int x1, int y1, int x2, int y2 )

related

Creates a line between two points.

Parameters

x1	The first point's x coordinate
y1	The first point's y coordinate
x2	The second point's x coordinate
y2	The second point's y coordinate

Returns

A my::Rectangle representing a line between the 2 points

Member Data Documentation

EBO

unsigned int EBO

staticprotected

Definition at line 20 of file Rectangle.hpp.

indices

const std::array<unsigned int, 4> indices

staticprotected

Definition at line 22 of file Rectangle.hpp.

VAO

unsigned int VAO

staticprotected

Definition at line 18 of file Rectangle.hpp.

VBO

unsigned int VBO

staticprotected

Definition at line 19 of file Rectangle.hpp.

vertices

const std::array<float, 20> vertices

staticprotected

Definition at line 21 of file Rectangle.hpp.

---

The documentation for this class was generated from the following file:

• Rectangle.hpp