#include <StkTextRenderItem.h>

Inheritance diagram for STK::TextRenderItem:

Public Member Functions
	TextRenderItem (const std::string &text, std::shared_ptr< TextureFont > font, TextHAlignment h_anchor=TextHAlignment::Left, TextVAlignment v_anchor=TextVAlignment::Bottom, float glyphSpacing=0.0)

	TextRenderItem (const std::shared_ptr< VertexBuffer2D > &vtx_buffer, const std::string &text, std::shared_ptr< TextureFont > font, TextHAlignment h_anchor=TextHAlignment::Left, TextVAlignment v_anchor=TextVAlignment::Bottom, float glyphSpacing=0.0)

	TextRenderItem (std::shared_ptr< TextItem > text_item)
	Initialize a new text rendering item from the given text item.

const std::shared_ptr< TextItem > &	getTextItem () const
	Returns the underlying text item.

void	setColor (const STK::Color4f &color)
	Set foreground text color.

const STK::Color4f &	getColor () const

void	setBackgroundColor (const STK::Color4f &color)

const STK::Color4f &	getBackgroundColor () const

void	setDrawBackground (bool draw_bg)

bool	getDrawBackground () const

void	setCornerRadius (float corner_radius)

float	getCornerRadius () const

void	setText (const std::string &text)

void	setPadding (float pad)

void	setPadding (float v_pad, float h_pad)

void	setPadding (float top_pad, float h_pad, float bot_pad)

void	setPadding (float top_pad, float right_pad, float bot_pad, float left_pad)

const STK::Vector4f &	getPaddingVector ()

void	setPaddingVector (const STK::Vector4f &padding)

float	getPadding () const

float	getPaddingTop () const

float	getPaddingRight () const

float	getPaddingBottom () const

float	getPaddingLeft () const

void	drawBackgroundRectangle ()
	Draw (possibly rounded) background rectangle.

void	render (GraphicsRender2D &renderer, const STK::Matrix4x4f &pj, const STK::Matrix4x4f &vm, const STK::Viewport &vp) override

int	getBatchId () const override

void	cleanupBuffers () override

void	setOffset (float x, float y)
	Set 2D offset position of the text (in pixels). This method will invalidate the transform and cause it to be recalculated on the next frame.

void	setOffsetAngle (float angle)
	Set offset rotation angle for the text item. Positive rotation direction is counter-clockwise. This rotation is relative to setOffset(), so that the entire label will rotate on an offset vector (in pixels) about the position defined by setPosition(). This method will invalidate the transform and cause it to be recalculated on the next frame.

float	getOffsetAngle () const

void	setOffset (const STK::Vector2f &offset)
	Same as above.

const STK::Vector2f &	getOffset () const

const STK::Matrix4x4f &	getTextTransform ()

void	setKeepUpright (bool keep_upright)

bool	keepUpright () const

void	updateViewportScaling (const STK::Matrix4x4f &mv)

void	setTextBoundingBox (std::optional< OrientedBoundingBox2f > bbox)

std::optional< OrientedBoundingBox2f >	getTextBoundingBox () const

virtual STK::Box2< float >	getVisibleBoundingBox () const
	Get the visible bounding box for the text, relative to the position of the text item. For SDF fonts, the geometry of each glyph stretches outside the actual border of the visible glyph. For normal texture fonts, the visible bounding box is simply given by the text item width/height.

STK::Box2< float >	getViewBoundingBox (const STK::Matrix4x4f &mvp, const STK::Viewport &glVp, bool reverse_y=false) override
	Get bounding box in viewport pixel coordinates.

Public Member Functions inherited from STK::RenderItem2D
virtual void	render (GraphicsRender2D &renderer, const STK::Matrix4x4f &pj, const STK::Matrix4x4f &vm, const STK::Viewport &vp)=0

virtual void	cleanupBuffers ()=0

virtual int	getBatchId () const =0

void	setDepth (float depth)

float	getDepth () const

void	setStencilValue (unsigned char stencil_value)
	Set value for stencil operations.

unsigned char	getStencilValue () const
	Get value for stencil operations.

void	setStencilMode (StencilMode mode)
	Stencil buffer operations.

StencilMode	getStencilMode () const
	Stencil buffer operations.

const STK::Matrix4x4f &	getTransform ()

void	setPosition (float x, float y)
	Set 2D position of the item. This method will invalidate the transform and cause it to be recalculated on the next frame.

void	setPosition (const STK::Vector2f &pos)
	Same as above.

void	setPositionX (float x)
	Set X position separately.

void	setPositionY (float y)
	Set Y position separately.

const STK::Vector2f &	getPosition () const

float	getPositionX () const

float	getPositionY () const

void	setScale (const STK::Vector2f &scale)

void	setScale (float scale)
	Set scale factor for the text item. This method will invalidate the transform and cause it to be recalculated on the next frame.

STK::Vector2f	getScale () const
	Returns current scale factor for the item.

void	setAngle (float angle)
	Set rotation angle for the item. Positive rotation direction is counter-clockwise. This method will invalidate the transform and cause it to be recalculated on the next frame.

float	getAngle () const

void	setTransform (const STK::Matrix4x4f &transform)
	Set transform directly. This method will set the transformation matrix for this item directly. This will override any values for setPosition(), setScale(), setDepth() and setAngle(). Also, any subsequent calls to these methods will again override this method. In short, either use setTransform() or setPosition/Scale/Angle/Depth.

void	setPreTransform (const STK::Matrix4x4f &transform)

void	setPostTransform (const STK::Matrix4x4f &transform)

std::optional< STK::Matrix4x4f >	getPreTransform () const

std::optional< STK::Matrix4x4f >	getPostTransform () const

void	setOpacity (float opacity)

float	getOpacity () const

virtual STK::Box2< float >	getViewBoundingBox (const STK::Matrix4x4f &mvp, const STK::Viewport &glVp, bool reverse_y=false)=0
	Get bounding box in viewport pixel coordinates.

Protected Member Functions
void	updateTransform () override

void	setViewportScale (const float scale)

Protected Member Functions inherited from STK::RenderItem2D
virtual void	updateTransform ()

void	setViewScale (float x, float y)

Protected Attributes
std::shared_ptr< TextItem >	text_item_

STK::Matrix4x4f	text_transform_

STK::Vector2f	offset_

float	offset_angle_ = 0.0f

STK::Color4f	color_ = STK::Color4f(0.0f, 0.0f, 0.0f, 1.0f)

STK::Color4f	bg_color_ = STK::Color4f(0.0f, 0.0f, 0.0f, 0.0f)

bool	draw_bg_ = false

bool	keep_upright_ = false

STK::Vector4f	padding_

float	corner_radius_ = 0.0f

bool	bg_dirty_ = false

std::shared_ptr< STK::VertexBuffer2D >	bg_vtx_buf_

float	viewportScale_ = 1.0f

std::optional< OrientedBoundingBox2f >	textBbox_

Protected Attributes inherited from STK::RenderItem2D
float	depth_ = 0

STK::Matrix4x4f	transform_

STK::Vector2f	pos_

float	angle_ = 0.0f

float	opacity_ = 1.0f

STK::Vector2f	scale_ { 1.0f, 1.0f }

bool	transform_dirty_ = false

std::optional< STK::Matrix4x4f >	pre_transform_

std::optional< STK::Matrix4x4f >	post_transform_

std::mutex	xfm_mutex_

unsigned char	stencil_value_ = 0

StencilMode	stencil_mode_ = StencilMode::NONE

float	view_scale_x_ = 1.0f

float	view_scale_y_ = 1.0f

Detailed Description

TextRenderItem - Rendering of an STK::TextItem. This class is used in conjunction with STK::GraphicsRender2D for efficient rendering of texts.

Constructor & Destructor Documentation

◆ TextRenderItem()

STK::TextRenderItem::TextRenderItem ( std::shared_ptr< TextItem > text_item )

explicit

Initialize a new text rendering item from the given text item.

Parameters

text_item

Member Function Documentation

◆ cleanupBuffers()

void STK::TextRenderItem::cleanupBuffers ( )

overridevirtual

Clean up OpenGL graphics objects This method should clean up all OpenGL related buffers and objects. This is normally called by GraphicsRender2D::cleanup()

Implements STK::RenderItem2D.

◆ getBatchId()

int STK::TextRenderItem::getBatchId ( ) const

overridevirtual

Render batch id. This number indicates which item should be rendered together if the depths are equal.

Implements STK::RenderItem2D.

Reimplemented in STK::TextRenderItemSDF.

◆ getTextItem()

const std::shared_ptr< TextItem > & STK::TextRenderItem::getTextItem ( ) const

inline

Returns the underlying text item.

Returns

◆ getViewBoundingBox()

STK::Box2< float > STK::TextRenderItem::getViewBoundingBox	(	const STK::Matrix4x4f &	mvp,
		const STK::Viewport &	glVp,
		bool	reverse_y = `false`
	)

overridevirtual

Get bounding box in viewport pixel coordinates.

Parameters

mvp	Projection/Modelview matrix.
glVp	OpenGL viewport
reverse_y	If true, any pixel coordinate calculations are using positive y direction downwards. This applies for example to text and icon items which have separate pixel coordinate transforms.

Returns: Min/Max coordinates for the object in pixel coordinates.

Implements STK::RenderItem2D.

◆ getVisibleBoundingBox()

STK::Box2< float > STK::TextRenderItem::getVisibleBoundingBox ( ) const

virtual

Get the visible bounding box for the text, relative to the position of the text item. For SDF fonts, the geometry of each glyph stretches outside the actual border of the visible glyph. For normal texture fonts, the visible bounding box is simply given by the text item width/height.

Reimplemented in STK::TextRenderItemSDF.

◆ render()

void STK::TextRenderItem::render	(	GraphicsRender2D &	renderer,
		const STK::Matrix4x4f &	pj,
		const STK::Matrix4x4f &	vm,
		const STK::Viewport &	vp
	)

overridevirtual

Render item into the current frame. This method should render a single item into the GraphicsRender2D.

Implements STK::RenderItem2D.

Reimplemented in STK::TextRenderItemSDF.

◆ setColor()

void STK::TextRenderItem::setColor ( const STK::Color4f & color )

inline

Set foreground text color.

Parameters

color

◆ setOffset() [1/2]

void STK::TextRenderItem::setOffset ( const STK::Vector2f & offset )

inline

Same as above.

Parameters

offset New position (in pxels).

◆ setOffset() [2/2]

void STK::TextRenderItem::setOffset	(	float	x,
		float	y
	)

inline

Set 2D offset position of the text (in pixels). This method will invalidate the transform and cause it to be recalculated on the next frame.

It is important to note, that this is in OpenGL pixel coordinates, where positive Y is upwards.

Parameters

x	X position (in pixels)
y	Y position (in pixels)

◆ setOffsetAngle()

void STK::TextRenderItem::setOffsetAngle ( float angle )

inline

Set offset rotation angle for the text item. Positive rotation direction is counter-clockwise. This rotation is relative to setOffset(), so that the entire label will rotate on an offset vector (in pixels) about the position defined by setPosition(). This method will invalidate the transform and cause it to be recalculated on the next frame.

Parameters

angle Rotation angle (in degrees).

◆ updateTransform()

void STK::TextRenderItem::updateTransform ( )

overrideprotectedvirtual

Reimplemented from STK::RenderItem2D.

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

Native/SilentToolkit/StkScene/StkTextRenderItem.h
Native/SilentToolkit/StkScene/StkTextRenderItem.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TextRenderItem()

Member Function Documentation

◆ cleanupBuffers()

◆ getBatchId()

◆ getTextItem()

◆ getViewBoundingBox()

◆ getVisibleBoundingBox()

◆ render()

◆ setColor()

◆ setOffset() [1/2]

◆ setOffset() [2/2]

◆ setOffsetAngle()

◆ updateTransform()