A shape 3D world position and perspective adjusted text, optionally screen facing. More...

#include <3estext3d.h>

Inheritance diagram for tes::Text3D:

Public Member Functions
	Text3D (const char *text, const V3Arg &pos=V3Arg(0, 0, 0), int fontSize=12)

	Text3D (const char *text, const V3Arg &pos, const V3Arg &facing, int fontSize=12)

	Text3D (const char *text, uint32_t id, const V3Arg &pos=V3Arg(0, 0, 0), int fontSize=12)

	Text3D (const char *text, uint32_t id, const V3Arg &pos, const V3Arg &facing, int fontSize=12)

	Text3D (const char *text, uint32_t id, uint16_t category, const V3Arg &pos=V3Arg(0, 0, 0), int fontSize=12)

	Text3D (const char *text, uint32_t id, uint16_t category, const V3Arg &pos, const V3Arg &facing, int fontSize=12)
	Construct a box object. More...

bool	screenFacing () const

Text3D &	setScreenFacing (bool worldSpace)

Text3D &	setFacing (const V3Arg &toCamera)

Vector3f	facing () const

int	fontSize () const

Text3D &	setFontSize (int size)

char *	text () const

uint16_t	textLength () const

Text3D &	setText (const char *text, uint16_t textLength)

virtual bool	writeCreate (PacketWriter &stream) const override
	Writes the create message to `stream`. More...

Shape *	clone () const override
	Deep copy clone. More...

Public Member Functions inherited from tes::Shape
	Shape (uint16_t routingId, uint32_t id=0)

	Shape (uint16_t routingId, uint32_t id, uint16_t category)
	Construct a box object. More...

uint16_t	routingId () const

uint32_t	id () const

Shape &	setId (uint32_t id)

uint16_t	category () const

Shape &	setCategory (uint16_t category)

Shape &	setWireframe (bool wire)
	Sets the wireframe flag value for this shape. More...

bool	isWireframe () const
	Returns true if the wireframe flag is set. More...

Shape &	setTransparent (bool transparent)
	Sets the transparent flag value for this shape. More...

bool	isTransparent () const
	Returns true if the transparent flag is set. More...

Shape &	setTwoSided (bool twoSided)
	Sets the two sided shader flag value for this shape. More...

bool	isTwoSided () const
	Returns true if the two sided shader flag is set. More...

Shape &	setFlags (uint16_t flags)
	Set the full set of `ObjectFlag` values. More...

uint16_t	flags () const
	Retrieve the full set of `ObjectFlag` values. More...

Shape &	setPosition (const V3Arg &pos)

Vector3f	position () const

Shape &	setPosX (float p)

Shape &	setPosY (float p)

Shape &	setPosZ (float p)

Shape &	setRotation (const QuaternionArg &rot)

Quaternionf	rotation () const

Shape &	setScale (const V3Arg &scale)

Vector3f	scale () const

Shape &	setColour (const Colour &colour)

Colour	colour () const

virtual void	updateFrom (const Shape &other)
	Update the attributes of this shape to match `other`. More...

virtual int	writeData (PacketWriter &stream, unsigned &progressMarker) const
	Called only for complex shapes to write additional creation data. More...

bool	writeUpdate (PacketWriter &stream) const

bool	writeDestroy (PacketWriter &stream) const

virtual bool	isComplex () const
	Is this a complex shape? Complex shapes have `writeData()` called. More...

virtual int	enumerateResources (const Resource **resources, int capacity, int fetchOffset=0) const
	Enumerate the resources used by this shape. More...

Static Public Attributes
static const Vector3f	DefaultFacing

Protected Member Functions
void	onClone (Text3D *copy) const

Protected Member Functions inherited from tes::Shape
void	onClone (Shape *copy) const
	Called when `copy` is created from this object to copy appropriate attributes to `copy`. More...

void	init (uint32_t id, uint16_t cat=0, uint16_t flags=0)

Additional Inherited Members
Protected Attributes inherited from tes::Shape
uint16_t	_routingId

CreateMessage	_data

Detailed Description

A shape 3D world position and perspective adjusted text, optionally screen facing.

Expects UTF-8 encoding.

FIXME: add rotation support to the text, identifying the orientation axes.

Constructor & Destructor Documentation

◆ Text3D()

tes::Text3D::Text3D	(	const char *	text,
		uint32_t	id,
		uint16_t	category,
		const V3Arg &	pos,
		const V3Arg &	facing,
		int	fontSize = `12`
	)

inline

Construct a box object.

Parameters

id	The shape ID, unique among `Arrow` objects, or zero for a transient shape.
category	The category grouping for the shape used for filtering.

References tes::CreateMessage::attributes, tes::Vector3< T >::axisx, tes::Vector3< T >::dot(), tes::CreateMessage::flags, tes::ObjectAttributes::scale, tes::Quaternion< T >::setAxisAngle(), tes::Text3DFScreenFacing, and tes::V3Arg::v3.

Member Function Documentation

◆ clone()

Shape* tes::Text3D::clone ( ) const

overridevirtual

Deep copy clone.

Returns: A deep copy.

Reimplemented from tes::Shape.

◆ writeCreate()

virtual bool tes::Text3D::writeCreate ( PacketWriter & stream ) const

overridevirtual

Writes the create message to stream.

Simple shapes will write all data in the create message. More complex shapes may have additional data which is required to create object (e.g., point clouds). In the latter case, only enough data to initialise the object need be written.

Reimplemented from tes::Shape.

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

3estext3d.h

Public Member Functions

Static Public Attributes