Class inherited by all the shapes, it defines common operations on a shape. More...

#include <AbstractShape.hpp>

Inheritance diagram for AbstractShape:

Public Member Functions
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.

virtual MYGL_EXPORT void	draw (const glm::mat4 &lookAt, const glm::mat4 &projection) const =0
	Draws a shape, this method is called by a window.

Static Public Attributes
static const ShaderProgram &	defaultShader

Protected Member Functions
virtual std::vector< glm::vec2 >	points () const =0
	Returns the points composing this shape.

Protected Attributes
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

Static Protected Attributes
static constexpr float	pi = std::numbers::pi_v<float>

static my::ShaderProgram	shader

static my::ShaderProgram	texShader

Detailed Description

Class inherited by all the shapes, it defines common operations on a shape.

Definition at line 20 of file AbstractShape.hpp.

Constructor & Destructor Documentation

◆ AbstractShape() [1/2]

MYGL_EXPORT AbstractShape	(	int	width,
		int	height )

Intializes a grey object which dimensions are width * height.

Parameters

width	The object's width
height	The object's height

◆ AbstractShape() [2/2]

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

Initializes a width * height object whose center is at (x, y);.

Parameters

width	The object's width
height	The object's height
x	x coordinate of the center
y	y coordinate of the center

Member Function Documentation

◆ BBoxCollides()

MYGL_EXPORT bool BBoxCollides ( const AbstractShape & shape ) const

noexcept

Tells whether 2 shapes are overlapping using their bounding boxes.

Parameters

shape The shape to test against

Returns: true if the this shape's bounding rectangle is overlapping with the specified shape's bounding rectangle

This method is less expensive than the SAT one but far less precise (and it doesn't work properly when the shapes are rotated). If you need more precision use the SATCollides method instead.

◆ draw()

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

pure virtual

Draws a shape, 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)

Implemented in Polygon, Rectangle, and Triangle.

◆ getColor()

MYGL_EXPORT my::Color getColor ( ) const

noexcept

Returns the shape's color.

Returns: A my::Color object containing the shape's color

◆ getPosition()

MYGL_EXPORT glm::vec2 getPosition ( ) const

noexcept

Gives the current position of the shape's center.

Returns: The position of the object's center

◆ getRotation()

MYGL_EXPORT float getRotation ( ) const

noexcept

Returns the shapes's angle of rotation.

Returns: The angle of the rotation currently applied to the object

◆ getScale()

MYGL_EXPORT glm::vec2 getScale ( ) const

noexcept

Gives the current scaling factor applied to the shape.

Returns: The scaling factor currently applied

◆ getSize()

MYGL_EXPORT glm::vec2 getSize ( ) const

noexcept

Returns the size of the shape.

Returns: The size of the shape's bounding box

◆ move()

virtual MYGL_EXPORT void move	(	float	x,
		float	y )

virtualnoexcept

Moves the shape relative to it's current position.

Parameters

x	The horizontal offset
y	The vertical offset

◆ points()

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

protectedpure virtual

Returns the points composing this shape.

Returns: The coordinates of each of the shape's points

Implemented in Rectangle.

◆ rotate()

MYGL_EXPORT void rotate ( float angle )

Rotates the shape.

Parameters

angle The angle (in degrees) to add to the current angle of rotation

◆ SATCollides()

MYGL_EXPORT bool SATCollides ( const AbstractShape & shape ) const

Tells wether 2 shapes are overlapping using the separating axis theorem (SAT)

Parameters

shape The shape to test against

Returns: true if the this shape is overlapping with the specified shape

◆ scale()

MYGL_EXPORT void scale	(	float	x,
		float	y )

noexcept

Modifies the scaling factor.

Parameters

x	The value to add to the horizontal scaling factor
y	The value to add to the vertical scaling factor

◆ setColor() [1/2]

virtual MYGL_EXPORT void setColor ( const my::Color & color )

virtualnoexcept

Sets the shape's color from an existing color.

Parameters

color The color to be applied to the shape

◆ setColor() [2/2]

virtual MYGL_EXPORT void setColor	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	alpha = 255 )

virtualnoexcept

Sets the shape's color from its individual components (ints between 0 and 255)

Parameters

r	The red component
g	The green component
b	The blue component
alpha	The alpha (transparency) value, by default 255

◆ setOutlineColor() [1/2]

MYGL_EXPORT void setOutlineColor ( const my::Color & color )

noexcept

Sets the shape's outline color.

Parameters

color The color to be applied

◆ setOutlineColor() [2/2]

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)

Parameters

r	The red component
g	The green component
b	The blue component
alpha	The alpha (transparency) value, by default 255

◆ setOutlineShader()

MYGL_EXPORT void setOutlineShader ( const ShaderProgram & program )

Sets the shader used to draw the shape's outline.

Parameters

program The shader program to use

◆ setOutlineThickness()

MYGL_EXPORT void setOutlineThickness ( unsigned int thickness )

Sets the shape's outline's thickness.

Parameters

thickness The thickness in pixels

◆ setPosition() [1/2]

virtual MYGL_EXPORT void setPosition	(	const glm::vec2 &	pos,
		bool	center = false )

virtual

Moves the shape to a specified position.

Parameters

pos	A glm::vec2 containing the new position
center	If true, set the shape's center at 'pos', else sets its bottom left hand corner. Default value is false

Reimplemented in Triangle.

◆ setPosition() [2/2]

virtual MYGL_EXPORT void setPosition	(	int	x,
		int	y,
		bool	center = false )

virtual

Moves the shape to (x,y)

Parameters

x	The new horizontal position
y	The new vertical popsition
center	If true, set the shape's center at (x,y), else sets its bottom left hand corner at (x,y). Default value is false

Reimplemented in Triangle.

◆ setRelativePosition() [1/2]

virtual MYGL_EXPORT void setRelativePosition	(	const glm::vec2 &	pos,
		const my::Camera &	camera,
		bool	center = false )

virtual

Moves the shape to a certain position, relative to a camera's position.

Parameters

pos	A glm::vec2 containing the new position
camera	A my::Camera
center	If true, set the shape's center at (x,y), else sets its bottom left hand corner at (x,y). Default value is false

◆ setRelativePosition() [2/2]

virtual MYGL_EXPORT void setRelativePosition	(	int	x,
		int	y,
		const my::Camera &	camera,
		bool	center = false )

virtual

Moves the shape to a certain position, relative to a camera's position.

Parameters

x	The new horizontal position in the camera's view
y	The vertical position in the camera's view
camera	A my::Camera
center	If true, set the shape's center at (x,y), else sets its bottom left hand corner at (x,y). Default value is false

◆ setRotation()

MYGL_EXPORT void setRotation ( float angle )

Sets the rotation applied to the shape.

Parameters

angle the angle (in degrees) of rotation

◆ setScale()

MYGL_EXPORT void setScale	(	float	x,
		float	y )

noexcept

Sets the scale factor applied to the shape.

Parameters

x	The horizontal scaling factor
y	The vertical scaling factor

◆ setShader()

MYGL_EXPORT void setShader ( const ShaderProgram & program )

Sets the shader used to draw the shape.

Parameters

program The shader program to use

◆ setTexture() [1/2]

virtual MYGL_EXPORT void setTexture ( const my::Texture & texture )

virtual

Attaches a texture to the shape.

Parameters

texture A texture that has already been initialized

◆ setTexture() [2/2]

MYGL_EXPORT void setTexture ( const std::string & filename )

Attaches a texture to the shape.

Parameters

filename The path to the image, supported formats are jpeg, png, gif (not animated), bmp, tga, psd, hdr, pic, and pnm

Member Data Documentation

◆ defaultShader

const ShaderProgram& defaultShader

static

Definition at line 52 of file AbstractShape.hpp.

◆ m_color

my::Color m_color

protected

Definition at line 36 of file AbstractShape.hpp.

◆ m_isTextured

bool m_isTextured

protected

Definition at line 41 of file AbstractShape.hpp.

◆ m_model

glm::mat4 m_model

mutableprotected

Definition at line 35 of file AbstractShape.hpp.

◆ m_originalScale

glm::vec2 m_originalScale

protected

Definition at line 31 of file AbstractShape.hpp.

◆ m_outlineColor

my::Color m_outlineColor

protected

Definition at line 38 of file AbstractShape.hpp.

◆ m_outlineModel

glm::mat4 m_outlineModel

mutableprotected

Definition at line 39 of file AbstractShape.hpp.

◆ m_outlineShader

my::ShaderProgram m_outlineShader

protected

Definition at line 43 of file AbstractShape.hpp.

◆ m_outlineThickness

float m_outlineThickness

protected

Definition at line 37 of file AbstractShape.hpp.

◆ m_position

glm::vec2 m_position

protected

Definition at line 30 of file AbstractShape.hpp.

◆ m_rotationAngle

float m_rotationAngle

protected

Definition at line 33 of file AbstractShape.hpp.

◆ m_scaleFactor

glm::vec2 m_scaleFactor

protected

Definition at line 32 of file AbstractShape.hpp.

◆ m_shader

my::ShaderProgram m_shader

protected

Definition at line 42 of file AbstractShape.hpp.

◆ m_texture

my::Texture m_texture

protected

Definition at line 40 of file AbstractShape.hpp.

◆ m_updateMatrix

bool m_updateMatrix

mutableprotected

Definition at line 34 of file AbstractShape.hpp.

◆ pi

constexpr float pi = std::numbers::pi_v<float>

staticconstexprprotected

Definition at line 26 of file AbstractShape.hpp.

◆ shader

my::ShaderProgram shader

staticprotected

Definition at line 27 of file AbstractShape.hpp.

◆ texShader

my::ShaderProgram texShader

staticprotected

Definition at line 28 of file AbstractShape.hpp.

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

AbstractShape.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractShape() [1/2]

◆ AbstractShape() [2/2]

Member Function Documentation

◆ BBoxCollides()

◆ draw()

◆ getColor()

◆ getPosition()

◆ getRotation()

◆ getScale()

◆ getSize()

◆ move()

◆ points()

◆ rotate()

◆ SATCollides()

◆ scale()

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setOutlineColor() [1/2]

◆ setOutlineColor() [2/2]

◆ setOutlineShader()

◆ setOutlineThickness()

◆ setPosition() [1/2]

◆ setPosition() [2/2]

◆ setRelativePosition() [1/2]

◆ setRelativePosition() [2/2]

◆ setRotation()

◆ setScale()

◆ setShader()

◆ setTexture() [1/2]

◆ setTexture() [2/2]

Member Data Documentation

◆ defaultShader

◆ m_color

◆ m_isTextured

◆ m_model

◆ m_originalScale

◆ m_outlineColor

◆ m_outlineModel

◆ m_outlineShader

◆ m_outlineThickness

◆ m_position

◆ m_rotationAngle

◆ m_scaleFactor

◆ m_shader

◆ m_texture

◆ m_updateMatrix

◆ pi

◆ shader

◆ texShader