#include <Text.hpp>

Inheritance diagram for smk::Text:

[legend]

A class for displaying text. More...

Description

A class for displaying text.

A Text uses the Font's glyphs and displays them to the screen. A Text is a Transformable object, so you can move/rotate/scale/colorize it.

Example:

auto font = smk::Font("./arial.ttf", 32);
 
[...]
 
auto text = smk::Text(font, "The SMK library can draw text");
 
text.SetPosition(300,300);
text.SetColor(smk::Color::White);
 
window.Draw(text);

Examples: sound.cpp, text.cpp, and vibrate.cpp.

Definition at line 37 of file Text.hpp.

Public Member Functions
	Text ()
	Construct a null Text. It can't be drawn. More...

	Text (Font &font)
	Constructor. More...

	Text (Font &font, const std::string &text)
	Constructor. More...

	Text (Font &font, const std::wstring &text)
	Constructor. More...

void	SetString (const std::wstring &wide_string)
	Update the text to be drawn. More...

void	SetString (const std::string &string)
	Update the text to be drawn. More...

void	SetFont (Font &font)
	Update the Font to be used. More...

void	Draw (RenderTarget &target, RenderState state) const override
	Draw the Text to the screen. More...

glm::vec2	ComputeDimensions () const

	Text (Text &&)=default

	Text (const Text &)=default

Text &	operator= (Text &&) noexcept=default

Text &	operator= (const Text &)=default

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

Public Attributes
Font *	font_ = nullptr

std::wstring	string_

Constructor & Destructor Documentation

◆ Text() [1/4]

smk::Text::Text ( )

default

Construct a null Text. It can't be drawn.

◆ Text() [2/4]

smk::Text::Text ( Font & font )

Constructor.

Parameters

font	The Font to be used for drawing glyphs.

Definition at line 126 of file Text.cpp.

                     {
  SetFont(font);
}

◆ Text() [3/4]

smk::Text::Text	(	Font &	font,
		const std::string &	text
	)

Constructor.

Parameters

font	The Font to be used for drawing glyphs.
text	The character string to be drawn.

Definition at line 133 of file Text.cpp.

                                            : Text(font) {
  SetString(text);
}

◆ Text() [4/4]

smk::Text::Text	(	Font &	font,
		const std::wstring &	text
	)

Constructor.

Parameters

font	The Font to be used for drawing glyphs.
text	The character string to be drawn.

Definition at line 140 of file Text.cpp.

                                             : Text(font) {
  SetString(text);
}

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_; }

◆ ComputeDimensions()

glm::vec2 smk::Text::ComputeDimensions ( ) const

Compute the dimension of the text when drawn to the screen.

Returns: a tuple (width,height).

Definition at line 207 of file Text.cpp.

                                      {
  glm::vec2 dimension(0.f, 0.f);
  float advance_x = 0.f;
  dimension.y += font_->line_height();
  for (const auto& it : string_) {
    if (it == U'\n') {
      advance_x = 0.f;
      dimension.y += font_->line_height();
      continue;
    }
    auto* character = font_->FetchGlyph(it);
    if (!character) {
      continue;
    }
    advance_x += character->advance;
 
    dimension.x = std::max(dimension.x, advance_x);
  }
  return dimension;
}

◆ Draw()

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

overridevirtual

Draw the Text to the screen.

Implements smk::Drawable.

Definition at line 160 of file Text.cpp.

                                                             {
  state.color *= color();
  glm::mat4 transformation = state.view * this->transformation();
  float advance_x = 0.f;
  float advance_y = font_->baseline_position();
 
  state.vertex_array = VertexArray(std::vector<Vertex>({
      {{0.f, 0.f}, {0.f, 0.f}},
      {{0.f, 1.f}, {0.f, 1.f}},
      {{1.f, 1.f}, {1.f, 1.f}},
      {{0.f, 0.f}, {0.f, 0.f}},
      {{1.f, 1.f}, {1.f, 1.f}},
      {{1.f, 0.f}, {1.f, 0.f}},
  }));
 
  for (const auto& it : string_) {
    if (it == U'\n') {
      advance_x = 0.f;
      advance_y += font_->line_height();
      continue;
    }
 
    auto* character = font_->FetchGlyph(it);
    if (!character) {
      continue;
    }
 
    if (character->texture.id()) {
      const float x = advance_x + float(character->bearing.x);
      const float y = advance_y + float(character->bearing.y);
      const float w = float(character->texture.width());
      const float h = float(character->texture.height());
      state.texture = character->texture;
      state.view = transformation * glm::mat4(w, 0.f, 0.f, 0.f,    //
                                              0.f, h, 0.f, 0.f,    //
                                              0.f, 0.f, 1.f, 0.f,  //
                                              x, y, 0.f, 1.f       //
                                    );
 
      target.Draw(state);
    }
    advance_x += character->advance;
  }
}

◆ 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;
}

◆ SetFont()

void smk::Text::SetFont ( Font & font )

Update the Font to be used.

Definition at line 155 of file Text.cpp.

                             {
  font_ = &font;
}

◆ 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;
}

◆ SetString() [1/2]

void smk::Text::SetString ( const std::string & string )

Update the text to be drawn.

Definition at line 150 of file Text.cpp.

                                            {
  string_ = to_wstring(string);
}

◆ SetString() [2/2]

void smk::Text::SetString ( const std::wstring & wide_string )

Update the text to be drawn.

Definition at line 145 of file Text.cpp.

                                                  {
  string_ = wide_string;
}

◆ SetTexture()

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

inherited

Set the object's texture.

Definition at line 138 of file Transformable.cpp.

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

◆ 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_; }

Member Data Documentation

◆ font_

Font* smk::Text::font_ = nullptr

Definition at line 59 of file Text.hpp.

◆ string_

std::wstring smk::Text::string_

Definition at line 60 of file Text.hpp.

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

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

Description

Example:

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ Text() [1/4]

◆ Text() [2/4]

◆ Text() [3/4]

◆ Text() [4/4]

Member Function Documentation

◆ blend_mode()

◆ color()

◆ ComputeDimensions()

◆ Draw()

◆ Move() [1/2]

◆ Move() [2/2]

◆ Rotate()

◆ SetBlendMode()

◆ SetCenter() [1/2]

◆ SetCenter() [2/2]

◆ SetColor()

◆ SetFont()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ SetRotation()

◆ SetScale() [1/3]

◆ SetScale() [2/3]

◆ SetScale() [3/3]

◆ SetScaleX()

◆ SetScaleY()

◆ SetString() [1/2]

◆ SetString() [2/2]

◆ SetTexture()

◆ SetVertexArray()

◆ texture()

◆ transformation()

◆ vertex_array()

Member Data Documentation

◆ font_

◆ string_