#include <Sprite.hpp>

Inheritance diagram for smk::Sprite:

[legend]

Description

A Drawable specialised in displaying rectangular texture.

Example:

auto sprite = smk::Sprite(texture_ball);
 
sprite.SetCenter(32,32);
sprite.SetPosition(player.x, player.y);
sprite.SetRotation(player.rotation);
 
window.Draw(sprite);

Examples: framebuffer.cpp, sprite.cpp, sprite_move.cpp, and texture_subrectangle.cpp.

Definition at line 34 of file Sprite.hpp.

Public Member Functions
	Sprite (const Texture &texture)
	A Sprite for drawing a texture. More...

	Sprite (const Texture &texture, const Rectangle rectangle)
	A Sprite for drawing a part of a Texture. More...

	Sprite (Framebuffer &framebuffer)
	A sprite for drawing the content of a Framebuffer. More...

	Sprite (Sprite &&)=default

	Sprite (const Sprite &)=default

Sprite &	operator= (Sprite &&)=default

Sprite &	operator= (const Sprite &)=default

void	SetTexture (const Texture &texture)
	Update the sprite's texture. More...

void	SetTextureRectangle (const Rectangle &rectangle)
	Update the sprite texture area. More...

void	SetCenter (float center_x, float center_y)
	Set the center of the object. It is used as the rotation center. The center of the object will be drawn exactly on (0,0) on the screen (plus its potential translation if any) More...

void	SetCenter (const glm::vec2 &center)
	Set the center of the object. It is used as the rotation center. The center of the object will be drawn exactly on (0,0) on the screen (plus its potential translation if any) More...

void	Move (const glm::vec2 &move)

void	Move (float x, float y)

void	SetPosition (float x, float y)
	Set the position of the object to be drawn. More...

void	SetPosition (const glm::vec2 &position)
	Set the position of the object to be drawn. More...

void	Rotate (float rotation)
	Increase the rotation of the object to apply before drawing it. More...

void	SetRotation (float rotation)
	Set the rotation to apply before drawing the object. More...

void	SetScale (float scale)
	Increase or decrease the size of the object being drawn. More...

void	SetScale (const glm::vec2 &scale)
	Increase or decrease the size of the object being drawn. More...

void	SetScale (float scale_x, float scale_y)
	Increase or decrease the size of the object being drawn. More...

void	SetScaleX (float scale_x)
	Increase or decrease the size of the object being drawn. More...

void	SetScaleY (float scale_y)
	Increase or decrease the size of the object being drawn. More...

glm::mat4	transformation () const override
	Increase or decrease the size of the object being drawn. More...

void	SetColor (const glm::vec4 &color)
	Color. More...

const glm::vec4 &	color () const

void	SetTexture (Texture texture)
	Set the object's texture. More...

const Texture &	texture () const

void	SetBlendMode (const BlendMode &)
	Set the blending mode to be used for drawing the object. More...

const BlendMode &	blend_mode () const

void	SetVertexArray (VertexArray vertex_array)
	Set the object's shape. More...

const VertexArray &	vertex_array () const

void	Draw (RenderTarget &target, RenderState state) const override

Constructor & Destructor Documentation

◆ Sprite() [1/3]

smk::Sprite::Sprite ( const Texture & texture )

A Sprite for drawing a texture.

Parameters

texture The Texture to be displayed.

Definition at line 16 of file Sprite.cpp.

                                     : Sprite() {
  SetTexture(texture);
}

◆ Sprite() [2/3]

smk::Sprite::Sprite	(	const Texture &	texture,
		const Rectangle	rectangle
	)

A Sprite for drawing a part of a Texture.

Parameters

texture	The Texture to be displayed.
rectangle	A rectangle in the texture to be used.

Definition at line 23 of file Sprite.cpp.

                                                                {
  Transformable::SetTexture(texture);
  SetTextureRectangle(rectangle);
}

◆ Sprite() [3/3]

smk::Sprite::Sprite ( Framebuffer & framebuffer )

explicit

A sprite for drawing the content of a Framebuffer.

Parameters

framebuffer The framebuffer to be used.

Definition at line 30 of file Sprite.cpp.

                                       {
  Transformable::SetTexture(framebuffer.color_texture());
  float l = 0.F;
  float r = 1.F;
  float t = 0.F;
  float b = 1.F;
  auto www = float(framebuffer.color_texture().width());
  auto hhh = float(framebuffer.color_texture().height());
  SetVertexArray(VertexArray(std::vector<Vertex>({
      {{0.F, 0.F}, {l, b}},
      {{0.F, hhh}, {l, t}},
      {{www, hhh}, {r, t}},
      {{0.F, 0.F}, {l, b}},
      {{www, hhh}, {r, t}},
      {{www, 0.F}, {r, b}},
  })));
}

Member Function Documentation

◆ blend_mode()

const BlendMode & smk::TransformableBase::blend_mode ( ) const

inlineinherited

Definition at line 36 of file Transformable.hpp.

36{ return blend_mode_; }

◆ color()

const glm::vec4 & smk::TransformableBase::color ( ) const

inlineinherited

Definition at line 28 of file Transformable.hpp.

28{ return color_; }

◆ Draw()

void smk::TransformableBase::Draw	(	RenderTarget &	target,
		RenderState	state
	)		const

overridevirtualinherited

Draw the object on a RenderTarget.

Parameters

target	A RenderTarget to be drawn on.
state	The RenderState to derive from.

Implements smk::Drawable.

Definition at line 147 of file Transformable.cpp.

                                                                          {
  state.color *= color();
  state.texture = texture();
  state.view *= transformation();
  state.vertex_array = vertex_array();
  state.blend_mode = blend_mode();
  target.Draw(state);
}

◆ Move() [1/2]

void smk::Transformable::Move ( const glm::vec2 & move )

inherited

Increase the position of the object being drawn.

See also: smk::SetPosition

Parameters

move	The increment of position (x,y)

Examples: texture_subrectangle.cpp.

Definition at line 44 of file Transformable.cpp.

                                            {
  position_ += move;
}

◆ Move() [2/2]

void smk::Transformable::Move	(	float	x,
		float	y
	)

inherited

Increase the position of the object being drawn.

See also: smk::SetPosition

Parameters

x	The increment of position along the horizontal axis.
y	The increment of position along the vertical axis.

Definition at line 52 of file Transformable.cpp.

                                         {
  Move({x, y});
}

◆ Rotate()

void smk::Transformable::Rotate ( float rotation )

inherited

Increase the rotation of the object to apply before drawing it.

See also: Transformable::SetRotation.

Parameters

rotation The delta of rotation to be added.

Definition at line 22 of file Transformable.cpp.

                                         {
  rotation_ += rotation;
}

◆ SetBlendMode()

void smk::TransformableBase::SetBlendMode ( const BlendMode & blend_mode )

inherited

Set the blending mode to be used for drawing the object.

Parameters

blend_mode the BlendMode to be used.

Definition at line 133 of file Transformable.cpp.

                                                                {
  blend_mode_ = blend_mode;
}

◆ SetCenter() [1/2]

void smk::Transformable::SetCenter ( const glm::vec2 & center )

inherited

Set the center of the object. It is used as the rotation center. The center of the object will be drawn exactly on (0,0) on the screen (plus its potential translation if any)

Parameters

center The center position (x,y) in the object.

Definition at line 60 of file Transformable.cpp.

                                                   {
  center_ = center;
}

◆ SetCenter() [2/2]

void smk::Transformable::SetCenter	(	float	x,
		float	y
	)

inherited

Set the center of the object. It is used as the rotation center. The center of the object will be drawn exactly on (0,0) on the screen (plus its potential translation if any)

Parameters

x	The center position along the horizontal axis.
y	The center position along the vertical axis.

Examples: sprite_move.cpp.

Definition at line 69 of file Transformable.cpp.

                                              {
  SetCenter({x, y});
}

◆ SetColor()

void smk::TransformableBase::SetColor ( const glm::vec4 & color )

inherited

Color.

Modify the color of the object. The resulting pixel is the multiplication component wise in between this color and the original pixel color.

Parameters

color The color.

Examples: rounded_rectangle.cpp, and shape_2d.cpp.

Definition at line 127 of file Transformable.cpp.

                                                     {
  color_ = color;
}

◆ SetPosition() [1/2]

void smk::Transformable::SetPosition ( const glm::vec2 & position )

inherited

Set the position of the object to be drawn.

See also: Transformable::Move.

Parameters

position the position (x,y) of the object.

Definition at line 29 of file Transformable.cpp.

                                                       {
  position_ = position;
}

◆ SetPosition() [2/2]

void smk::Transformable::SetPosition	(	float	x,
		float	y
	)

inherited

Set the position of the object to be drawn.

See also: Transformable::Move.

Parameters

x	The position along the horizontal axis.
y	The position along the vertical axis.

Examples: sprite_move.cpp.

Definition at line 37 of file Transformable.cpp.

                                                {
  position_ = {x, y};
}

◆ SetRotation()

void smk::Transformable::SetRotation ( float rotation )

inherited

Set the rotation to apply before drawing the object.

See also: Transformable::Rotate.

Parameters

rotation The angle in radian.

Definition at line 15 of file Transformable.cpp.

                                              {
  rotation_ = rotation;
}

◆ SetScale() [1/3]

void smk::Transformable::SetScale ( const glm::vec2 & scale )

inherited

Increase or decrease the size of the object being drawn.

Parameters

scale The ratio of magnification.

Definition at line 81 of file Transformable.cpp.

                                                 {
  scale_ = scale;
}

◆ SetScale() [2/3]

void smk::Transformable::SetScale ( float scale )

inherited

Increase or decrease the size of the object being drawn.

Parameters

scale The ratio of magnification.

Examples: sprite_move.cpp.

Definition at line 75 of file Transformable.cpp.

                                        {
  SetScale({scale, scale});
}

◆ SetScale() [3/3]

void smk::Transformable::SetScale	(	float	scale_x,
		float	scale_y
	)

inherited

Increase or decrease the size of the object being drawn.

Parameters

scale_x	The ratio of magnification along the horizontal axis.
scale_y	The ratio of magnification along the vertical axis.

Definition at line 88 of file Transformable.cpp.

                                                         {
  scale_.x = scale_x;
  scale_.y = scale_y;
}

◆ SetScaleX()

void smk::Transformable::SetScaleX ( float scale_x )

inherited

Increase or decrease the size of the object being drawn.

Parameters

scale_x The ratio of magnification along the horizontal axis.

Definition at line 95 of file Transformable.cpp.

                                           {
  scale_.x = scale_x;
}

◆ SetScaleY()

void smk::Transformable::SetScaleY ( float scale_y )

inherited

Increase or decrease the size of the object being drawn.

Parameters

scale_y The ratio of magnification along the vertical axis.

Definition at line 101 of file Transformable.cpp.

                                           {
  scale_.y = scale_y;
}

◆ SetTexture() [1/2]

void smk::Sprite::SetTexture ( const Texture & texture )

Update the sprite's texture.

Parameters

texture The Texture to be displayed.

Definition at line 50 of file Sprite.cpp.

                                              {
  Transformable::SetTexture(texture);
  SetTextureRectangle({
      0.F,
      0.F,
      float(texture.width()),
      float(texture.height()),
  });
}

◆ SetTexture() [2/2]

void smk::TransformableBase::SetTexture ( Texture texture )

inherited

Set the object's texture.

Definition at line 138 of file Transformable.cpp.

                                                  {
  texture_ = std::move(texture);
}

◆ SetTextureRectangle()

void smk::Sprite::SetTextureRectangle ( const Rectangle & rectangle )

Update the sprite texture area.

Parameters

texture	The Texture to be displayed.
rectangle	A rectangle in the texture to be used.

Definition at line 63 of file Sprite.cpp.

                                                           {
  float l = (rectangle.left + 0.5F) / texture().width();     // NOLINT
  float r = (rectangle.right - 0.5F) / texture().width();    // NOLINT
  float t = (rectangle.top + 0.5F) / texture().height();     // NOLINT
  float b = (rectangle.bottom - 0.5F) / texture().height();  // NOLINT
  float www = rectangle.width();
  float hhh = rectangle.height();
  SetVertexArray(VertexArray(std::vector<Vertex>({
      {{0.F, 0.F}, {l, t}},
      {{0.F, hhh}, {l, b}},
      {{www, hhh}, {r, b}},
      {{0.F, 0.F}, {l, t}},
      {{www, hhh}, {r, b}},
      {{www, 0.F}, {r, t}},
  })));
}

◆ SetVertexArray()

void smk::TransformableBase::SetVertexArray ( VertexArray vertex_array )

inherited

Set the object's shape.

Definition at line 143 of file Transformable.cpp.

                                                               {
  vertex_array_ = std::move(vertex_array);
}

◆ texture()

const Texture & smk::TransformableBase::texture ( ) const

inlineinherited

Definition at line 32 of file Transformable.hpp.

32{ return texture_; }

◆ transformation()

glm::mat4 smk::Transformable::transformation ( ) const

overridevirtualinherited

Increase or decrease the size of the object being drawn.

Returns: the transformation applied to the object. This is the result of applying the translation, rotation, center and scaling to the the object.

Implements smk::TransformableBase.

Definition at line 109 of file Transformable.cpp.

                                            {
  glm::mat4 ret = glm::mat4(1.0);
  ret = glm::translate(ret, {position_.x, position_.y, 0.0});
  if (rotation_ != 0.F) {
    ret =
        // NOLINTNEXTLINE
        glm::rotate(ret, -rotation_ * (2.F * 3.1415F / 360.F), {0.0, 0.0, 1.0});
  }
  ret =
      glm::translate(ret, {-center_.x * scale_.x, -center_.y * scale_.y, 0.F});
  ret = glm::scale(ret, {scale_.x, scale_.y, 1.0});
  return ret;
}

◆ vertex_array()

const VertexArray & smk::TransformableBase::vertex_array ( ) const

inlineinherited

Definition at line 40 of file Transformable.hpp.

40{ return vertex_array_; }

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

/home/arthursonzogni/programmation/real/smk/include/smk/Sprite.hpp
/home/arthursonzogni/programmation/real/smk/src/smk/Sprite.cpp

Description

Example:

Public Member Functions

Constructor & Destructor Documentation

◆ Sprite() [1/3]

◆ Sprite() [2/3]

◆ Sprite() [3/3]

Member Function Documentation

◆ blend_mode()

◆ color()

◆ Draw()

◆ Move() [1/2]

◆ Move() [2/2]

◆ Rotate()

◆ SetBlendMode()

◆ SetCenter() [1/2]

◆ SetCenter() [2/2]

◆ SetColor()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ SetRotation()

◆ SetScale() [1/3]

◆ SetScale() [2/3]

◆ SetScale() [3/3]

◆ SetScaleX()

◆ SetScaleY()

◆ SetTexture() [1/2]

◆ SetTexture() [2/2]

◆ SetTextureRectangle()

◆ SetVertexArray()

◆ texture()

◆ transformation()

◆ vertex_array()