Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
TextNode Class Reference

The primary interface to this module. More...

#include "textNode.h"

Inheritance diagram for TextNode:
PandaNode TextEncoder TextProperties TypedWritableReferenceCount Namable LinkedListNode TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase FrameRateMeter SceneGraphAnalyzerMeter

Public Types

enum  FlattenFlags {
  FF_none = 0x0000, FF_light = 0x0001, FF_medium = 0x0002, FF_strong = 0x0004,
  FF_dynamic_merge = 0x0008
}
 
- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 0x0001, FB_state = 0x0002, FB_effects = 0x0004, FB_tag = 0x0010,
  FB_draw_mask = 0x0020, FB_cull_callback = 0x0040
}
 
typedef bool SceneRootFunc(const PandaNode *)
 
enum  UnexpectedChange {
  UC_parents = 0x001, UC_children = 0x002, UC_transform = 0x004, UC_state = 0x008,
  UC_draw_mask = 0x010
}
 
- Public Types inherited from TextEncoder
enum  Encoding { E_iso8859, E_utf8, E_unicode }
 
- Public Types inherited from TextProperties
enum  Alignment {
  A_left, A_right, A_center, A_boxed_left,
  A_boxed_right, A_boxed_center
}
 

Public Member Functions

 TextNode (const string &name)
 
 TextNode (const string &name, const TextProperties &copy)
 It's sort of a copy constructor: it copies the indicated TextProperties, without copying a complete TextNode. More...
 
void append_text (const string &text)
 Appends the indicates string to the end of the stored text. More...
 
void append_unicode_char (wchar_t character)
 Appends a single character to the end of the stored text. More...
 
void append_wtext (const wstring &text)
 Appends the indicates string to the end of the stored wide-character text. More...
 
virtual void apply_attribs_to_vertices (const AccumulatedAttribs &attribs, int attrib_types, GeomTransformer &transformer)
 Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate. More...
 
PN_stdfloat calc_width (wchar_t character) const
 Returns the width of a single character of the font, or 0.0 if the character is not known. More...
 
PN_stdfloat calc_width (const string &line) const
 Returns the width of a line of text of arbitrary characters. More...
 
PN_stdfloat calc_width (const wstring &line) const
 Returns the width of a line of text of arbitrary characters. More...
 
void clear_align ()
 
void clear_bin ()
 Removes the effect of a previous call to set_bin(). More...
 
void clear_card ()
 Specifies that a card will not be drawn behind the text. More...
 
void clear_card_border ()
 
void clear_card_texture ()
 
void clear_draw_order ()
 
void clear_font ()
 Resets the font to the default font. More...
 
void clear_frame ()
 Specifies that a border will not be drawn around the text. More...
 
void clear_glyph_scale ()
 
void clear_glyph_shift ()
 
void clear_indent ()
 
void clear_max_rows ()
 Resets the TextNode's default behavior of not limiting the number of rows of text. More...
 
void clear_shadow ()
 Specifies that a shadow will not be drawn behind the text. More...
 
void clear_shadow_color ()
 
void clear_slant ()
 
void clear_small_caps ()
 
void clear_small_caps_scale ()
 
void clear_tab_width ()
 
void clear_text ()
 Removes the text from the TextNode. More...
 
void clear_text_color ()
 Removes the text color specification; the text will be colored whatever it was in the source font file. More...
 
void clear_wordwrap ()
 Removes the wordwrap setting from the TextNode. More...
 
virtual void compute_internal_bounds (CPT(BoundingVolume) &internal_bounds, int &internal_vertices, int pipeline_stage, Thread *current_thread) const
 Called when needed to recompute the node's _internal_bound object. More...
 
virtual CPT (TransformState) calc_tight_bounds(LPoint3 &min_point
 
virtual bool cull_callback (CullTraverser *trav, CullTraverserData &data)
 
virtual TypeHandle force_init_type ()
 
void force_update ()
 Forces the TextNode to recompute itself now, even if it believes nothing has changed. More...
 
PN_stdfloat get_bottom () const
 Returns the bottommost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
LVecBase4 get_card_actual () const
 Returns the actual dimensions of the card around the text. More...
 
LVecBase4 get_card_as_set () const
 Returns the dimensions of the card as set by set_card_as_margin() or set_card_actual(). More...
 
PN_stdfloat get_card_border_size () const
 
PN_stdfloat get_card_border_uv_portion () const
 
LColor get_card_color () const
 
bool get_card_decal () const
 Returns the card_decal flag. More...
 
Textureget_card_texture () const
 
LVecBase4 get_card_transformed () const
 Returns the actual card dimensions, transformed by the matrix set by set_transform(). More...
 
CoordinateSystem get_coordinate_system () const
 
int get_flatten_flags () const
 Returns the flatten flags. More...
 
LVecBase4 get_frame_actual () const
 Returns the actual dimensions of the frame around the text. More...
 
LVecBase4 get_frame_as_set () const
 Returns the dimensions of the frame as set by set_frame_as_margin() or set_frame_actual(). More...
 
LColor get_frame_color () const
 
bool get_frame_corners () const
 
PN_stdfloat get_frame_line_width () const
 Returns the thickness of the lines that will be used to draw the frame. More...
 
PN_stdfloat get_height () const
 Returns the net height of the text in local 2-d coordinates. More...
 
PandaNodeget_internal_geom () const
 Returns the actual node that is used internally to render the text, if the TextNode is parented within the scene graph. More...
 
PN_stdfloat get_left () const
 Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
PN_stdfloat get_line_height () const
 Returns the number of units high each line of text is. More...
 
LPoint3 get_lower_right_3d () const
 Returns the lower-right extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix. More...
 
int get_max_rows () const
 Returns the limit on the height of the TextNode specified by set_max_rows(). More...
 
int get_num_rows () const
 Returns the number of rows of text that were generated. More...
 
PN_stdfloat get_right () const
 Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
PN_stdfloat get_top () const
 Returns the topmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
LMatrix4 get_transform () const
 
virtual TypeHandle get_type () const
 
virtual int get_unsafe_to_apply_attribs () const
 Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node. More...
 
LPoint3 get_upper_left_3d () const
 Returns the upper-left extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix. More...
 
Geom::UsageHint get_usage_hint () const
 Returns the UsageHint that will be applied to generated geometry. More...
 
PN_stdfloat get_width () const
 Returns the net width of the text in local 2-d coordinates. More...
 
string get_wordwrapped_text () const
 Returns a string that represents the contents of the text, as it has been formatted by wordwrap rules. More...
 
wstring get_wordwrapped_wtext () const
 Returns a wstring that represents the contents of the text, as it has been formatted by wordwrap rules. More...
 
bool has_card () const
 
bool has_card_border () const
 
bool has_card_texture () const
 
bool has_character (wchar_t character) const
 Returns true if the named character exists in the font or can be synthesized by Panda, false otherwise. More...
 
bool has_exact_character (wchar_t character) const
 Returns true if the named character exists in the font exactly as named, false otherwise. More...
 
bool has_frame () const
 
bool has_max_rows () const
 Returns true if a limit on the height of the TextNode has been set via set_max_rows(), false otherwise. More...
 
bool has_overflow () const
 Returns true if the last text set on the text node exceeded the max_rows constraint, or false if it all fit. More...
 
bool is_card_as_margin () const
 If this is true, the card was set via a call to set_card_as_margin(), and the dimension of the card as returned by get_card_as_set() represent a margin all around the text. More...
 
bool is_frame_as_margin () const
 If this is true, the frame was set via a call to set_frame_as_margin(), and the dimension of the frame as returned by get_frame_as_set() represent a margin all around the text. More...
 
virtual bool is_renderable () const
 Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise. More...
 
bool is_whitespace (wchar_t character) const
 Returns true if the indicated character represents whitespace in the font, or false if anything visible will be rendered for it. More...
 
virtual void output (ostream &out) const
 
 PT (PandaNode) generate()
 
virtual void r_prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state, GeomTransformer &transformer, Thread *current_thread)
 The recursive implementation of prepare_scene(). More...
 
void set_align (Alignment align_type)
 
void set_bin (const string &bin)
 Names the GeomBin that the TextNode geometry should be assigned to. More...
 
void set_card_actual (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 Similar to set_card_as_margin, except the card is specified in actual coordinate units (relative to the text's origin), irrespective of the size of the text. More...
 
void set_card_as_margin (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 Specifies that a (possibly opaque or semitransparent) card will be held behind the text when it is next created. More...
 
void set_card_border (PN_stdfloat size, PN_stdfloat uv_portion)
 
void set_card_color (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a)
 
void set_card_color (const LColor &card_color)
 
void set_card_decal (bool card_decal)
 Sets the card_decal flag. More...
 
void set_card_texture (Texture *card_texture)
 
void set_coordinate_system (CoordinateSystem cs)
 Specifies the coordinate system in which the text will be generated. More...
 
int set_draw_order (int draw_order)
 Sets the drawing order of text created by the TextMaker. More...
 
void set_flatten_flags (int flatten_flags)
 Sets the flatten flags. More...
 
void set_font (TextFont *font)
 Sets the font that will be used when making text. More...
 
void set_frame_actual (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 Similar to set_frame_as_margin, except the frame is specified in actual coordinate units (relative to the text's origin), irrespective of the size of the text. More...
 
void set_frame_as_margin (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 Specifies that a border will be drawn around the text when it is next created. More...
 
void set_frame_color (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a)
 
void set_frame_color (const LColor &frame_color)
 
void set_frame_corners (bool corners)
 Enables or disables the drawing of corners for the frame. More...
 
void set_frame_line_width (PN_stdfloat line_width)
 Specifies the thickness of the lines that will be used to draw the frame. More...
 
void set_glyph_scale (PN_stdfloat glyph_scale)
 Specifies the factor by which to scale each letter of the text as it is placed. More...
 
void set_glyph_shift (PN_stdfloat glyph_shift)
 Specifies a vertical amount to shift each letter of the text as it is placed. More...
 
void set_indent (PN_stdfloat indent)
 Specifies the amount of extra space that is inserted before the first character of each line. More...
 
void set_max_rows (int max_rows)
 Sets the maximum number of rows that may be formatted by the TextNode. More...
 
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. More...
 
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. More...
 
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)
 Sets the small_caps flag. More...
 
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. More...
 
void set_tab_width (PN_stdfloat tab_width)
 Sets the width of each tab stop, in screen units. More...
 
void set_text (const string &text)
 Changes the text that is displayed under the TextNode. More...
 
void set_text (const string &text, Encoding encoding)
 The two-parameter version of set_text() accepts an explicit encoding; the text is immediately decoded and stored as a wide-character string. More...
 
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_transform (const LMatrix4 &transform)
 Sets an additional transform that is applied to the entire text paragraph. More...
 
void set_usage_hint (Geom::UsageHint usage_hint)
 Specifies the UsageHint that will be applied to generated geometry. More...
 
void set_wordwrap (PN_stdfloat wordwrap)
 Sets the text up to automatically wordwrap when it exceeds the indicated width. More...
 
void set_wtext (const wstring &wtext)
 Changes the text that is displayed under the TextNode, with a wide text. More...
 
void update ()
 Can be called after the TextNode has been fully configured, to force the node to recompute its text immediately, rather than waiting for it to be drawn. More...
 
virtual void write (ostream &out, int indent_level=0) const
 
- Public Member Functions inherited from PandaNode
 PandaNode (const string &name)
 
void add_child (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 
virtual void add_for_draw (CullTraverser *trav, CullTraverserData &data)
 Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time. More...
 
void add_stashed (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node, directly as a stashed child. More...
 
void adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
virtual Lightas_light ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
void clear_attrib (TypeHandle type)
 
void clear_attrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
void clear_bounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
void clear_effect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
void clear_effects (Thread *current_thread=Thread::get_current_thread())
 
void clear_state (Thread *current_thread=Thread::get_current_thread())
 
void clear_tag (const string &key, Thread *current_thread=Thread::get_current_thread())
 Removes the value defined for this key on this particular node. More...
 
void clear_transform (Thread *current_thread=Thread::get_current_thread())
 
void clear_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
virtual PandaNodecombine_with (PandaNode *other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compare_tags (const PandaNode *other) const
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
void copy_all_properties (PandaNode *other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
void copy_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Makes another instance of all the children of the other node, copying them to this node. More...
 
void copy_tags (PandaNode *other)
 Copies all of the tags stored on the other node onto this node. More...
 
int count_num_descendants () const
 
 CPT (RenderAttrib) get_attrib(TypeHandle type) const
 
 CPT (RenderAttrib) get_attrib(int slot) const
 
 CPT (RenderEffect) get_effect(TypeHandle type) const
 
 CPT (RenderState) get_state(Thread *current_thread
 
 CPT (RenderEffects) get_effects(Thread *current_thread
 
 CPT (TransformState) get_transform(Thread *current_thread
 
 CPT (TransformState) get_prev_transform(Thread *current_thread
 
 CPT (RenderAttrib) get_off_clip_planes(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(UpdateSeq &seq
 
 CPT (BoundingVolume) get_internal_bounds(Thread *current_thread
 
virtual PandaNodedupe_for_flatten () const
 This is similar to make_copy(), but it makes a copy for the specific purpose of flatten. More...
 
int find_child (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int find_parent (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int find_stashed (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
BoundingVolume::BoundsType get_bounds_type () const
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNodeget_child (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth child node of this node. More...
 
int get_child_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
Children get_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask get_draw_control_mask () const
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask get_draw_show_mask () const
 Returns the hide/show bits of this particular node. More...
 
int get_fancy_bits (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
virtual int get_first_visible_child () const
 Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node. More...
 
int get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_into_collide_mask () const
 Returns the "into" collide mask for this node. More...
 
virtual CollideMask get_legal_collide_mask () const
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int get_nested_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_net_collide_mask (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask get_net_draw_control_mask () const
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask get_net_draw_show_mask () const
 Returns the union of all draw_show_mask values–of renderable nodes only–at this level and below. More...
 
virtual int get_next_visible_child (int n) const
 Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node. More...
 
int get_num_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of child nodes this node has. More...
 
int get_num_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of parent nodes this node has. More...
 
int get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of stashed nodes this node has. More...
 
PandaNodeget_parent (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth parent node of this node. More...
 
Parents get_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
PandaNodeget_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth stashed child of this node. More...
 
Stashed get_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
int get_stashed_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
string get_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 
void get_tag_keys (vector_string &keys) const
 Fills the given vector up with the list of tags on this PandaNode. More...
 
unsigned int get_unexpected_change (unsigned int flags) const
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
virtual int get_visible_child () const
 Returns the index number of the currently visible child of this node. More...
 
bool has_attrib (TypeHandle type) const
 
bool has_attrib (int slot) const
 
bool has_dirty_prev_transform () const
 
bool has_effect (TypeHandle type) const
 
virtual bool has_selective_visibility () const
 Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered. More...
 
virtual bool has_single_child_visibility () const
 Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera). More...
 
bool has_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 
bool has_tags () const
 
virtual bool is_ambient_light () const
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool is_bounds_stale () const
 
virtual bool is_collision_node () const
 A simple downcast check. More...
 
bool is_final (Thread *current_thread=Thread::get_current_thread()) const
 Returns the current state of the "final" flag. More...
 
virtual bool is_geom_node () const
 A simple downcast check. More...
 
virtual bool is_lod_node () const
 A simple downcast check. More...
 
bool is_overall_hidden () const
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool is_scene_root () const
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool is_under_scene_root () const
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
void list_tags (ostream &out, const string &separator="\) const
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
void ls (ostream &out, int indent_level) const
 
 MAKE_SEQ (get_parents, get_num_parents, get_parent)
 
 MAKE_SEQ (get_children, get_num_children, get_child)
 
 MAKE_SEQ (get_stashed, get_num_stashed, get_stashed)
 
void mark_bounds_stale (Thread *current_thread=Thread::get_current_thread()) const
 
void mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())
 
void prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state)
 
virtual bool preserve_name () const
 Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise. More...
 
 PT (PandaNode) copy_subgraph(Thread *current_thread
 
void remove_all_children (Thread *current_thread=Thread::get_current_thread())
 Removes all the children from the node at once, including stashed children. More...
 
void remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth child from the node. More...
 
bool remove_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Removes the indicated child from the node. More...
 
void remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth stashed child from the node. More...
 
bool replace_child (PandaNode *orig_child, PandaNode *new_child, Thread *current_thread=Thread::get_current_thread())
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
void replace_node (PandaNode *other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
void reset_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
virtual bool safe_to_combine () const
 Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever. More...
 
virtual bool safe_to_combine_children () const
 Returns true if it is generally safe to combine the children of this PandaNode with each other. More...
 
virtual bool safe_to_flatten () const
 Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful). More...
 
virtual bool safe_to_flatten_below () const
 Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested. More...
 
virtual bool safe_to_modify_transform () const
 Returns true if it is safe to automatically adjust the transform on this kind of node. More...
 
virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise. More...
 
void set_attrib (const RenderAttrib *attrib, int override=0)
 Adds the indicated render attribute to the scene graph on this node. More...
 
void set_bound (const BoundingVolume *volume)
 Deprecated. More...
 
void set_bounds (const BoundingVolume *volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
void set_bounds_type (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
void set_effect (const RenderEffect *effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
void set_effects (const RenderEffects *effects, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderEffects that will be applied this node. More...
 
void set_final (bool flag)
 
void set_into_collide_mask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
void set_overall_hidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
void set_prev_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
void set_state (const RenderState *state, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
void set_tag (const string &key, const string &value, Thread *current_thread=Thread::get_current_thread())
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
void set_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that will be applied to this node and below. More...
 
void set_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void steal_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Moves all the children from the other node onto this node. More...
 
bool unstash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
void unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
void write_recorder (BamWriter *manager, Datagram &dg)
 This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase. More...
 
virtual void xform (const LMatrix4 &mat)
 Transforms the contents of this PandaNode by the indicated matrix, if it means anything to do so. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const string &initial_name="")
 
 Namable (const Namable &copy)
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namableoperator= (const Namable &other)
 
void output (ostream &out) const
 Outputs the Namable. More...
 
void set_name (const string &name)
 
- Public Member Functions inherited from TextEncoder
 TextEncoder (const TextEncoder &copy)
 
void append_text (const string &text)
 Appends the indicates string to the end of the stored text. More...
 
void append_unicode_char (int character)
 Appends a single character to the end of the stored text. More...
 
void append_wtext (const wstring &text)
 Appends the indicates string to the end of the stored wide-character text. More...
 
void clear_text ()
 Removes the text from the TextEncoder. More...
 
wstring decode_text (const string &text) const
 Returns the given wstring decoded to a single-byte string, via the current encoding system. More...
 
string encode_wtext (const wstring &wtext) const
 Encodes a wide-text string into a single-char string, according to the current encoding. More...
 
string get_encoded_char (int index) const
 Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. More...
 
string get_encoded_char (int index, Encoding encoding) const
 Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. More...
 
Encoding get_encoding () const
 Returns the encoding by which the string set via set_text() is to be interpreted. More...
 
int get_num_chars () const
 Returns the number of characters in the stored text. More...
 
string get_text () const
 Returns the current text, as encoded via the current encoding system. More...
 
string get_text (Encoding encoding) const
 Returns the current text, as encoded via the indicated encoding system. More...
 
string get_text_as_ascii () const
 Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. More...
 
int get_unicode_char (int index) const
 Returns the Unicode value of the nth character in the stored text. More...
 
const wstring & get_wtext () const
 Returns the text associated with the TextEncoder, as a wide-character string. More...
 
wstring get_wtext_as_ascii () const
 Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. More...
 
bool has_text () const
 
bool is_wtext () const
 Returns true if any of the characters in the string returned by get_wtext() are out of the range of an ASCII character (and, therefore, get_wtext() should be called in preference to get_text()). More...
 
void make_lower ()
 Adjusts the text stored within the encoder to all lowercase letters (preserving accent marks correctly). More...
 
void make_upper ()
 Adjusts the text stored within the encoder to all uppercase letters (preserving accent marks correctly). More...
 
void set_encoding (Encoding encoding)
 Specifies how the string set via set_text() is to be interpreted. More...
 
void set_text (const string &text)
 Changes the text that is stored in the encoder. More...
 
void set_text (const string &text, Encoding encoding)
 The two-parameter version of set_text() accepts an explicit encoding; the text is immediately decoded and stored as a wide-character string. More...
 
void set_unicode_char (int index, int character)
 Sets the Unicode value of the nth character in the stored text. More...
 
void set_wtext (const wstring &wtext)
 Changes the text that is stored in the encoder. More...
 
- Public Member Functions inherited from TextProperties
 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 ()
 Restores the default alignment of the text. More...
 
void clear_bin ()
 Removes the effect of a previous call to set_bin(). More...
 
void clear_draw_order ()
 
void clear_font ()
 Restores the default font to the text. More...
 
void clear_glyph_scale ()
 
void clear_glyph_shift ()
 
void clear_indent ()
 Removes the indent setting from the text. More...
 
void clear_preserve_trailing_whitespace ()
 
void clear_shadow ()
 Specifies that a shadow will not be drawn behind the text. More...
 
void clear_shadow_color ()
 Removes the shadow color specification. More...
 
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. More...
 
void clear_text_scale ()
 
void clear_underscore ()
 
void clear_underscore_height ()
 
void clear_wordwrap ()
 Removes the wordwrap setting from the text. More...
 
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. More...
 
int get_draw_order () const
 Returns the drawing order set with set_draw_order(). More...
 
TextFontget_font () const
 Returns the font currently in use, if any. More...
 
PN_stdfloat get_glyph_scale () const
 Returns the scale factor of each letter as specified by set_glyph_scale(). More...
 
PN_stdfloat get_glyph_shift () const
 Returns the vertical shift of each letter as specified by set_glyph_shift(). More...
 
PN_stdfloat get_indent () const
 
bool get_preserve_trailing_whitespace () const
 Returns the preserve_trailing_whitespace flag. More...
 
LVector2 get_shadow () const
 Returns the offset of the shadow as set by set_shadow(). More...
 
LColor get_shadow_color () const
 
PN_stdfloat get_slant () const
 Returns the factor by which the text is specified to slant to the right. More...
 
bool get_small_caps () const
 Returns the small_caps flag. More...
 
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. More...
 
PN_stdfloat get_tab_width () const
 Returns the width set via set_tab_width(). More...
 
LColor get_text_color () const
 
PN_stdfloat get_text_scale () const
 Returns the scale factor of the text as specified by set_text_scale(). More...
 
bool get_underscore () const
 Returns the underscore flag. More...
 
PN_stdfloat get_underscore_height () const
 Returns the vertical height of the underscore; see set_underscore_height(). More...
 
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. More...
 
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)
 Specifies the alignment of the text within its margins. More...
 
void set_bin (const string &bin)
 Names the CullBin that the text geometry should be assigned to. More...
 
int set_draw_order (int draw_order)
 Sets the drawing order of text created by the TextNode. More...
 
void set_font (TextFont *font)
 Sets the font that will be used when making text. More...
 
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(). More...
 
void set_glyph_shift (PN_stdfloat glyph_shift)
 Specifies a vertical amount to shift each letter of the text as it is placed. More...
 
void set_indent (PN_stdfloat indent)
 Specifies the amount of extra space that is inserted before the first character of each line. More...
 
void set_preserve_trailing_whitespace (bool preserve_trailing_whitespace)
 Sets the preserve_trailing_whitespace flag. More...
 
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. More...
 
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. More...
 
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. More...
 
void set_small_caps (bool small_caps)
 Sets the small_caps flag. More...
 
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. More...
 
void set_tab_width (PN_stdfloat tab_width)
 Sets the width of each tab stop, in screen units. More...
 
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. More...
 
void set_underscore (bool underscore)
 Sets the underscore flag. More...
 
void set_underscore_height (PN_stdfloat underscore_height)
 Specifies the vertical height of the underscore, relative to the text baseline. More...
 
void set_wordwrap (PN_stdfloat wordwrap)
 Sets the text up to automatically wordwrap when it exceeds the indicated width. More...
 
void write (ostream &out, int indent_level=0) const
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from PandaNode
static DrawMask get_all_camera_mask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle get_class_type ()
 
static DrawMask get_overall_bit ()
 
static void init_type ()
 
static PT (PandaNode) decode_from_bam_stream(const string &data
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type PandaNode. More...
 
static void reset_all_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
static void set_scene_root_func (SceneRootFunc *func)
 This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TextEncoder
static wstring decode_text (const string &text, Encoding encoding)
 Returns the given wstring decoded to a single-byte string, via the given encoding system. More...
 
static string encode_wchar (wchar_t ch, Encoding encoding)
 Encodes a single wide char into a one-, two-, or three-byte string, according to the given encoding system. More...
 
static string encode_wtext (const wstring &wtext, Encoding encoding)
 Encodes a wide-text string into a single-char string, according to the given encoding. More...
 
static Encoding get_default_encoding ()
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. More...
 
static string lower (const string &source)
 Converts the string to lowercase, assuming the string is encoded in the default encoding. More...
 
static string lower (const string &source, Encoding encoding)
 Converts the string to lowercase, assuming the string is encoded in the indicated encoding. More...
 
static string reencode_text (const string &text, Encoding from, Encoding to)
 Given the indicated text string, which is assumed to be encoded via the encoding "from", decodes it and then reencodes it into the encoding "to", and returns the newly encoded string. More...
 
static void set_default_encoding (Encoding encoding)
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. More...
 
static bool unicode_isalpha (int character)
 Returns true if the indicated character is an alphabetic letter, false otherwise. More...
 
static bool unicode_isdigit (int character)
 Returns true if the indicated character is a numeric digit, false otherwise. More...
 
static bool unicode_islower (int character)
 Returns true if the indicated character is a lowercase letter, false otherwise. More...
 
static bool unicode_ispunct (int character)
 Returns true if the indicated character is a punctuation mark, false otherwise. More...
 
static bool unicode_isspace (int character)
 Returns true if the indicated character is a whitespace letter, false otherwise. More...
 
static bool unicode_isupper (int character)
 Returns true if the indicated character is an uppercase letter, false otherwise. More...
 
static int unicode_tolower (int character)
 Returns the uppercase equivalent of the given Unicode character. More...
 
static int unicode_toupper (int character)
 Returns the uppercase equivalent of the given Unicode character. More...
 
static string upper (const string &source)
 Converts the string to uppercase, assuming the string is encoded in the default encoding. More...
 
static string upper (const string &source, Encoding encoding)
 Converts the string to uppercase, assuming the string is encoded in the indicated encoding. More...
 
- Static Public Member Functions inherited from TextProperties
static TypeHandle get_class_type ()
 
static TextFontget_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

virtual LPoint3 bool const TransformState Thread *current_thread const
 
virtual LPoint3 bool & found_any
 
virtual LPoint3max_point
 
virtual LPoint3 bool const TransformState * transform
 
- Public Attributes inherited from PandaNode
virtual LPoint3 bool const TransformState Threadcurrent_thread = Thread::get_current_thread()) const
 
Threadcurrent_thread = Thread::get_current_thread()) const
 
virtual LPoint3 bool & found_any
 
virtual LPoint3max_point
 
static BamReaderreader = NULL)
 
virtual LPoint3 bool const TransformState * transform
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

The primary interface to this module.

This class does basic text assembly; given a string of text and a TextFont object, it creates a piece of geometry that may be placed in the 3-d or 2-d world to represent the indicated text.

The TextNode may be used in one of two ways. Naively, it may simply be parented directly into the scene graph and rendered as if it were a GeomNode; in this mode, the actual polygon geometry that renders the text is not directly visible or accessible, but remains hidden within the TextNode.

The second way TextNode may be used is as a text generator. To use it in this way, do not parent the TextNode to the scene graph; instead, set the properties of the text and call generate() to return an ordinary node, containing ordinary geometry, which you may use however you like. Each time you call generate() a new node is returned.

Definition at line 52 of file textNode.h.

Constructor & Destructor Documentation

◆ TextNode()

TextNode::TextNode ( const string &  name,
const TextProperties copy 
)

It's sort of a copy constructor: it copies the indicated TextProperties, without copying a complete TextNode.

Definition at line 106 of file textNode.cxx.

References calc_width(), and LMatrix4f::ident_mat().

Member Function Documentation

◆ append_text()

void TextNode::append_text ( const string &  text)
inline

Appends the indicates string to the end of the stored text.

Definition at line 1210 of file textNode.I.

References TextEncoder::append_text(), and append_unicode_char().

Referenced by clear_text().

◆ append_unicode_char()

void TextNode::append_unicode_char ( wchar_t  character)
inline

Appends a single character to the end of the stored text.

This may be a wide character, up to 16 bits in Unicode.

Definition at line 1223 of file textNode.I.

References TextEncoder::append_unicode_char(), and get_wordwrapped_text().

Referenced by append_text().

◆ append_wtext()

void TextNode::append_wtext ( const wstring &  text)
inline

Appends the indicates string to the end of the stored wide-character text.

Definition at line 1276 of file textNode.I.

References TextEncoder::append_wtext(), and get_wordwrapped_wtext().

Referenced by set_wtext().

◆ apply_attribs_to_vertices()

void TextNode::apply_attribs_to_vertices ( const AccumulatedAttribs attribs,
int  attrib_types,
GeomTransformer transformer 
)
virtual

Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate.

If this node uses geom arrays like a GeomNode, the supplied GeomTransformer may be used to unify shared arrays across multiple different nodes.

This is a generalization of xform().

Reimplemented from PandaNode.

Definition at line 558 of file textNode.cxx.

References SceneGraphReducer::apply_attribs(), ColorAttrib::get_color(), ColorAttrib::get_color_type(), ColorScaleAttrib::get_scale(), is_renderable(), and CullTraverser::traverse().

Referenced by get_unsafe_to_apply_attribs().

◆ calc_width() [1/3]

PN_stdfloat TextNode::calc_width ( wchar_t  character) const

Returns the width of a single character of the font, or 0.0 if the character is not known.

This may be a wide character (greater than 255).

Definition at line 191 of file textNode.cxx.

References TextAssembler::calc_width(), TextProperties::get_font(), and has_exact_character().

Referenced by calc_width(), get_wordwrapped_text(), is_whitespace(), and TextNode().

◆ calc_width() [2/3]

PN_stdfloat TextNode::calc_width ( const string &  line) const
inline

Returns the width of a line of text of arbitrary characters.

The line should not include the newline character.

Definition at line 1251 of file textNode.I.

References calc_width(), TextEncoder::decode_text(), and set_wtext().

◆ calc_width() [3/3]

PN_stdfloat TextNode::calc_width ( const wstring &  line) const

◆ clear_bin()

void TextNode::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 1052 of file textNode.I.

References TextProperties::clear_bin(), and set_draw_order().

Referenced by set_bin().

◆ clear_card()

void TextNode::clear_card ( )
inline

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

Definition at line 506 of file textNode.I.

References get_card_decal().

Referenced by set_card_decal().

◆ clear_font()

void TextNode::clear_font ( )
inline

Resets the font to the default font.

Definition at line 761 of file textNode.I.

References TextProperties::clear_font(), and set_small_caps().

Referenced by set_font().

◆ clear_frame()

void TextNode::clear_frame ( )
inline

Specifies that a border will not be drawn around the text.

Definition at line 315 of file textNode.I.

References is_frame_as_margin().

Referenced by set_frame_actual().

◆ clear_max_rows()

void TextNode::clear_max_rows ( )
inline

Resets the TextNode's default behavior of not limiting the number of rows of text.

Definition at line 56 of file textNode.I.

References has_max_rows().

Referenced by set_max_rows().

◆ clear_shadow()

void TextNode::clear_shadow ( )
inline

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

Definition at line 1019 of file textNode.I.

References TextProperties::clear_shadow(), and set_bin().

Referenced by set_shadow().

◆ clear_text()

void TextNode::clear_text ( )
inline

Removes the text from the TextNode.

Definition at line 1198 of file textNode.I.

References append_text(), and TextEncoder::clear_text().

Referenced by set_text().

◆ clear_text_color()

void TextNode::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 950 of file textNode.I.

References TextProperties::clear_shadow_color(), TextProperties::clear_text_color(), and set_shadow().

Referenced by clear_wordwrap().

◆ clear_wordwrap()

void TextNode::clear_wordwrap ( )
inline

Removes the wordwrap setting from the TextNode.

Text will be as wide as it is.

Definition at line 917 of file textNode.I.

References clear_text_color(), and TextProperties::clear_wordwrap().

Referenced by set_wordwrap().

◆ compute_internal_bounds()

void TextNode::compute_internal_bounds ( CPT(BoundingVolume) &  internal_bounds,
int &  internal_vertices,
int  pipeline_stage,
Thread current_thread 
) const
virtual

Called when needed to recompute the node's _internal_bound object.

Nodes that contain anything of substance should redefine this to do the right thing.

Reimplemented from PandaNode.

Definition at line 721 of file textNode.cxx.

References GeometricBoundingVolume::around(), and r_prepare_scene().

Referenced by is_renderable().

◆ force_update()

void TextNode::force_update ( )
inline

Forces the TextNode to recompute itself now, even if it believes nothing has changed.

Normally, this should not need to be called, but it may be useful if some properties change outside of the TextNode's knowledge (for instance, within the font).

Definition at line 1435 of file textNode.I.

Referenced by update().

◆ get_bottom()

PN_stdfloat TextNode::get_bottom ( ) const
inline

Returns the bottommost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.

Definition at line 1331 of file textNode.I.

References get_top().

Referenced by get_right().

◆ get_card_actual()

LVecBase4 TextNode::get_card_actual ( ) const
inline

Returns the actual dimensions of the card around the text.

If the card was set via set_card_as_margin(), the result returned by this function reflects the size of the current text; if the card was set via set_card_actual(), this returns the values actually set.

If the text has no card at all, this returns the dimensions of the text itself, as if the card were set with a margin of 0, 0, 0, 0.

Definition at line 578 of file textNode.I.

References get_card_as_set(), get_card_transformed(), and is_card_as_margin().

Referenced by get_card_as_set(), get_card_transformed(), r_prepare_scene(), and PGButton::setup().

◆ get_card_as_set()

LVecBase4 TextNode::get_card_as_set ( ) const
inline

Returns the dimensions of the card as set by set_card_as_margin() or set_card_actual().

Use is_card_actual() to determine how to interpret the values returned by this function. It is an error to call this if has_card() is false.

Definition at line 558 of file textNode.I.

References get_card_actual().

Referenced by get_card_actual(), and is_card_as_margin().

◆ get_card_decal()

bool TextNode::get_card_decal ( ) const
inline

Returns the card_decal flag.

See set_card_decal().

Definition at line 527 of file textNode.I.

References is_card_as_margin().

Referenced by calc_width(), and clear_card().

◆ get_card_transformed()

LVecBase4 TextNode::get_card_transformed ( ) const
inline

Returns the actual card dimensions, transformed by the matrix set by set_transform().

This returns the card dimensions in actual coordinates as seen by the rest of the world. Also see get_upper_left_3d() and get_lower_right_3d().

Definition at line 604 of file textNode.I.

References get_card_actual(), and set_transform().

Referenced by get_card_actual().

◆ get_flatten_flags()

int TextNode::get_flatten_flags ( ) const
inline

Returns the flatten flags.

See set_flatten_flags().

Definition at line 738 of file textNode.I.

References set_font().

Referenced by set_flatten_flags().

◆ get_frame_actual()

LVecBase4 TextNode::get_frame_actual ( ) const
inline

Returns the actual dimensions of the frame around the text.

If the frame was set via set_frame_as_margin(), the result returned by this function reflects the size of the current text; if the frame was set via set_frame_actual(), this returns the values actually set.

If the text has no frame at all, this returns the dimensions of the text itself, as if the frame were set with a margin of 0, 0, 0, 0.

Definition at line 377 of file textNode.I.

References get_frame_as_set(), is_frame_as_margin(), and set_frame_line_width().

Referenced by PandaFramework::event_question(), get_frame_as_set(), and r_prepare_scene().

◆ get_frame_as_set()

LVecBase4 TextNode::get_frame_as_set ( ) const
inline

Returns the dimensions of the frame as set by set_frame_as_margin() or set_frame_actual().

Use is_frame_actual() to determine how to interpret the values returned by this function. It is an error to call this if has_frame() is false.

Definition at line 357 of file textNode.I.

References get_frame_actual().

Referenced by get_frame_actual(), and is_frame_as_margin().

◆ get_frame_line_width()

PN_stdfloat TextNode::get_frame_line_width ( ) const
inline

Returns the thickness of the lines that will be used to draw the frame.

Definition at line 412 of file textNode.I.

References set_frame_corners().

Referenced by set_frame_line_width().

◆ get_height()

PN_stdfloat TextNode::get_height ( ) const
inline

Returns the net height of the text in local 2-d coordinates.

Definition at line 1356 of file textNode.I.

References get_width().

Referenced by get_top().

◆ get_internal_geom()

PandaNode * TextNode::get_internal_geom ( ) const

Returns the actual node that is used internally to render the text, if the TextNode is parented within the scene graph.

In general, you should not call this method. Call generate() instead if you want to get a handle to geometry that represents the text. This method is provided as a debugging aid only.

Definition at line 515 of file textNode.cxx.

References get_unsafe_to_apply_attribs().

Referenced by calc_width().

◆ get_left()

PN_stdfloat TextNode::get_left ( ) const
inline

Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.

Definition at line 1305 of file textNode.I.

References get_right().

Referenced by get_wordwrapped_wtext().

◆ get_line_height()

PN_stdfloat TextNode::get_line_height ( ) const
inline

Returns the number of units high each line of text is.

This is based on the font. Note that it is possible for the text to include nested font change commands, in which case the value of this method is questionable.

Definition at line 26 of file textNode.I.

References TextProperties::get_font(), TextFont::get_line_height(), and set_max_rows().

Referenced by PGEntry::setup(), and PGEntry::setup_minimal().

◆ get_lower_right_3d()

LPoint3 TextNode::get_lower_right_3d ( ) const
inline

Returns the lower-right extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix.

Definition at line 1394 of file textNode.I.

References get_num_rows().

Referenced by get_upper_left_3d().

◆ get_max_rows()

int TextNode::get_max_rows ( ) const
inline

Returns the limit on the height of the TextNode specified by set_max_rows().

Definition at line 79 of file textNode.I.

References has_overflow().

Referenced by has_max_rows().

◆ get_num_rows()

int TextNode::get_num_rows ( ) const
inline

Returns the number of rows of text that were generated.

This counts word-wrapped rows as well as rows generated due to embedded newlines.

Definition at line 1407 of file textNode.I.

References update().

Referenced by get_lower_right_3d().

◆ get_right()

PN_stdfloat TextNode::get_right ( ) const
inline

Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.

Definition at line 1318 of file textNode.I.

References get_bottom().

Referenced by get_left().

◆ get_top()

PN_stdfloat TextNode::get_top ( ) const
inline

Returns the topmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.

Definition at line 1344 of file textNode.I.

References get_height().

Referenced by get_bottom().

◆ get_unsafe_to_apply_attribs()

int TextNode::get_unsafe_to_apply_attribs ( ) const
virtual

Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node.

If this is nonzero, these attributes must be dropped at this node as a state change.

This is a generalization of safe_to_transform().

Reimplemented from PandaNode.

Definition at line 536 of file textNode.cxx.

References apply_attribs_to_vertices().

Referenced by get_internal_geom().

◆ get_upper_left_3d()

LPoint3 TextNode::get_upper_left_3d ( ) const
inline

Returns the upper-left extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix.

Definition at line 1381 of file textNode.I.

References get_lower_right_3d().

Referenced by get_width().

◆ get_usage_hint()

Geom::UsageHint TextNode::get_usage_hint ( ) const
inline

Returns the UsageHint that will be applied to generated geometry.

See set_usage_hint().

Definition at line 679 of file textNode.I.

References set_flatten_flags().

Referenced by r_prepare_scene(), and set_usage_hint().

◆ get_width()

PN_stdfloat TextNode::get_width ( ) const
inline

Returns the net width of the text in local 2-d coordinates.

Definition at line 1368 of file textNode.I.

References get_upper_left_3d().

Referenced by get_height().

◆ get_wordwrapped_text()

string TextNode::get_wordwrapped_text ( ) const
inline

Returns a string that represents the contents of the text, as it has been formatted by wordwrap rules.

In earlier versions, this did not contain any embedded special characters like \1 or \3; now it does.

Definition at line 1239 of file textNode.I.

References calc_width(), TextEncoder::encode_wtext(), and get_wordwrapped_wtext().

Referenced by append_unicode_char().

◆ get_wordwrapped_wtext()

wstring TextNode::get_wordwrapped_wtext ( ) const
inline

Returns a wstring that represents the contents of the text, as it has been formatted by wordwrap rules.

In earlier versions, this did not contain any embedded special characters like \1 or \3; now it does.

Definition at line 1292 of file textNode.I.

References get_left().

Referenced by append_wtext(), and get_wordwrapped_text().

◆ has_character()

bool TextNode::has_character ( wchar_t  character) const

Returns true if the named character exists in the font or can be synthesized by Panda, false otherwise.

(Panda can synthesize some accented characters by combining similar-looking glyphs from the font.)

This returns true for whitespace and Unicode whitespace characters (if they exist in the font), but returns false for characters that would render with the "invalid glyph".

Definition at line 242 of file textNode.cxx.

References TextProperties::get_font(), TextAssembler::has_character(), and is_whitespace().

Referenced by has_exact_character().

◆ has_exact_character()

bool TextNode::has_exact_character ( wchar_t  character) const

Returns true if the named character exists in the font exactly as named, false otherwise.

Note that because Panda can assemble glyphs together automatically using cheesy accent marks, this is not a reliable indicator of whether a suitable glyph can be rendered for the character. For that, use has_character() instead.

This returns true for whitespace and Unicode whitespace characters (if they exist in the font), but returns false for characters that would render with the "invalid glyph". It also returns false for characters that would be synthesized within Panda, but see has_character().

Definition at line 219 of file textNode.cxx.

References TextProperties::get_font(), has_character(), and TextAssembler::has_exact_character().

Referenced by calc_width().

◆ has_max_rows()

bool TextNode::has_max_rows ( ) const
inline

Returns true if a limit on the height of the TextNode has been set via set_max_rows(), false otherwise.

Definition at line 68 of file textNode.I.

References get_max_rows().

Referenced by clear_max_rows().

◆ has_overflow()

bool TextNode::has_overflow ( ) const
inline

Returns true if the last text set on the text node exceeded the max_rows constraint, or false if it all fit.

Definition at line 91 of file textNode.I.

References set_frame_as_margin().

Referenced by get_max_rows().

◆ is_card_as_margin()

bool TextNode::is_card_as_margin ( ) const
inline

If this is true, the card was set via a call to set_card_as_margin(), and the dimension of the card as returned by get_card_as_set() represent a margin all around the text.

If false, then the card was set via a call to set_card_actual(), and the dimensions of the card as returned by get_card_as_set() are relative to the text's origin.

Definition at line 543 of file textNode.I.

References get_card_as_set().

Referenced by get_card_actual(), and get_card_decal().

◆ is_frame_as_margin()

bool TextNode::is_frame_as_margin ( ) const
inline

If this is true, the frame was set via a call to set_frame_as_margin(), and the dimension of the frame as returned by get_frame_as_set() represent a margin all around the text.

If false, then the frame was set via a call to set_frame_actual(), and the dimensions of the frame as returned by get_frame_as_set() are relative to the text's origin.

Definition at line 342 of file textNode.I.

References get_frame_as_set().

Referenced by clear_frame(), and get_frame_actual().

◆ is_renderable()

bool TextNode::is_renderable ( ) const
virtual

Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise.

This will be used to optimize the result of get_net_draw_show_mask(), so that any subtrees that contain only nodes for which is_renderable() is false need not be visited.

Reimplemented from PandaNode.

Definition at line 708 of file textNode.cxx.

References compute_internal_bounds().

Referenced by apply_attribs_to_vertices().

◆ is_whitespace()

bool TextNode::is_whitespace ( wchar_t  character) const

Returns true if the indicated character represents whitespace in the font, or false if anything visible will be rendered for it.

This returns true for whitespace and Unicode whitespace characters (if they exist in the font), and returns false for any other characters, including characters that do not exist in the font (these would be rendered with the "invalid glyph", which is visible).

Note that this function can be reliably used to identify Unicode whitespace characters only if the font has all of the whitespace characters defined. It will return false for any character not in the font, even if it is an official Unicode whitespace character.

Definition at line 273 of file textNode.cxx.

References calc_width(), TextProperties::get_font(), and TextAssembler::is_whitespace().

Referenced by has_character().

◆ r_prepare_scene()

void TextNode::r_prepare_scene ( GraphicsStateGuardianBase gsg,
const RenderState node_state,
GeomTransformer transformer,
Thread current_thread 
)
virtual

◆ set_bin()

void TextNode::set_bin ( const string &  bin)
inline

Names the GeomBin that the TextNode geometry should be assigned to.

If this is set, then a GeomBinTransition will be created to explicitly place each component in the named bin.

The draw_order value will also be passed to each GeomBinTransition as appropriate; this is particularly useful if this names a GeomBinFixed, e.g. "fixed".

Definition at line 1038 of file textNode.I.

References clear_bin(), and TextProperties::set_bin().

Referenced by clear_shadow().

◆ set_card_actual()

void TextNode::set_card_actual ( PN_stdfloat  left,
PN_stdfloat  right,
PN_stdfloat  bottom,
PN_stdfloat  top 
)
inline

Similar to set_card_as_margin, except the card is specified in actual coordinate units (relative to the text's origin), irrespective of the size of the text.

The left and bottom coordinates should generally be negative, while the right and top coordinates should generally be positive.

Definition at line 473 of file textNode.I.

References set_card_decal().

Referenced by set_card_as_margin().

◆ set_card_as_margin()

void TextNode::set_card_as_margin ( PN_stdfloat  left,
PN_stdfloat  right,
PN_stdfloat  bottom,
PN_stdfloat  top 
)
inline

Specifies that a (possibly opaque or semitransparent) card will be held behind the text when it is next created.

Like set_frame_as_margin, the parameters are the amount of additional padding to insert around the text in each dimension, and all should generally be positive.

Definition at line 455 of file textNode.I.

References set_card_actual().

Referenced by set_frame_corners().

◆ set_card_decal()

void TextNode::set_card_decal ( bool  card_decal)
inline

Sets the card_decal flag.

When this is true, the text is decalled onto the card, which is necessary if the TextNode is to be rendered in the 3-d world without putting it in a bin.

Definition at line 490 of file textNode.I.

References clear_card().

Referenced by set_card_actual().

◆ set_coordinate_system()

void TextNode::set_coordinate_system ( CoordinateSystem  cs)
inline

Specifies the coordinate system in which the text will be generated.

Definition at line 641 of file textNode.I.

References set_usage_hint().

Referenced by set_transform().

◆ set_draw_order()

int TextNode::set_draw_order ( int  draw_order)
inline

Sets the drawing order of text created by the TextMaker.

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 arcs 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.

Definition at line 1073 of file textNode.I.

References TextProperties::set_draw_order(), and set_tab_width().

Referenced by clear_bin().

◆ set_flatten_flags()

void TextNode::set_flatten_flags ( int  flatten_flags)
inline

Sets the flatten flags.

This should be a union of the TextNode::FlattenFlags options. This controls the degree of flattening performed on the TextNode's internal geometry (i.e. the scene graph returned by generate()) each time the text is changed. In general, more flattening means a more optimal result, but it will take more time to generate.

The choice may be any of these three:

FF_none - No flatten operation is called. The letters are left as independent Geoms.

FF_light - A flatten_light() operation is called. The attributes are applied to the vertices, but no nodes are removed.

FF_medium - A flatten_medium() operation is called. The attributes are applied to the vertices, and a few trivial nodes are removed.

FF_strong - A flatten_strong() operation is called. The attributes are applied to the vertices, and the resulting nodes are aggressively combined into as few nodes as possible.

In addition to the above choices, you may optionally include the following flag:

FF_dynamic_merge - Copy the geoms into a single GeomVertexData as we go, instead of relying on the flatten operation at the end. This pre-flattens the text considerably, and may obviate the need for flatten altogether; it also tends to improve performance considerably even if you do call flatten. However, it is not as fast as not calling flatten at all.

The default is taken from the text-flatten and text-dynamic-merge config variables.

Definition at line 728 of file textNode.I.

References get_flatten_flags().

Referenced by get_usage_hint().

◆ set_font()

void TextNode::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().

Definition at line 750 of file textNode.I.

References clear_font(), and TextProperties::set_font().

Referenced by get_flatten_flags().

◆ set_frame_actual()

void TextNode::set_frame_actual ( PN_stdfloat  left,
PN_stdfloat  right,
PN_stdfloat  bottom,
PN_stdfloat  top 
)
inline

Similar to set_frame_as_margin, except the frame is specified in actual coordinate units (relative to the text's origin), irrespective of the size of the text.

The left and bottom coordinates should generally be negative, while the right and top coordinates should generally be positive.

Definition at line 300 of file textNode.I.

References clear_frame().

Referenced by set_frame_as_margin().

◆ set_frame_as_margin()

void TextNode::set_frame_as_margin ( PN_stdfloat  left,
PN_stdfloat  right,
PN_stdfloat  bottom,
PN_stdfloat  top 
)
inline

Specifies that a border will be drawn around the text when it is next created.

The parameters are the amount of additional padding to insert between the frame and the text in each dimension, and all should generally be positive.

Definition at line 282 of file textNode.I.

References set_frame_actual().

Referenced by has_overflow().

◆ set_frame_corners()

void TextNode::set_frame_corners ( bool  corners)
inline

Enables or disables the drawing of corners for the frame.

These are extra points drawn at each of the four corners, to soften the ugly edges generated when the line width is greater than one.

Definition at line 425 of file textNode.I.

References set_card_as_margin().

Referenced by get_frame_line_width().

◆ set_frame_line_width()

void TextNode::set_frame_line_width ( PN_stdfloat  line_width)
inline

Specifies the thickness of the lines that will be used to draw the frame.

Definition at line 400 of file textNode.I.

References get_frame_line_width().

Referenced by get_frame_actual().

◆ set_glyph_scale()

void TextNode::set_glyph_scale ( PN_stdfloat  glyph_scale)
inline

Specifies the factor by which to scale each letter of the text as it is placed.

This can be used (possibly in conjunction with set_glyph_shift()) to implement superscripting or subscripting.

Definition at line 1122 of file textNode.I.

References TextProperties::set_glyph_scale(), and set_glyph_shift().

Referenced by set_tab_width().

◆ set_glyph_shift()

void TextNode::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.

Definition at line 1147 of file textNode.I.

References TextProperties::set_glyph_shift(), and set_text().

Referenced by set_glyph_scale().

◆ set_indent()

void TextNode::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.

Definition at line 881 of file textNode.I.

References TextProperties::clear_indent(), TextProperties::set_indent(), and set_wordwrap().

Referenced by set_small_caps_scale().

◆ set_max_rows()

void TextNode::set_max_rows ( int  max_rows)
inline

Sets the maximum number of rows that may be formatted by the TextNode.

If more text than this is attempted, it will be truncated and has_overflow() will return true.

Definition at line 44 of file textNode.I.

References clear_max_rows().

Referenced by get_line_height().

◆ set_shadow() [1/2]

void TextNode::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.

Definition at line 995 of file textNode.I.

Referenced by clear_text_color(), PandaFramework::event_f9(), and PandaFramework::event_question().

◆ set_shadow() [2/2]

void TextNode::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.

Definition at line 1007 of file textNode.I.

References clear_shadow(), and TextProperties::set_shadow().

◆ set_small_caps()

void TextNode::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().

Definition at line 788 of file textNode.I.

References TextProperties::set_small_caps(), and set_small_caps_scale().

Referenced by clear_font().

◆ set_small_caps_scale()

void TextNode::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.

Definition at line 813 of file textNode.I.

References TextProperties::clear_align(), TextProperties::set_align(), set_indent(), TextProperties::set_slant(), and TextProperties::set_small_caps_scale().

Referenced by set_small_caps().

◆ set_tab_width()

void TextNode::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.

Definition at line 1097 of file textNode.I.

References set_glyph_scale(), and TextProperties::set_tab_width().

Referenced by set_draw_order().

◆ set_text() [1/2]

void TextNode::set_text ( const string &  text)
inline

Changes the text that is displayed under the TextNode.

Definition at line 1171 of file textNode.I.

References TextEncoder::set_text().

Referenced by PandaFramework::event_f9(), PandaFramework::event_question(), set_glyph_shift(), and PGButton::setup().

◆ set_text() [2/2]

void TextNode::set_text ( const string &  text,
TextNode::Encoding  encoding 
)
inline

The two-parameter version of set_text() accepts an explicit encoding; the text is immediately decoded and stored as a wide-character string.

Subsequent calls to get_text() will return the same text re-encoded using whichever encoding is specified by set_encoding().

Definition at line 1187 of file textNode.I.

References clear_text(), and TextEncoder::set_text().

◆ set_transform()

void TextNode::set_transform ( const LMatrix4 transform)
inline

Sets an additional transform that is applied to the entire text paragraph.

Definition at line 619 of file textNode.I.

References set_coordinate_system().

Referenced by get_card_transformed().

◆ set_usage_hint()

void TextNode::set_usage_hint ( Geom::UsageHint  usage_hint)
inline

Specifies the UsageHint that will be applied to generated geometry.

The default is UH_static, which is probably the right setting, but if you know the TextNode's geometry will have a short lifespan, it may be better to set it to UH_stream. See geomEnums.h.

Definition at line 667 of file textNode.I.

References get_usage_hint().

Referenced by set_coordinate_system().

◆ set_wordwrap()

void TextNode::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.

Definition at line 905 of file textNode.I.

References clear_wordwrap(), and TextProperties::set_wordwrap().

Referenced by set_indent().

◆ set_wtext()

void TextNode::set_wtext ( const wstring &  wtext)
inline

Changes the text that is displayed under the TextNode, with a wide text.

This automatically sets the string reported by get_text() to the 8-bit encoded version of the same string.

Definition at line 1264 of file textNode.I.

References append_wtext(), and TextEncoder::set_wtext().

Referenced by calc_width().

◆ update()

void TextNode::update ( )
inline

Can be called after the TextNode has been fully configured, to force the node to recompute its text immediately, rather than waiting for it to be drawn.

This call is optional.

Definition at line 1421 of file textNode.I.

References force_update().

Referenced by get_num_rows().


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