This defines the set of visual properties that may be assigned to the individual characters of the text. More...

#include "textProperties.h"

Inheritance diagram for TextProperties:

Public Types
enum	Alignment { A_left, A_right, A_center, A_boxed_left, A_boxed_right, A_boxed_center }

enum	Direction { D_ltr, D_rtl }

Public Member Functions
	TextProperties (const TextProperties &copy)

void	add_properties (const TextProperties &other)
	Sets any properties that are explicitly specified in other on this object. More...

void	clear ()
	Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state. More...

void	clear_align ()

void	clear_bin ()

void	clear_direction ()

void	clear_draw_order ()

void	clear_font ()

void	clear_glyph_scale ()

void	clear_glyph_shift ()

void	clear_indent ()

void	clear_preserve_trailing_whitespace ()

void	clear_shadow ()

void	clear_shadow_color ()

void	clear_slant ()

void	clear_small_caps ()

void	clear_small_caps_scale ()

void	clear_tab_width ()

void	clear_text_color ()

void	clear_text_scale ()

void	clear_underscore ()

void	clear_underscore_height ()

void	clear_wordwrap ()

Alignment	get_align () const

const std::string &	get_bin () const

Direction	get_direction () const

int	get_draw_order () const

TextFont *	get_font () const

PN_stdfloat	get_glyph_scale () const

PN_stdfloat	get_glyph_shift () const

PN_stdfloat	get_indent () const

bool	get_preserve_trailing_whitespace () const

LVector2	get_shadow () const

LColor	get_shadow_color () const

const RenderState *	get_shadow_state () const
	Returns a RenderState object suitable for rendering the shadow of this text with these properties. More...

PN_stdfloat	get_slant () const

bool	get_small_caps () const

PN_stdfloat	get_small_caps_scale () const

PN_stdfloat	get_tab_width () const

LColor	get_text_color () const

PN_stdfloat	get_text_scale () const

const RenderState *	get_text_state () const
	Returns a RenderState object suitable for rendering text with these properties. More...

bool	get_underscore () const

PN_stdfloat	get_underscore_height () const

PN_stdfloat	get_wordwrap () const

bool	has_align () const

bool	has_bin () const

bool	has_direction () const

bool	has_draw_order () const

bool	has_font () const

bool	has_glyph_scale () const

bool	has_glyph_shift () const

bool	has_indent () const

bool	has_preserve_trailing_whitespace () const

bool	has_shadow () const

bool	has_shadow_color () const

bool	has_slant () const

bool	has_small_caps () const

bool	has_small_caps_scale () const

bool	has_tab_width () const

bool	has_text_color () const

bool	has_text_scale () const

bool	has_underscore () const

bool	has_underscore_height () const

bool	has_wordwrap () const

bool	is_any_specified () const
	Returns true if any properties have been specified, false otherwise. More...

bool	operator != (const TextProperties &other) const

void	operator= (const TextProperties &copy)

bool	operator== (const TextProperties &other) const

void	set_align (Alignment align_type)

void	set_bin (const std::string &bin)

void	set_direction (Direction direction)

int	set_draw_order (int draw_order)

void	set_font (TextFont *font)

void	set_glyph_scale (PN_stdfloat glyph_scale)

void	set_glyph_shift (PN_stdfloat glyph_shift)

void	set_indent (PN_stdfloat indent)

void	set_preserve_trailing_whitespace (bool preserve_trailing_whitespace)

void	set_shadow (PN_stdfloat xoffset, PN_stdfloat yoffset)

void	set_shadow (const LVecBase2 &shadow_offset)

void	set_shadow_color (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a)

void	set_shadow_color (const LColor &shadow_color)

void	set_slant (PN_stdfloat slant)

void	set_small_caps (bool small_caps)

void	set_small_caps_scale (PN_stdfloat small_caps_scale)

void	set_tab_width (PN_stdfloat tab_width)

void	set_text_color (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a)

void	set_text_color (const LColor &text_color)

void	set_text_scale (PN_stdfloat text_scale)

void	set_underscore (bool underscore)

void	set_underscore_height (PN_stdfloat underscore_height)

void	set_wordwrap (PN_stdfloat wordwrap)

void	write (std::ostream &out, int indent_level=0) const

Static Public Member Functions
static TypeHandle	get_class_type ()

static TextFont *	get_default_font ()
	Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. More...

static void	init_type ()

static void	set_default_font (TextFont *)
	Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. More...

Public Attributes
	clear_align
	Restores the default alignment of the text. More...

	clear_bin
	Removes the effect of a previous call to set_bin(). More...

	clear_direction
	Clears the text direction setting. More...

	clear_draw_order

	clear_font
	Restores the default font to the text. More...

	clear_glyph_scale

	clear_glyph_shift

	clear_indent
	Removes the indent setting from the text. More...

	clear_preserve_trailing_whitespace

	clear_shadow
	Specifies that a shadow will not be drawn behind the text. More...

	clear_shadow_color
	Removes the shadow color specification. More...

	clear_slant

	clear_small_caps

	clear_small_caps_scale

	clear_tab_width

	clear_text_color
	Removes the text color specification; the text will be colored whatever it was in the source font file. More...

	clear_text_scale

	clear_underscore

	clear_underscore_height

	clear_wordwrap
	Removes the wordwrap setting from the text. More...

	get_align

	get_bin
	Returns the drawing bin set with set_bin(), or empty string if no bin has been set. More...

	get_direction
	Returns the direction of the text as specified by set_direction(). More...

	get_draw_order
	Returns the drawing order set with set_draw_order(). More...

	get_font
	Returns the font currently in use, if any. More...

	get_glyph_scale
	Returns the scale factor of each letter as specified by set_glyph_scale(). More...

	get_glyph_shift
	Returns the vertical shift of each letter as specified by set_glyph_shift(). More...

	get_indent

	get_preserve_trailing_whitespace
	Returns the preserve_trailing_whitespace flag. More...

	get_shadow
	Returns the offset of the shadow as set by set_shadow(). More...

	get_shadow_color

	get_slant
	Returns the factor by which the text is specified to slant to the right. More...

	get_small_caps
	Returns the small_caps flag. More...

	get_small_caps_scale
	Returns the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. More...

	get_tab_width
	Returns the width set via set_tab_width(). More...

	get_text_color

	get_text_scale
	Returns the scale factor of the text as specified by set_text_scale(). More...

	get_underscore
	Returns the underscore flag. More...

	get_underscore_height
	Returns the vertical height of the underscore; see set_underscore_height(). More...

	get_wordwrap

	has_align

	has_bin
	Returns true if an explicit drawing bin has been set via set_bin(), false otherwise. More...

	has_direction

	has_draw_order

	has_font

	has_glyph_scale

	has_glyph_shift

	has_indent

	has_preserve_trailing_whitespace

	has_shadow

	has_shadow_color

	has_slant

	has_small_caps

	has_small_caps_scale

	has_tab_width

	has_text_color

	has_text_scale

	has_underscore

	has_underscore_height

	has_wordwrap

	set_align
	Specifies the alignment of the text within its margins. More...

	set_bin
	Names the CullBin that the text geometry should be assigned to. More...

	set_direction
	Specifies the text direction. More...

	set_draw_order
	Sets the drawing order of text created by the TextNode. More...

	set_font
	Sets the font that will be used when making text. More...

	set_glyph_scale
	Specifies the factor by which to scale each letter of the text as it is placed, in addition to any scales inherited from the node or from set_text_scale(). More...

	set_glyph_shift
	Specifies a vertical amount to shift each letter of the text as it is placed. More...

	set_indent
	Specifies the amount of extra space that is inserted before the first character of each line. More...

	set_preserve_trailing_whitespace
	Sets the preserve_trailing_whitespace flag. More...

	set_shadow
	Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first. More...

	set_shadow_color

	set_slant
	Specifies the factor by which the text slants to the right. More...

	set_small_caps
	Sets the small_caps flag. More...

	set_small_caps_scale
	Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. More...

	set_tab_width
	Sets the width of each tab stop, in screen units. More...

	set_text_color

	set_text_scale
	Specifies the factor by which to scale the text, in addition to any scalings imposed by the node, as well as in addition to the glyph scale. More...

	set_underscore
	Sets the underscore flag. More...

	set_underscore_height
	Specifies the vertical height of the underscore, relative to the text baseline. More...

	set_wordwrap
	Sets the text up to automatically wordwrap when it exceeds the indicated width. More...

Detailed Description

This defines the set of visual properties that may be assigned to the individual characters of the text.

(Properties which affect the overall block of text can only be specified on the TextNode directly).

Typically, there is just one set of properties on a given block of text, which is set directly on the TextNode (TextNode inherits from TextProperties). That makes all of the text within a particular block have the same appearance.

This separate class exists in order to implement multiple different kinds of text appearing within one block. The text string itself may reference a TextProperties structure by name using the \1 and \2 tokens embedded within the string; each nested TextProperties structure modifies the appearance of subsequent text within the block.

Definition at line 41 of file textProperties.h.

Member Function Documentation

◆ add_properties()

void TextProperties::add_properties ( const TextProperties & other )

Sets any properties that are explicitly specified in other on this object.

Leaves other properties unchanged.

Definition at line 188 of file textProperties.cxx.

References get_bin, get_direction, get_draw_order, get_font, get_glyph_scale, get_glyph_shift, get_shadow, get_slant, get_small_caps, get_small_caps_scale, get_tab_width, get_text_scale, get_underscore, get_underscore_height, has_bin, has_direction, set_align, set_bin, set_direction, set_draw_order, set_font, set_glyph_scale, set_glyph_shift, set_indent, set_shadow, set_slant, set_small_caps, set_small_caps_scale, set_tab_width, set_text_scale, set_underscore, set_underscore_height, and set_wordwrap.

◆ clear()

void TextProperties::clear ( )

Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state.

Definition at line 179 of file textProperties.cxx.

◆ get_default_font()

TextFont * TextProperties::get_default_font ( )

inlinestatic

Specifies the default font to be used for any TextNode whose font is uninitialized or NULL.

See set_font().

Definition at line 47 of file textProperties.I.

◆ get_shadow_state()

const RenderState * TextProperties::get_shadow_state ( ) const

Returns a RenderState object suitable for rendering the shadow of this text with these properties.

Definition at line 420 of file textProperties.cxx.

References get_bin, get_draw_order, and has_bin.

◆ get_text_state()

const RenderState * TextProperties::get_text_state ( ) const

Returns a RenderState object suitable for rendering text with these properties.

Definition at line 393 of file textProperties.cxx.

References get_bin, get_draw_order, and has_bin.

◆ is_any_specified()

bool TextProperties::is_any_specified ( ) const

inline

Returns true if any properties have been specified, false otherwise.

Definition at line 26 of file textProperties.I.

◆ set_default_font()

void TextProperties::set_default_font ( TextFont * font )

inlinestatic

Specifies the default font to be used for any TextNode whose font is uninitialized or NULL.

See set_font().

Definition at line 35 of file textProperties.I.

Member Data Documentation

◆ clear_align

void TextProperties::clear_align

inline

Restores the default alignment of the text.

Definition at line 188 of file textProperties.h.

◆ clear_bin

void TextProperties::clear_bin

inline

Removes the effect of a previous call to set_bin().

Text will be drawn in whatever bin it would like to be drawn in, with no explicit ordering.

Definition at line 199 of file textProperties.h.

◆ clear_direction

void TextProperties::clear_direction

inline

Clears the text direction setting.

If no text direction is specified, it will be guessed based on the contents of the string.

Since: 1.10.0

Definition at line 211 of file textProperties.h.

◆ clear_font

void TextProperties::clear_font

inline

Restores the default font to the text.

Definition at line 178 of file textProperties.h.

◆ clear_indent

void TextProperties::clear_indent

inline

Removes the indent setting from the text.

Text will be as wide as it is.

Definition at line 189 of file textProperties.h.

◆ clear_shadow

void TextProperties::clear_shadow

inline

Specifies that a shadow will not be drawn behind the text.

Definition at line 198 of file textProperties.h.

◆ clear_shadow_color

void TextProperties::clear_shadow_color

inline

Removes the shadow color specification.

Definition at line 197 of file textProperties.h.

◆ clear_text_color

void TextProperties::clear_text_color

inline

Removes the text color specification; the text will be colored whatever it was in the source font file.

Definition at line 195 of file textProperties.h.

◆ clear_wordwrap

void TextProperties::clear_wordwrap

inline

Removes the wordwrap setting from the text.

Text will be as wide as it is.

Definition at line 190 of file textProperties.h.

◆ get_bin

const std::string & TextProperties::get_bin

inline

Returns the drawing bin set with set_bin(), or empty string if no bin has been set.

Definition at line 199 of file textProperties.h.

Referenced by add_properties(), get_shadow_state(), and get_text_state().

◆ get_direction

TextProperties::Direction TextProperties::get_direction

inline

Returns the direction of the text as specified by set_direction().

Since: 1.10.0

Definition at line 211 of file textProperties.h.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ add_properties()

◆ clear()

◆ get_default_font()

◆ get_shadow_state()

◆ get_text_state()

◆ is_any_specified()

◆ set_default_font()

Member Data Documentation

◆ clear_align

◆ clear_bin

◆ clear_direction

◆ clear_font

◆ clear_indent

◆ clear_shadow

◆ clear_shadow_color

◆ clear_text_color

◆ clear_wordwrap

◆ get_bin

◆ get_direction

◆ get_draw_order

◆ get_font

◆ get_glyph_scale

◆ get_glyph_shift

◆ get_preserve_trailing_whitespace

◆ get_shadow

◆ get_slant

◆ get_small_caps

◆ get_small_caps_scale

◆ get_tab_width

◆ get_text_scale

◆ get_underscore

◆ get_underscore_height

◆ has_bin

◆ has_direction

◆ set_align

◆ set_bin

◆ set_direction

◆ set_draw_order

◆ set_font

◆ set_glyph_scale

◆ set_glyph_shift

◆ set_indent

◆ set_preserve_trailing_whitespace

◆ set_shadow

◆ set_slant

◆ set_small_caps

◆ set_small_caps_scale

◆ set_tab_width

◆ set_text_scale

◆ set_underscore

◆ set_underscore_height

◆ set_wordwrap