Panda3D
|
This defines the set of visual properties that may be assigned to the individual characters of the text. More...
#include "textProperties.h"
Public Types | |
enum | Alignment { A_left, A_right, A_center, A_boxed_left, A_boxed_right, A_boxed_center } |
Public Member Functions | |
TextProperties (const TextProperties ©) | |
void | add_properties (const TextProperties &other) |
Sets any properties that are explicitly specified in other on this object. | |
void | clear () |
Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state. | |
void | clear_align () |
Restores the default alignment of the text. | |
void | clear_bin () |
Removes the effect of a previous call to set_bin(). | |
void | clear_draw_order () |
void | clear_font () |
Restores the default font to the text. | |
void | clear_glyph_scale () |
void | clear_glyph_shift () |
void | clear_indent () |
Removes the indent setting from the text. | |
void | clear_preserve_trailing_whitespace () |
void | clear_shadow () |
Specifies that a shadow will not be drawn behind the text. | |
void | clear_shadow_color () |
Removes the shadow color specification. | |
void | clear_slant () |
void | clear_small_caps () |
void | clear_small_caps_scale () |
void | clear_tab_width () |
void | clear_text_color () |
Removes the text color specification; the text will be colored whatever it was in the source font file. | |
void | clear_text_scale () |
void | clear_underscore () |
void | clear_underscore_height () |
void | clear_wordwrap () |
Removes the wordwrap setting from the text. | |
Alignment | get_align () const |
const string & | get_bin () const |
Returns the drawing bin set with set_bin(), or empty string if no bin has been set. | |
int | get_draw_order () const |
Returns the drawing order set with set_draw_order(). | |
TextFont * | get_font () const |
Returns the font currently in use, if any. | |
PN_stdfloat | get_glyph_scale () const |
Returns the scale factor of each letter as specified by set_glyph_scale(). | |
PN_stdfloat | get_glyph_shift () const |
Returns the vertical shift of each letter as specified by set_glyph_shift(). | |
PN_stdfloat | get_indent () const |
bool | get_preserve_trailing_whitespace () const |
Returns the preserve_trailing_whitespace flag. | |
LVector2 | get_shadow () const |
Returns the offset of the shadow as set by set_shadow(). | |
LColor | get_shadow_color () const |
PN_stdfloat | get_slant () const |
Returns the factor by which the text is specified to slant to the right. | |
bool | get_small_caps () const |
Returns the small_caps flag. | |
PN_stdfloat | get_small_caps_scale () const |
Returns the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. | |
PN_stdfloat | get_tab_width () const |
Returns the width set via set_tab_width(). | |
LColor | get_text_color () const |
PN_stdfloat | get_text_scale () const |
Returns the scale factor of the text as specified by set_text_scale(). | |
bool | get_underscore () const |
Returns the underscore flag. | |
PN_stdfloat | get_underscore_height () const |
Returns the vertical height of the underscore; see set_underscore_height(). | |
PN_stdfloat | get_wordwrap () const |
bool | has_align () const |
bool | has_bin () const |
Returns true if an explicit drawing bin has been set via set_bin(), false otherwise. | |
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. | |
bool | operator!= (const TextProperties &other) const |
void | operator= (const TextProperties ©) |
bool | operator== (const TextProperties &other) const |
void | set_align (Alignment align_type) |
Specifies the alignment of the text within its margins. | |
void | set_bin (const string &bin) |
Names the CullBin that the text geometry should be assigned to. | |
int | set_draw_order (int draw_order) |
Sets the drawing order of text created by the TextNode. | |
void | set_font (TextFont *font) |
Sets the font that will be used when making text. | |
void | set_glyph_scale (PN_stdfloat 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(). | |
void | set_glyph_shift (PN_stdfloat glyph_shift) |
Specifies a vertical amount to shift each letter of the text as it is placed. | |
void | set_indent (PN_stdfloat indent) |
Specifies the amount of extra space that is inserted before the first character of each line. | |
void | set_preserve_trailing_whitespace (bool preserve_trailing_whitespace) |
Sets the preserve_trailing_whitespace flag. | |
void | set_shadow (PN_stdfloat xoffset, PN_stdfloat yoffset) |
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. | |
void | set_shadow (const LVecBase2 &shadow_offset) |
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. | |
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) |
Specifies the factor by which the text slants to the right. | |
void | set_small_caps (bool small_caps) |
Sets the small_caps flag. | |
void | set_small_caps_scale (PN_stdfloat small_caps_scale) |
Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. | |
void | set_tab_width (PN_stdfloat tab_width) |
Sets the width of each tab stop, in screen units. | |
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) |
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. | |
void | set_underscore (bool underscore) |
Sets the underscore flag. | |
void | set_underscore_height (PN_stdfloat underscore_height) |
Specifies the vertical height of the underscore, relative to the text baseline. | |
void | set_wordwrap (PN_stdfloat wordwrap) |
Sets the text up to automatically wordwrap when it exceeds the indicated width. | |
void | write (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. | |
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. |
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 46 of file textProperties.h.
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 190 of file textProperties.cxx.
References get_bin(), 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(), set_align(), set_bin(), 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().
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 178 of file textProperties.cxx.
void TextProperties::clear_align | ( | ) | [inline] |
Restores the default alignment of the text.
Reimplemented in TextNode.
Definition at line 370 of file textProperties.I.
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.
Reimplemented in TextNode.
Definition at line 725 of file textProperties.I.
void TextProperties::clear_font | ( | ) | [inline] |
Restores the default font to the text.
Reimplemented in TextNode.
Definition at line 86 of file textProperties.I.
void TextProperties::clear_indent | ( | ) | [inline] |
Removes the indent setting from the text.
Text will be as wide as it is.
Reimplemented in TextNode.
Definition at line 415 of file textProperties.I.
void TextProperties::clear_shadow | ( | ) | [inline] |
Specifies that a shadow will not be drawn behind the text.
Reimplemented in TextNode.
Definition at line 671 of file textProperties.I.
void TextProperties::clear_shadow_color | ( | ) | [inline] |
Removes the shadow color specification.
Reimplemented in TextNode.
Definition at line 614 of file textProperties.I.
void TextProperties::clear_text_color | ( | ) | [inline] |
Removes the text color specification; the text will be colored whatever it was in the source font file.
Reimplemented in TextNode.
Definition at line 562 of file textProperties.I.
void TextProperties::clear_wordwrap | ( | ) | [inline] |
Removes the wordwrap setting from the text.
Text will be as wide as it is.
Reimplemented in TextNode.
Definition at line 460 of file textProperties.I.
const string & TextProperties::get_bin | ( | ) | const [inline] |
Returns the drawing bin set with set_bin(), or empty string if no bin has been set.
Definition at line 748 of file textProperties.I.
Referenced by add_properties().
TextFont * TextProperties::get_default_font | ( | ) | [inline, static] |
Specifies the default font to be used for any TextNode whose font is uninitialized or NULL.
See set_font().
Definition at line 60 of file textProperties.I.
Referenced by get_font().
int TextProperties::get_draw_order | ( | ) | const [inline] |
Returns the drawing order set with set_draw_order().
Definition at line 801 of file textProperties.I.
Referenced by add_properties().
TextFont * TextProperties::get_font | ( | ) | const [inline] |
Returns the font currently in use, if any.
If no font is in use, this returns the default font.
Definition at line 108 of file textProperties.I.
References get_default_font().
Referenced by add_properties(), TextAssembler::calc_width(), TextNode::calc_width(), TextNode::get_line_height(), TextNode::has_character(), TextAssembler::has_exact_character(), TextNode::has_exact_character(), TextAssembler::is_whitespace(), and TextNode::is_whitespace().
PN_stdfloat TextProperties::get_glyph_scale | ( | ) | const [inline] |
Returns the scale factor of each letter as specified by set_glyph_scale().
Definition at line 900 of file textProperties.I.
Referenced by add_properties(), and TextAssembler::calc_width().
PN_stdfloat TextProperties::get_glyph_shift | ( | ) | const [inline] |
Returns the vertical shift of each letter as specified by set_glyph_shift().
Definition at line 946 of file textProperties.I.
Referenced by add_properties().
bool TextProperties::get_preserve_trailing_whitespace | ( | ) | const [inline] |
Returns the preserve_trailing_whitespace flag.
See set_preserve_trailing_whitespace().
Definition at line 530 of file textProperties.I.
LVector2 TextProperties::get_shadow | ( | ) | const [inline] |
Returns the offset of the shadow as set by set_shadow().
It is an error to call this if has_shadow() is false.
Definition at line 694 of file textProperties.I.
Referenced by add_properties().
PN_stdfloat TextProperties::get_slant | ( | ) | const [inline] |
Returns the factor by which the text is specified to slant to the right.
Definition at line 257 of file textProperties.I.
Referenced by add_properties().
bool TextProperties::get_small_caps | ( | ) | const [inline] |
Returns the small_caps flag.
See set_small_caps().
Definition at line 166 of file textProperties.I.
Referenced by add_properties().
PN_stdfloat TextProperties::get_small_caps_scale | ( | ) | const [inline] |
Returns the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect.
See set_small_caps() and set_small_caps_scale().
Definition at line 213 of file textProperties.I.
Referenced by add_properties().
PN_stdfloat TextProperties::get_tab_width | ( | ) | const [inline] |
Returns the width set via set_tab_width().
Definition at line 845 of file textProperties.I.
Referenced by add_properties().
PN_stdfloat TextProperties::get_text_scale | ( | ) | const [inline] |
Returns the scale factor of the text as specified by set_text_scale().
Definition at line 995 of file textProperties.I.
Referenced by add_properties(), and TextAssembler::calc_width().
bool TextProperties::get_underscore | ( | ) | const [inline] |
Returns the underscore flag.
See set_underscore().
Definition at line 302 of file textProperties.I.
Referenced by add_properties().
PN_stdfloat TextProperties::get_underscore_height | ( | ) | const [inline] |
Returns the vertical height of the underscore; see set_underscore_height().
Definition at line 348 of file textProperties.I.
Referenced by add_properties().
bool TextProperties::has_bin | ( | ) | const [inline] |
Returns true if an explicit drawing bin has been set via set_bin(), false otherwise.
Definition at line 737 of file textProperties.I.
Referenced by add_properties().
bool TextProperties::is_any_specified | ( | ) | const [inline] |
Returns true if any properties have been specified, false otherwise.
Definition at line 33 of file textProperties.I.
void TextProperties::set_align | ( | TextProperties::Alignment | align_type | ) | [inline] |
Specifies the alignment of the text within its margins.
Reimplemented in TextNode.
Definition at line 359 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_bin | ( | const string & | bin | ) | [inline] |
Names the CullBin that the text geometry should be assigned to.
If this is set, then a CullBinAttrib will be created to explicitly place each component in the named bin.
The draw_order value will also be passed to each CullBinAttrib as appropriate; this is particularly useful if this names a CullBinFixed, e.g. "fixed".
Reimplemented in TextNode.
Definition at line 711 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_default_font | ( | TextFont * | font | ) | [inline, static] |
Specifies the default font to be used for any TextNode whose font is uninitialized or NULL.
See set_font().
Definition at line 45 of file textProperties.I.
int TextProperties::set_draw_order | ( | int | draw_order | ) | [inline] |
Sets the drawing order of text created by the TextNode.
This is actually the draw order of the card and frame. The shadow is drawn at _draw_order+1, and the text at _draw_order+2.
This affects the sorting order assigned to the nodes as they are created, and also is passed to whatever bin may be assigned via set_bin().
The return value is the first unused draw_order number, e.g. _draw_order + 3.
Reimplemented in TextNode.
Definition at line 768 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_font | ( | TextFont * | font | ) | [inline] |
Sets the font that will be used when making text.
If this is set to NULL, the default font will be used, which can be set via set_default_font().
Reimplemented in TextNode.
Definition at line 75 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_glyph_scale | ( | PN_stdfloat | glyph_scale | ) | [inline] |
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().
This can be used (possibly in conjunction with set_glyph_shift()) to implement superscripting or subscripting.
The glyph scale is cumulative when applied to nested TextProperties. It is intended primarily for implementing superscripts, not for scaling the text in general. See also set_text_scale(), which is intended primarily for scaling the text in general, and is not cumulative.
Reimplemented in TextNode.
Definition at line 867 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_glyph_shift | ( | PN_stdfloat | glyph_shift | ) | [inline] |
Specifies a vertical amount to shift each letter of the text as it is placed.
This can be used (possibly in conjunction with set_glyph_scale()) to implement superscripting or subscripting.
Reimplemented in TextNode.
Definition at line 913 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_indent | ( | PN_stdfloat | indent | ) | [inline] |
Specifies the amount of extra space that is inserted before the first character of each line.
This can be thought of as a left margin.
Reimplemented in TextNode.
Definition at line 403 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_preserve_trailing_whitespace | ( | bool | preserve_trailing_whitespace | ) | [inline] |
Sets the preserve_trailing_whitespace flag.
When this is set, trailing whitespace at the end of the line is not stripped when the text is wordwrapped (it is stripped by default). Since the trailing whitespace is invisible, this is important primarily for determining the proper width of a frame or card behind the text.
Definition at line 497 of file textProperties.I.
void TextProperties::set_shadow | ( | PN_stdfloat | xoffset, |
PN_stdfloat | yoffset | ||
) | [inline] |
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.
Reimplemented in TextNode.
Definition at line 647 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_shadow | ( | const LVecBase2 & | shadow_offset | ) | [inline] |
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.
Reimplemented in TextNode.
Definition at line 659 of file textProperties.I.
void TextProperties::set_slant | ( | PN_stdfloat | slant | ) | [inline] |
Specifies the factor by which the text slants to the right.
Reimplemented in TextNode.
Definition at line 224 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_small_caps | ( | bool | small_caps | ) | [inline] |
Sets the small_caps flag.
When this is set, lowercase letters are generated as scaled-down versions of their uppercase equivalents. This is particularly useful to set for fonts that do not have lowercase letters.
It is also a good idea to set this for a (dynamic) font that has already implemented lowercase letters as scaled-down versions of their uppercase equivalents, since without this flag the texture memory may needlessly duplicate equivalent glyphs for upper and lowercase letters. Setting this flag causes the texture memory to share the mixed-case letters.
The amount by which the lowercase letters are scaled is specified by set_small_caps_scale().
Reimplemented in TextNode.
Definition at line 134 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_small_caps_scale | ( | PN_stdfloat | small_caps_scale | ) | [inline] |
Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect.
See set_small_caps(). Normally, this will be a number less than one.
Reimplemented in TextNode.
Definition at line 179 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_tab_width | ( | PN_stdfloat | tab_width | ) | [inline] |
Sets the width of each tab stop, in screen units.
A tab character embedded in the text will advance the horizontal position to the next tab stop.
Reimplemented in TextNode.
Definition at line 813 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_text_scale | ( | PN_stdfloat | text_scale | ) | [inline] |
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.
The text scale is not cumulative when applied to nested TextProperties. See also set_glyph_scale(), which is cumulative.
Definition at line 962 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_underscore | ( | bool | underscore | ) | [inline] |
Sets the underscore flag.
When this is set, the text is underscored with a one-pixel line the same color as the text foreground, drawn at the baseline.
Definition at line 270 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_underscore_height | ( | PN_stdfloat | underscore_height | ) | [inline] |
Specifies the vertical height of the underscore, relative to the text baseline.
This only has meaning if the underscore mode is enabled with set_underscore().
Definition at line 315 of file textProperties.I.
Referenced by add_properties().
void TextProperties::set_wordwrap | ( | PN_stdfloat | wordwrap | ) | [inline] |
Sets the text up to automatically wordwrap when it exceeds the indicated width.
This can be thought of as a right margin or margin width.
Reimplemented in TextNode.
Definition at line 448 of file textProperties.I.
Referenced by add_properties().