TextNode

Inheritance:

Methods of TextNode:

Methods of PandaNode:

Methods of TypedWritable:

Methods of TypedObject:

Methods of Namable:

Methods of ReferenceCount:

Methods of TextEncoder:

Methods of TextProperties:

Constants in PandaNode:

Constants in TextEncoder:

Constants in TextProperties:

TextNode
TextNode::TextNode(string const &name);

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

appendText
void TextNode::append_text(string const &text);

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

appendUnicodeChar
void TextNode::append_unicode_char(int character);

Description: Appends a single character to the end of the stored text. This may be a wide character, up to 16 bits in Unicode.

appendWtext
void TextNode::append_wtext(basic_string< wchar_t > const &text);

Direct support for wide-character strings.
Description: Appends the indicates string to the end of the stored wide-character text.

calcWidth
float TextNode::calc_width(int character) const;

These methods calculate the width of a single character or a line of text in the current font.
Description: Returns the width of a line of text of arbitrary characters. The line should not include the newline character.
Description: 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).
Description: Returns the width of a line of text of arbitrary characters. The line should not include the newline character or any embedded control characters like \1 or \3.

clearAlign
void TextNode::clear_align(void);

Description:

clearBin
void TextNode::clear_bin(void);

Description: 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.

clearCard
void TextNode::clear_card(void);

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

clearCardBorder
void TextNode::clear_card_border(void);

Description:

clearCardTexture
void TextNode::clear_card_texture(void);

Description:

clearDrawOrder
void TextNode::clear_draw_order(void);

Description:

clearFont
void TextNode::clear_font(void);

Description: Resets the font to the default font.

clearFrame
void TextNode::clear_frame(void);

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

clearGlyphScale
void TextNode::clear_glyph_scale(void);

Description:

clearGlyphShift
void TextNode::clear_glyph_shift(void);

Description:

clearIndent
void TextNode::clear_indent(void);

Description:

clearMaxRows
void TextNode::clear_max_rows(void);

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

clearShadow
void TextNode::clear_shadow(void);

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

clearShadowColor
void TextNode::clear_shadow_color(void);

Description:

clearSlant
void TextNode::clear_slant(void);

Description:

clearSmallCaps
void TextNode::clear_small_caps(void);

Description:

clearSmallCapsScale
void TextNode::clear_small_caps_scale(void);

Description:

clearTabWidth
void TextNode::clear_tab_width(void);

Description:

clearText
void TextNode::clear_text(void);

Description: Removes the text from the TextNode.

clearTextColor
void TextNode::clear_text_color(void);

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

clearWordwrap
void TextNode::clear_wordwrap(void);

Description: Removes the wordwrap setting from the TextNode. Text will be as wide as it is.

forceUpdate
void TextNode::force_update(void);

Description: 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).

generate
PointerTo< PandaNode > TextNode::generate(void);

Description: Generates the text, according to the parameters indicated within the TextNode, and returns a Node that may be parented within the tree to represent it.

getBottom
float TextNode::get_bottom(void) const;

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

getCardActual
LVecBase4f TextNode::get_card_actual(void) const;

Description: 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.

getCardAsSet
LVecBase4f TextNode::get_card_as_set(void) const;

Description: 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.

getCardBorderSize
float TextNode::get_card_border_size(void) const;

Description:

getCardBorderUvPortion
float TextNode::get_card_border_uv_portion(void) const;

Description:

getCardColor
LVecBase4f TextNode::get_card_color(void) const;

Description:

getCardDecal
bool TextNode::get_card_decal(void) const;

Description: Returns the card_decal flag. See set_card_decal().

getCardTexture
Texture *TextNode::get_card_texture(void) const;

Description:

getCardTransformed
LVecBase4f TextNode::get_card_transformed(void) const;

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

getClassType
static TypeHandle TextNode::get_class_type(void);

Undocumented function.

getCoordinateSystem
CoordinateSystem TextNode::get_coordinate_system(void) const;

Description:

getFrameActual
LVecBase4f TextNode::get_frame_actual(void) const;

Description: 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.

getFrameAsSet
LVecBase4f TextNode::get_frame_as_set(void) const;

Description: 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.

getFrameColor
LVecBase4f TextNode::get_frame_color(void) const;

Description:

getFrameCorners
bool TextNode::get_frame_corners(void) const;

Description:

getFrameLineWidth
float TextNode::get_frame_line_width(void) const;

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

getHeight
float TextNode::get_height(void) const;

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

getInternalGeom
PandaNode *TextNode::get_internal_geom(void) const;

Description: 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.

getLeft
float TextNode::get_left(void) const;

The following functions return information about the text that was last built (and is currently visible).
Description: Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.

getLineHeight
float TextNode::get_line_height(void) const;

Description: 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.

getLowerRight3d
LPoint3f TextNode::get_lower_right_3d(void) const;

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

getMaxRows
int TextNode::get_max_rows(void) const;

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

getNumRows
int TextNode::get_num_rows(void) const;

Description: Returns the number of rows of text that were generated. This counts word-wrapped rows as well as rows generated due to embedded newlines.

getRight
float TextNode::get_right(void) const;

The following functions return information about the text that was last built (and is currently visible).
Description: Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.

getTop
float TextNode::get_top(void) const;

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

getTransform
LMatrix4f TextNode::get_transform(void) const;

Description:

getUpperLeft3d
LPoint3f TextNode::get_upper_left_3d(void) const;

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

getUsageHint
GeomEnums::UsageHint TextNode::get_usage_hint(void) const;

Description: Returns the UsageHint that will be applied to generated geometry. See set_usage_hint().

getWidth
float TextNode::get_width(void) const;

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

getWordwrappedText
string TextNode::get_wordwrapped_text(void) const;

After the text has been set, you can query this to determine how it will be wordwrapped.
Description: 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.

getWordwrappedWtext
basic_string< wchar_t > TextNode::get_wordwrapped_wtext(void) const;

Description: 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.

hasCard
bool TextNode::has_card(void) const;

Description:

hasCardBorder
bool TextNode::has_card_border(void) const;

Description:

hasCardTexture
bool TextNode::has_card_texture(void) const;

Description:

hasFrame
bool TextNode::has_frame(void) const;

Description:

hasMaxRows
bool TextNode::has_max_rows(void) const;

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

hasOverflow
bool TextNode::has_overflow(void) const;

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

isCardAsMargin
bool TextNode::is_card_as_margin(void) const;

Description: 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.

isFrameAsMargin
bool TextNode::is_frame_as_margin(void) const;

Description: 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.

output
virtual void TextNode::output(ostream &out) const;

Description:

setAlign
void TextNode::set_align(TextProperties::Alignment align_type);

Description:

setBin
void TextNode::set_bin(string const &bin);

Description: 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".

setCardActual
void TextNode::set_card_actual(float left, float right, float bottom, float top);

Description: 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.

setCardAsMargin
void TextNode::set_card_as_margin(float left, float right, float bottom, float top);

Description: 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.

setCardBorder
void TextNode::set_card_border(float size, float uv_portion);

Description:

setCardColor
void TextNode::set_card_color(float r, float g, float b, float a);

Description:

setCardDecal
void TextNode::set_card_decal(bool card_decal);

Description: 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.

setCardTexture
void TextNode::set_card_texture(Texture *card_texture);

Description:

setCoordinateSystem
void TextNode::set_coordinate_system(CoordinateSystem cs);

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

setDrawOrder
int TextNode::set_draw_order(int draw_order);

Description: 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.

setFont
void TextNode::set_font(TextFont *font);

These methods are inherited from TextProperties, but we override here so we can flag the TextNode as dirty when they have been changed.
Description: 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().

setFrameActual
void TextNode::set_frame_actual(float left, float right, float bottom, float top);

Description: 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.

setFrameAsMargin
void TextNode::set_frame_as_margin(float left, float right, float bottom, float top);

Description: 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.

setFrameColor
void TextNode::set_frame_color(float r, float g, float b, float a);

Description:

setFrameCorners
void TextNode::set_frame_corners(bool corners);

Description: 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.

setFrameLineWidth
void TextNode::set_frame_line_width(float line_width);

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

setGlyphScale
void TextNode::set_glyph_scale(float glyph_scale);

Description: 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.

setGlyphShift
void TextNode::set_glyph_shift(float glyph_shift);

Description: 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.

setIndent
void TextNode::set_indent(float indent);

Description: 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.

setMaxRows
void TextNode::set_max_rows(int max_rows);

Description: 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.

setShadow
void TextNode::set_shadow(float xoffset, float yoffset);

Description: 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.

setShadowColor
void TextNode::set_shadow_color(float r, float g, float b, float a);

Description:

setSlant
void TextNode::set_slant(float slant);

Description:

setSmallCaps
void TextNode::set_small_caps(bool small_caps);

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

setSmallCapsScale
void TextNode::set_small_caps_scale(float small_caps_scale);

Description: 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.

setTabWidth
void TextNode::set_tab_width(float tab_width);

Description: 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.

setText
void TextNode::set_text(string const &text);

These methods are inherited from TextEncoder, but we override here so we can flag the TextNode as dirty when they have been changed.
Description: Changes the text that is displayed under the TextNode.
Description: 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().

setTextColor
void TextNode::set_text_color(float r, float g, float b, float a);

Description:

setTransform
void TextNode::set_transform(LMatrix4f const &transform);

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

setUsageHint
void TextNode::set_usage_hint(GeomEnums::UsageHint usage_hint);

Description: 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.

setWordwrap
void TextNode::set_wordwrap(float wordwrap);

Description: 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.

setWtext
void TextNode::set_wtext(basic_string< wchar_t > const &wtext);

Direct support for wide-character strings.
Description: 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.

update
void TextNode::update(void);

Description: 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.

write
virtual void TextNode::write(ostream &out, int indent_level = (0)) const;

Description:

PandaNode
PandaNode::PandaNode(string const &name);

There are two different interfaces here for making and breaking parent-child connections: the fundamental PandaNode interface, via add_child() and remove_child() (and related functions), and the NodePath support interface, via attach(), detach(), and reparent(). They both do essentially the same thing, but with slightly different inputs. The PandaNode interfaces try to guess which NodePaths should be updated as a result of the scene graph change, while the NodePath interfaces already know.
The NodePath support interface functions are strictly called from within the NodePath class, and are used to implement NodePath::reparent_to() and NodePath::remove_node(), etc. The fundamental interface, on the other hand, is intended to be called directly by the user.
The fundamental interface has a slightly lower overhead because it does not need to create a NodePathComponent chain where one does not already exist; however, the NodePath support interface is more useful when the NodePath already does exist, because it ensures that the particular NodePath calling it is kept appropriately up-to-date.
Description:
Description: Do not call the copy constructor directly; instead, use make_copy() or copy_subgraph() to make a copy of a node.

addChild
void PandaNode::add_child(PandaNode *child_node, int sort = (0), Thread *current_thread = ((get_current_thread())));

Description: Adds a new child to the node. The child is added in the relative position indicated by sort; if all children have the same sort index, the child is added at the end.
If the same child is added to a node more than once, the previous instance is first removed.

addStashed
void PandaNode::add_stashed(PandaNode *child_node, int sort = (0), Thread *current_thread = ((get_current_thread())));

Description: Adds a new child to the node, directly as a stashed child. The child is not added in the normal sense, but will be revealed if unstash_child() is called on it later.
If the same child is added to a node more than once, the previous instance is first removed.
This can only be called from the top pipeline stage (i.e. from App).

adjustDrawMask
void PandaNode::adjust_draw_mask(BitMask< unsigned int, 32 > show_mask, BitMask< unsigned int, 32 > hide_mask, BitMask< unsigned int, 32 > clear_mask);

Description: Adjusts the hide/show bits of this particular node.
These three parameters can be used to adjust the _draw_control_mask and _draw_show_mask independently, which work together to provide per-camera visibility for the node and its descendents.
_draw_control_mask indicates the bits in _draw_show_mask that are significant. Each different bit corresponds to a different camera (and these bits are assigned via Camera::set_camera_mask()).
Where _draw_control_mask has a 1 bit, a 1 bit in _draw_show_mask indicates the node is visible to that camera, and a 0 bit indicates the node is hidden to that camera. Where _draw_control_mask is 0, the node is hidden only if a parent node is hidden.
The meaning of the three parameters is as follows:
* Wherever show_mask is 1, _draw_show_mask and
_draw_control_mask will be set 1. Thus, show_mask indicates the set of cameras to which the node should be shown.
* Wherever hide_mask is 1, _draw_show_mask will be
set 0 and _draw_control_mask will be set 1. Thus, hide_mask indicates the set of cameras from which the node should be hidden.
* Wherever clear_mask is 1, _draw_control_mask will
be set 0. Thus, clear_mask indicates the set of cameras from which the hidden state should be inherited from a parent.

asLight
virtual Light *PandaNode::as_light(void);

Description: 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.

clearAttrib
void PandaNode::clear_attrib(TypeHandle type);

Description: Removes the render attribute of the given type from this node. This node, and the subgraph below, will now inherit the indicated render attribute from the nodes above this one.

clearBounds
void PandaNode::clear_bounds(void);

Description: 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.

clearEffect
void PandaNode::clear_effect(TypeHandle type);

Description: Removes the render effect of the given type from this node.

clearEffects
void PandaNode::clear_effects(Thread *current_thread = ((get_current_thread())));

Description: Resets this node to have no render effects.

clearPythonTag
void PandaNode::clear_python_tag(string const &key);

Description: Removes the Python object defined for this key on this particular node. After a call to clear_python_tag(), has_python_tag() will return false for the indicated key.

clearState
void PandaNode::clear_state(Thread *current_thread = ((get_current_thread())));

Description: Resets this node to leave the render state alone. Nodes at this level and below will once again inherit their render state unchanged from the nodes above this level.

clearTag
void PandaNode::clear_tag(string const &key, Thread *current_thread = ((get_current_thread())));

Description: Removes the value defined for this key on this particular node. After a call to clear_tag(), has_tag() will return false for the indicated key.

clearTransform
void PandaNode::clear_transform(Thread *current_thread = ((get_current_thread())));

Description: Resets the transform on this node to the identity transform.

clearUnexpectedChange
void PandaNode::clear_unexpected_change(unsigned int flags);

Description: Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. See set_unexpected_change().
The input parameter is the union of bits that are to be cleared.
Since this is a developer debugging tool only, this function does nothing in a production (NDEBUG) build.

combineWith
virtual PandaNode *PandaNode::combine_with(PandaNode *other);

published so that characters can be combined.
Description: 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.
The return value may be this, other, or a new PandaNode altogether.
This function is called from GraphReducer::flatten(), and need not deal with children; its job is just to decide whether to collapse the two PandaNodes and what the collapsed PandaNode should look like.

compareTags
int PandaNode::compare_tags(PandaNode const *other) const;

Description: Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. If this returns 0, the tags are identical. If it returns other than 0, then the tags are different; and the nodes may be sorted into a consistent (but arbitrary) ordering based on this number.

copyAllProperties
void PandaNode::copy_all_properties(PandaNode *other);

Description: Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. Typically this is used to prepare a node to replace another node in the scene graph (also see replace_node()).

copyChildren
void PandaNode::copy_children(PandaNode *other, Thread *current_thread = ((get_current_thread())));

Description: Makes another instance of all the children of the other node, copying them to this node.

copySubgraph
PointerTo< PandaNode > PandaNode::copy_subgraph(Thread *current_thread = ((get_current_thread()))) const;

Description: Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. Some data may still be shared from the original (e.g. vertex index tables), but nothing that will impede normal use of the PandaNode.

copyTags
void PandaNode::copy_tags(PandaNode *other);

HAVE_PYTHON
Description: Copies all of the tags stored on the other node onto this node. If a particular tag exists on both nodes, the contents of this node's value is replaced by that of the other.

countNumDescendants
int PandaNode::count_num_descendants(void) const;

Description: Returns the number of nodes at and below this level.

findChild
int PandaNode::find_child(PandaNode *node, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the index of the indicated child node, if it is a child, or -1 if it is not.

findParent
int PandaNode::find_parent(PandaNode *node, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the index of the indicated parent node, if it is a parent, or -1 if it is not.

findStashed
int PandaNode::find_stashed(PandaNode *node, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not.

getAllCameraMask
static BitMask< unsigned int, 32 > PandaNode::get_all_camera_mask(void);

Description: Returns a DrawMask that is appropriate for rendering to all cameras.

getAttrib
RenderAttrib const *PandaNode::get_attrib(TypeHandle type) const;

Description: Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes.

getBounds
ConstPointerTo< BoundingVolume > PandaNode::get_bounds(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes.
Description: This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. When this sequence number changes, it indicates that the bounding volume might have changed, e.g. because some nested child's bounding volume has changed.
Although this might occasionally increment without changing the bounding volume, the bounding volume will never change without incrementing this counter, so as long as this counter remains unchanged you can be confident the bounding volume is also unchanged.

getChild
PandaNode *PandaNode::get_child(int n, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the nth child node of this node. See get_num_children(). Also see get_children(), if your intention is to iterate through the complete list of children; get_children() is preferable in this case.

getChildSort
int PandaNode::get_child_sort(int n, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). See get_num_children().

getClassType
static TypeHandle PandaNode::get_class_type(void);

Undocumented function.

getDrawControlMask
BitMask< unsigned int, 32 > PandaNode::get_draw_control_mask(void) const;

Description: Returns the set of bits in draw_show_mask that are considered meaningful. See adjust_draw_mask().

getDrawShowMask
BitMask< unsigned int, 32 > PandaNode::get_draw_show_mask(void) const;

Description: Returns the hide/show bits of this particular node. See adjust_draw_mask().

getEffect
RenderEffect const *PandaNode::get_effect(TypeHandle type) const;

Description: Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not.

getEffects
RenderEffects const *PandaNode::get_effects(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the complete RenderEffects that will be applied to this node.

getFancyBits
int PandaNode::get_fancy_bits(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. If this returns 0, the node has nothing interesting about it. This is intended to speed traversal by quickly skipping past nodes that don't particularly affect the render state.

getInternalBounds
ConstPointerTo< BoundingVolume > PandaNode::get_internal_bounds(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the node's internal bounding volume. This is the bounding volume around the node alone, without including children. If the user has called set_bounds(), it will be the specified bounding volume.
Description: Returns the node's internal bounding volume. This is the bounding volume around the node alone, without including children.

getInternalVertices
int PandaNode::get_internal_vertices(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.
This may not include all vertices for certain dynamic effects.

getIntoCollideMask
BitMask< unsigned int, 32 > PandaNode::get_into_collide_mask(void) const;

Description: Returns the "into" collide mask for this node.

getLegalCollideMask
virtual BitMask< unsigned int, 32 > PandaNode::get_legal_collide_mask(void) const;

Description: Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. For most nodes, this is 0; it doesn't make sense to set a CollideMask for most kinds of nodes.
For nodes that can be collided with, such as GeomNode and CollisionNode, this returns all bits on.

getNestedVertices
int PandaNode::get_nested_vertices(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the total number of vertices that will be rendered by this node and all of its descendents.
This is not necessarily an accurate count of vertices that will actually be rendered, since this will include all vertices of all LOD's, and it will also include hidden nodes. It may also omit or only approximate certain kinds of dynamic geometry. However, it will not include stashed nodes.

getNetCollideMask
BitMask< unsigned int, 32 > PandaNode::get_net_collide_mask(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below.

getNetDrawControlMask
BitMask< unsigned int, 32 > PandaNode::get_net_draw_control_mask(void) const;

Description: Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited.
A 1 bit in any position of this mask indicates that (a) this node has renderable children, and (b) some child of this node has made an explicit hide() or show_through() call for the corresponding bit.

getNetDrawShowMask
BitMask< unsigned int, 32 > PandaNode::get_net_draw_show_mask(void) const;

Description: Returns the union of all draw_show_mask values--of renderable nodes only--at this level and below. If any bit in this mask is 0, there is no reason to traverse below this node for a camera with the corresponding camera_mask.
The bits in this mask that do not correspond to a 1 bit in the net_draw_control_mask are meaningless (and will be set to 1). For bits that *do* correspond to a 1 bit in the net_draw_control_mask, a 1 bit indicates that at least one child should be visible, while a 0 bit indicates that all children are hidden.

getNumChildren
int PandaNode::get_num_children(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the number of child nodes this node has. The order of the child nodes *is* meaningful and is based on the sort number that was passed to add_child(), and also on the order in which the nodes were added.

getNumParents
int PandaNode::get_num_parents(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the number of parent nodes this node has. If this number is greater than 1, the node has been multiply instanced. The order of the parent nodes is not meaningful and is not related to the order in which the node was instanced to them.

getNumStashed
int PandaNode::get_num_stashed(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the number of stashed nodes this node has. These are former children of the node that have been moved to the special stashed list via stash_child().

getOffClipPlanes
ConstPointerTo< RenderAttrib > PandaNode::get_off_clip_planes(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned *off* at this level and below.

getOverallBit
static BitMask< unsigned int, 32 > PandaNode::get_overall_bit(void);

Description: Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits.

getParent
PandaNode *PandaNode::get_parent(int n, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the nth parent node of this node. See get_num_parents(). Also see get_parents(), if your intention is to iterate through the complete list of parents; get_parents() is preferable in this case.

getPrevTransform
TransformState const *PandaNode::get_prev_transform(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the transform that has been set as this node's "previous" position. See set_prev_transform().

getPythonTag
PyObject *PandaNode::get_python_tag(string const &key) const;

Description: Retrieves the Python object that was previously set on this node for the particular key, if any. If no value has been previously set, returns None.

getStashed
PandaNode *PandaNode::get_stashed(int n, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the nth stashed child of this node. See get_num_stashed(). Also see get_stashed(), if your intention is to iterate through the complete list of stashed children; get_stashed() is preferable in this case.
Description: Returns an object that can be used to walk through the list of children of the node. When you intend to visit multiple children, using this is slightly faster than calling get_stashed() directly on the PandaNode, since this object avoids reopening the PipelineCycler each time.
This object also protects you from self-modifying loops (e.g. adding or removing children during traversal), since a virtual copy of the children is made ahead of time. The virtual copy is fast--it is a form of copy-on-write, so the list is not actually copied unless it is modified during the traversal.

getStashedSort
int PandaNode::get_stashed_sort(int n, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). See get_num_stashed().

getState
RenderState const *PandaNode::get_state(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. This returns only the RenderState set on this particular node, and has nothing to do with state that might be inherited from above.

getTag
string PandaNode::get_tag(string const &key, Thread *current_thread = ((get_current_thread()))) const;

Description: Retrieves the user-defined value that was previously set on this node for the particular key, if any. If no value has been previously set, returns the empty string.

getTransform
TransformState const *PandaNode::get_transform(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the transform that has been set on this particular node. This is not the net transform from the root, but simply the transform on this particular node.

getUnexpectedChange
unsigned int PandaNode::get_unexpected_change(unsigned int flags) const;

Description: 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 specifically, this returns the particular set of bits (masked by the input parameter) that have been set on this node. See set_unexpected_change().
Since this is a developer debugging tool only, this function always returns zero in a production (NDEBUG) build.

hasAttrib
bool PandaNode::has_attrib(TypeHandle type) const;

Description: Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not.

hasDirtyPrevTransform
bool PandaNode::has_dirty_prev_transform(void) const;

Description: Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). In this case, the node will be visited by reset_prev_transform().

hasEffect
bool PandaNode::has_effect(TypeHandle type) const;

Description: Returns true if there is a render effect of the indicated type defined on this node, or false if there is not.

hasPythonTag
bool PandaNode::has_python_tag(string const &key) const;

Description: Returns true if a Python object has been defined on this node for the particular key (even if that object is None), or false if no object has been set.

hasTag
bool PandaNode::has_tag(string const &key, Thread *current_thread = ((get_current_thread()))) const;

Description: Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set.

hasTags
bool PandaNode::has_tags(void) const;

HAVE_PYTHON
Description: Returns true if the node has any tags (or any Python tags) at all, false if it has none.

isBoundsStale
bool PandaNode::is_bounds_stale(void) const;

Description: Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed.

isFinal
bool PandaNode::is_final(Thread *current_thread = ((get_current_thread()))) const;

Description: Returns the current state of the "final" flag. Initially, this flag is off (false), but it may be changed by an explicit call to set_final(). See set_final().

isGeomNode
virtual bool PandaNode::is_geom_node(void) const;

Description: A simple downcast check. Returns true if this kind of node happens to inherit from GeomNode, false otherwise.
This is provided as a a faster alternative to calling is_of_type(GeomNode::get_class_type()), since this test is so important to rendering.

isLodNode
virtual bool PandaNode::is_lod_node(void) const;

Description: A simple downcast check. Returns true if this kind of node happens to inherit from LODNode, false otherwise.
This is provided as a a faster alternative to calling is_of_type(LODNode::get_class_type()).

isOverallHidden
bool PandaNode::is_overall_hidden(void) const;

Description: Returns true if the node has been hidden to all cameras by clearing its overall bit.

listTags
void PandaNode::list_tags(ostream &out, string const &separator = ("\n")) const;

Description: Writes a list of all the tag keys assigned to the node to the indicated stream. Writes one instance of the separator following each key (but does not write a terminal separator). The value associated with each key is not written.
This is mainly for the benefit of the realtime user, to see the list of all of the associated tag keys.

ls
void PandaNode::ls(ostream &out, int indent_level) const;

Description: Lists all the nodes at and below the current path hierarchically.

markBoundsStale
void PandaNode::mark_bounds_stale(Thread *current_thread = ((get_current_thread()))) const;

Description: Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed.
With no parameters, this means to iterate through all stages including and upstream of the current pipeline stage.
This method is intended for internal use; usually it is not necessary for a user to call this directly. It will be called automatically by derived classes when appropriate.

markInternalBoundsStale
void PandaNode::mark_internal_bounds_stale(Thread *current_thread = ((get_current_thread())));

Description: Should be called by a derived class to mark the internal bounding volume stale, so that recompute_internal_bounds() will be called when the bounding volume is next requested.
Description: Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested.
With no parameters, this means to iterate through all stages including and upstream of the current pipeline stage.
It is normally not necessary to call this method directly; each node should be responsible for calling it when its internals have changed.

output
virtual void PandaNode::output(ostream &out) const;

Description:

removeAllChildren
void PandaNode::remove_all_children(Thread *current_thread = ((get_current_thread())));

Description: Removes all the children from the node at once, including stashed children.
This can only be called from the top pipeline stage (i.e. from App).

removeChild
void PandaNode::remove_child(int child_index, Thread *current_thread = ((get_current_thread())));

Description: Removes the nth child from the node.
Description: Removes the indicated child from the node. Returns true if the child was removed, false if it was not already a child of the node. This will also successfully remove the child if it had been stashed.

removeStashed
void PandaNode::remove_stashed(int child_index, Thread *current_thread = ((get_current_thread())));

Description: Removes the nth stashed child from the node.

replaceChild
bool PandaNode::replace_child(PandaNode *orig_child, PandaNode *new_child, Thread *current_thread = ((get_current_thread())));

Description: Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. Returns true if the replacement is made, or false if the node is not a child or if there is some other problem.

replaceNode
void PandaNode::replace_node(PandaNode *other);

Description: Inserts this node into the scene graph in place of the other one, and removes the other node. All scene graph attributes (TransformState, RenderState, etc.) are copied to this node.
All children are moved to this node, and removed from the old node. The new node is left in the same place in the old node's parent's list of children.
Even NodePaths that reference the old node are updated in-place to reference the new node instead.
This method is intended to be used to replace a node of a given type in the scene graph with a node of a different type.

resetAllPrevTransform
static void PandaNode::reset_all_prev_transform(Thread *current_thread = ((get_current_thread())));

Description: 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.

resetPrevTransform
void PandaNode::reset_prev_transform(Thread *current_thread = ((get_current_thread())));

Description: Resets the transform that represents this node's "previous" position to the same as the current transform. This is not the same thing as clearing it to identity.

setAttrib
void PandaNode::set_attrib(RenderAttrib const *attrib, int override = (0));

Description: Adds the indicated render attribute to the scene graph on this node. This attribute will now apply to this node and everything below. If there was already an attribute of the same type, it is replaced.

setBound
void PandaNode::set_bound(BoundingVolume const *volume);

A node has three bounding volumes: an "external" bounding volume that represents the node and all of its children, an "internal" bounding volume which represents only the node itself (and is usually empty, unless a specific node type sets it otherwise), and a "user" bounding volume which is specified by the user. We define set_bounds() and get_bounds() functions so that set_bounds() sets the user bounding volume, while get_bounds() returns the external bounding volume. Although it might seem strange and confusing to do this, this is actually the natural way the user thinks about nodes and bounding volumes.
Description: Deprecated. Use set_bounds() instead.

setBounds
void PandaNode::set_bounds(BoundingVolume const *volume);

A node has three bounding volumes: an "external" bounding volume that represents the node and all of its children, an "internal" bounding volume which represents only the node itself (and is usually empty, unless a specific node type sets it otherwise), and a "user" bounding volume which is specified by the user. We define set_bounds() and get_bounds() functions so that set_bounds() sets the user bounding volume, while get_bounds() returns the external bounding volume. Although it might seem strange and confusing to do this, this is actually the natural way the user thinks about nodes and bounding volumes.
Description: Resets the bounding volume so that it is the indicated volume. When it is explicitly set, the bounding volume will no longer be automatically computed according to the contents of the node itself, for nodes like GeomNodes and TextNodes that contain substance (but the bounding volume will still be automatically expanded to include its children).
Call clear_bounds() if you would like to return the bounding volume to its default behavior later.

setEffect
void PandaNode::set_effect(RenderEffect const *effect);

Description: Adds the indicated render effect to the scene graph on this node. If there was already an effect of the same type, it is replaced.

setEffects
void PandaNode::set_effects(RenderEffects const *effects, Thread *current_thread = ((get_current_thread())));

Description: Sets the complete RenderEffects that will be applied this node. This completely replaces whatever has been set on this node via repeated calls to set_attrib().

setFinal
void PandaNode::set_final(bool flag);

Description: Sets the "final" flag on this PandaNode. If this is true, than no bounding volume need be tested below it; a positive intersection with this node's bounding volume is deemed to be a positive intersection with all geometry inside.
This is useful to quickly force a larger bounding volume around a node when the GeomNodes themselves are inaccurate for some reason, without forcing a recompute of every nested bounding volume. It's also helpful when the bounding volume is tricked by some special properties, like billboards, that may move geometry out of its bounding volume otherwise.

setIntoCollideMask
void PandaNode::set_into_collide_mask(BitMask< unsigned int, 32 > mask);

Description: Sets the "into" CollideMask.
This specifies the set of bits that must be shared with a CollisionNode's "from" CollideMask in order for the CollisionNode to detect a collision with this particular node.
The actual CollideMask that will be set is masked by the return value from get_legal_collide_mask(). Thus, the into_collide_mask cannot be set to anything other than nonzero except for those types of nodes that can be collided into, such as CollisionNodes and GeomNodes.

setOverallHidden
void PandaNode::set_overall_hidden(bool overall_hidden);

Description: Sets or clears the hidden flag. When the hidden flag is true, the node and all of its children are invisible to all cameras, regardless of the setting of any draw masks. Setting the hidden flag to false restores the previous visibility as established by the draw masks.
This actually works by twiddling the reserved _overall_bit in the node's draw mask, which has special meaning.

setPrevTransform
void PandaNode::set_prev_transform(TransformState const *transform, Thread *current_thread = ((get_current_thread())));

Description: Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations.

setPythonTag
void PandaNode::set_python_tag(string const &key, PyObject *value);

Description: Associates an arbitrary Python object with a user-defined key which is stored on the node. This is similar to set_tag(), except it can store any Python object instead of just a string. However, the Python object is not recorded to a bam file.
Each unique key stores a different string value. There is no effective limit on the number of different keys that may be stored or on the length of any one key's value.

setState
void PandaNode::set_state(RenderState const *state, Thread *current_thread = ((get_current_thread())));

Description: Sets the complete RenderState that will be applied to all nodes at this level and below. (The actual state that will be applied to lower nodes is based on the composition of RenderStates from above this node as well). This completely replaces whatever has been set on this node via repeated calls to set_attrib().

setTag
void PandaNode::set_tag(string const &key, string const &value, Thread *current_thread = ((get_current_thread())));

Description: Associates a user-defined value with a user-defined key which is stored on the node. This value has no meaning to Panda; but it is stored indefinitely on the node until it is requested again.
Each unique key stores a different string value. There is no effective limit on the number of different keys that may be stored or on the length of any one key's value.

setTransform
void PandaNode::set_transform(TransformState const *transform, Thread *current_thread = ((get_current_thread())));

Description: Sets the transform that will be applied to this node and below. This defines a new coordinate space at this point in the scene graph and below.

setUnexpectedChange
void PandaNode::set_unexpected_change(unsigned int flags);

Description: Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. Once one of these bits has been set, if the property changes, an assertion failure will be raised, which is designed to assist the developer in identifying the troublesome code that modified the property unexpectedly.
The input parameter is the union of bits that are to be set. To clear these bits later, use clear_unexpected_change().
Since this is a developer debugging tool only, this function does nothing in a production (NDEBUG) build.

stashChild
bool PandaNode::stash_child(PandaNode *child_node, Thread *current_thread = ((get_current_thread())));

Description: Stashes the indicated child node. This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child().
This function returns true if the child node was successfully stashed, or false if it was not a child of the node in the first place (e.g. it was previously stashed).
This can only be called from the top pipeline stage (i.e. from App).

stealChildren
void PandaNode::steal_children(PandaNode *other, Thread *current_thread = ((get_current_thread())));

Description: Moves all the children from the other node onto this node.

unstashChild
bool PandaNode::unstash_child(PandaNode *child_node, Thread *current_thread = ((get_current_thread())));

Description: Returns the indicated stashed node to normal child status. This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable.
This function returns true if the child node was successfully stashed, or false if it was not a child of the node in the first place (e.g. it was previously stashed).
This can only be called from the top pipeline stage (i.e. from App).

write
virtual void PandaNode::write(ostream &out, int indent_level) const;

Description:

getClassType
static TypeHandle TypedWritable::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

Description: Returns true if the current object is or derives from the indicated type.

Namable
Namable::Namable(string const &initial_name = (""));

Description:

clearName
void Namable::clear_name(void);

Description: Resets the Namable's name to empty.

getClassType
static TypeHandle Namable::get_class_type(void);

Undocumented function.

getName
string const &Namable::get_name(void) const;

Description:

hasName
bool Namable::has_name(void) const;

Description: Returns true if the Namable has a nonempty name set, false if the name is empty.

operator =
Namable &Namable::operator =(Namable const &other);

Description:

output
void Namable::output(ostream &out) const;

In the absence of any definition to the contrary, outputting a Namable will write out its name.
Description: Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

setName
void Namable::set_name(string const &name);

Description:

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
void ReferenceCount::ref(void) const;

Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero
bool ReferenceCount::test_ref_count_nonzero(void) const;

Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref
bool ReferenceCount::unref(void) const;

Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.

TextEncoder
TextEncoder::TextEncoder(void);

Description:

appendText
void TextEncoder::append_text(string const &text);

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

appendUnicodeChar
void TextEncoder::append_unicode_char(int character);

Description: Appends a single character to the end of the stored text. This may be a wide character, up to 16 bits in Unicode.

appendWtext
void TextEncoder::append_wtext(basic_string< wchar_t > const &text);

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

clearText
void TextEncoder::clear_text(void);

Description: Removes the text from the TextEncoder.

decodeText
basic_string< wchar_t > TextEncoder::decode_text(string const &text) const;

Description: Returns the given wstring decoded to a single-byte string, via the current encoding system.
Description: Returns the given wstring decoded to a single-byte string, via the given encoding system.

encodeWchar
static string TextEncoder::encode_wchar(wchar_t ch, TextEncoder::Encoding encoding);

Description: Encodes a single wide char into a one-, two-, or three-byte string, according to the given encoding system.

encodeWtext
string TextEncoder::encode_wtext(basic_string< wchar_t > const &wtext) const;

Description: Encodes a wide-text string into a single-char string, according to the current encoding.
Description: Encodes a wide-text string into a single-char string, according to the given encoding.

getClassType
static TypeHandle TextEncoder::get_class_type(void);

Undocumented function.

getDefaultEncoding
static TextEncoder::Encoding TextEncoder::get_default_encoding(void);

Description: Specifies the default encoding to be used for all subsequently created TextEncoder objects. See set_encoding().

getEncodedChar
string TextEncoder::get_encoded_char(int index) const;

Description: Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string.

getEncoding
TextEncoder::Encoding TextEncoder::get_encoding(void) const;

Description: Returns the encoding by which the string set via set_text() is to be interpreted. See set_encoding().

getNumChars
int TextEncoder::get_num_chars(void) const;

Description: Returns the number of characters in the stored text. This is a count of wide characters, after the string has been decoded according to set_encoding().

getText
string TextEncoder::get_text(void) const;

Description: Returns the current text, as encoded via the current encoding system.
Description: Returns the current text, as encoded via the indicated encoding system.

getTextAsAscii
string TextEncoder::get_text_as_ascii(void) const;

Description: Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. This means replacing accented letters with their unaccented ASCII equivalents.
It is possible that some characters in the string cannot be converted to ASCII. (The string may involve symbols like the copyright symbol, for instance, or it might involve letters in some other alphabet such as Greek or Cyrillic, or even Latin letters like thorn or eth that are not part of the ASCII character set.) In this case, as much of the string as possible will be converted to ASCII, and the nonconvertible characters will remain encoded in the encoding specified by set_encoding().

getUnicodeChar
int TextEncoder::get_unicode_char(int index) const;

Description: Returns the Unicode value of the nth character in the stored text. This may be a wide character (greater than 255), after the string has been decoded according to set_encoding().

getWtext
basic_string< wchar_t > const &TextEncoder::get_wtext(void) const;

Direct support for wide-character strings. Now publishable with the new wstring support in interrogate.
Description: Returns the text associated with the TextEncoder, as a wide-character string.

getWtextAsAscii
basic_string< wchar_t > TextEncoder::get_wtext_as_ascii(void) const;

Description: Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. This means replacing accented letters with their unaccented ASCII equivalents.
It is possible that some characters in the string cannot be converted to ASCII. (The string may involve symbols like the copyright symbol, for instance, or it might involve letters in some other alphabet such as Greek or Cyrillic, or even Latin letters like thorn or eth that are not part of the ASCII character set.) In this case, as much of the string as possible will be converted to ASCII, and the nonconvertible characters will remain in their original form.

hasText
bool TextEncoder::has_text(void) const;

Description:

isWtext
bool TextEncoder::is_wtext(void) const;

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

lower
static string TextEncoder::lower(string const &source);

Description: Converts the string to lowercase, assuming the string is encoded in the default encoding.
Description: Converts the string to lowercase, assuming the string is encoded in the indicated encoding.

makeLower
void TextEncoder::make_lower(void);

Description: Adjusts the text stored within the encoder to all lowercase letters (preserving accent marks correctly).

makeUpper
void TextEncoder::make_upper(void);

Description: Adjusts the text stored within the encoder to all uppercase letters (preserving accent marks correctly).

reencodeText
static string TextEncoder::reencode_text(string const &text, TextEncoder::Encoding from, TextEncoder::Encoding to);

Description: 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. This does not change or affect any properties on the TextEncoder itself.

setDefaultEncoding
static void TextEncoder::set_default_encoding(TextEncoder::Encoding encoding);

Description: Specifies the default encoding to be used for all subsequently created TextEncoder objects. See set_encoding().

setEncoding
void TextEncoder::set_encoding(TextEncoder::Encoding encoding);

Description: Specifies how the string set via set_text() is to be interpreted. The default, E_iso8859, means a standard string with one-byte characters (i.e. ASCII). Other encodings are possible to take advantage of character sets with more than 256 characters.
This affects only future calls to set_text(); it does not change text that was set previously.

setText
void TextEncoder::set_text(string const &text);

Description: Changes the text that is stored in the encoder. The text should be encoded according to the method indicated by set_encoding(). Subsequent calls to get_text() will return this same string, while get_wtext() will return the decoded version of the string.
Description: 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().

setUnicodeChar
void TextEncoder::set_unicode_char(int index, int character);

Description: Sets the Unicode value of the nth character in the stored text. This may be a wide character (greater than 255), after the string has been decoded according to set_encoding().

setWtext
void TextEncoder::set_wtext(basic_string< wchar_t > const &wtext);

Direct support for wide-character strings. Now publishable with the new wstring support in interrogate.
Description: Changes the text that is stored in the encoder. Subsequent calls to get_wtext() will return this same string, while get_text() will return the encoded version of the string.

unicodeIsalpha
static bool TextEncoder::unicode_isalpha(int character);

Description: Returns true if the indicated character is an alphabetic letter, false otherwise. This is akin to ctype's isalpha(), extended to Unicode.

unicodeIsdigit
static bool TextEncoder::unicode_isdigit(int character);

Description: Returns true if the indicated character is a numeric digit, false otherwise. This is akin to ctype's isdigit(), extended to Unicode.

unicodeIslower
static bool TextEncoder::unicode_islower(int character);

Description: Returns true if the indicated character is a lowercase letter, false otherwise. This is akin to ctype's islower(), extended to Unicode.

unicodeIspunct
static bool TextEncoder::unicode_ispunct(int character);

Description: Returns true if the indicated character is a punctuation mark, false otherwise. This is akin to ctype's ispunct(), extended to Unicode.

unicodeIsspace
static bool TextEncoder::unicode_isspace(int character);

Description: Returns true if the indicated character is a whitespace letter, false otherwise. This is akin to ctype's isspace(), extended to Unicode.

unicodeIsupper
static bool TextEncoder::unicode_isupper(int character);

Description: Returns true if the indicated character is an uppercase letter, false otherwise. This is akin to ctype's isupper(), extended to Unicode.

unicodeTolower
static int TextEncoder::unicode_tolower(int character);

Description: Returns the uppercase equivalent of the given Unicode character. This is akin to ctype's tolower(), extended to Unicode.

unicodeToupper
static int TextEncoder::unicode_toupper(int character);

Description: Returns the uppercase equivalent of the given Unicode character. This is akin to ctype's toupper(), extended to Unicode.

upper
static string TextEncoder::upper(string const &source);

Description: Converts the string to uppercase, assuming the string is encoded in the default encoding.
Description: Converts the string to uppercase, assuming the string is encoded in the indicated encoding.

TextProperties
TextProperties::TextProperties(void);

Description:

addProperties
void TextProperties::add_properties(TextProperties const &other);

Description: Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

clear
void TextProperties::clear(void);

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

clearAlign
void TextProperties::clear_align(void);

Description: Restores the default alignment of the text.

clearBin
void TextProperties::clear_bin(void);

Description: 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.

clearDrawOrder
void TextProperties::clear_draw_order(void);

Description:

clearFont
void TextProperties::clear_font(void);

Description: Restores the default font to the text.

clearGlyphScale
void TextProperties::clear_glyph_scale(void);

Description:

clearGlyphShift
void TextProperties::clear_glyph_shift(void);

Description:

clearIndent
void TextProperties::clear_indent(void);

Description: Removes the indent setting from the text. Text will be as wide as it is.

clearPreserveTrailingWhitespace
void TextProperties::clear_preserve_trailing_whitespace(void);

Description:

clearShadow
void TextProperties::clear_shadow(void);

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

clearShadowColor
void TextProperties::clear_shadow_color(void);

Description: Removes the shadow color specification.

clearSlant
void TextProperties::clear_slant(void);

Description:

clearSmallCaps
void TextProperties::clear_small_caps(void);

Description:

clearSmallCapsScale
void TextProperties::clear_small_caps_scale(void);

Description:

clearTabWidth
void TextProperties::clear_tab_width(void);

Description:

clearTextColor
void TextProperties::clear_text_color(void);

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

clearUnderscore
void TextProperties::clear_underscore(void);

Description:

clearUnderscoreHeight
void TextProperties::clear_underscore_height(void);

Description:

clearWordwrap
void TextProperties::clear_wordwrap(void);

Description: Removes the wordwrap setting from the text. Text will be as wide as it is.

getAlign
TextProperties::Alignment TextProperties::get_align(void) const;

Description:

getBin
string const &TextProperties::get_bin(void) const;

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

getClassType
static TypeHandle TextProperties::get_class_type(void);

Undocumented function.

getDefaultFont
static TextFont *TextProperties::get_default_font(void);

Description: Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. See set_font().

getDrawOrder
int TextProperties::get_draw_order(void) const;

Description: Returns the drawing order set with set_draw_order().

getFont
TextFont *TextProperties::get_font(void) const;

Description: Returns the font currently in use, if any. If no font is in use, this returns the default font.

getGlyphScale
float TextProperties::get_glyph_scale(void) const;

Description: Returns the scale factor of each letter as specified by set_glyph_scale().

getGlyphShift
float TextProperties::get_glyph_shift(void) const;

Description: Returns the vertical shift of each letter as specified by set_glyph_shift().

getIndent
float TextProperties::get_indent(void) const;

Description:

getPreserveTrailingWhitespace
bool TextProperties::get_preserve_trailing_whitespace(void) const;

Description: Returns the preserve_trailing_whitespace flag. See set_preserve_trailing_whitespace().

getShadow
LVector2f TextProperties::get_shadow(void) const;

Description: Returns the offset of the shadow as set by set_shadow(). It is an error to call this if has_shadow() is false.

getShadowColor
LVecBase4f TextProperties::get_shadow_color(void) const;

Description:

getSlant
float TextProperties::get_slant(void) const;

Description: Returns the factor by which the text is specified to slant to the right.

getSmallCaps
bool TextProperties::get_small_caps(void) const;

Description: Returns the small_caps flag. See set_small_caps().

getSmallCapsScale
float TextProperties::get_small_caps_scale(void) const;

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

getTabWidth
float TextProperties::get_tab_width(void) const;

Description: Returns the width set via set_tab_width().

getTextColor
LVecBase4f TextProperties::get_text_color(void) const;

Description:

getUnderscore
bool TextProperties::get_underscore(void) const;

Description: Returns the underscore flag. See set_underscore().

getUnderscoreHeight
float TextProperties::get_underscore_height(void) const;

Description: Returns the vertical height of the underscore; see set_underscore_height().

getWordwrap
float TextProperties::get_wordwrap(void) const;

Description:

hasAlign
bool TextProperties::has_align(void) const;

Description:

hasBin
bool TextProperties::has_bin(void) const;

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

hasDrawOrder
bool TextProperties::has_draw_order(void) const;

Description:

hasFont
bool TextProperties::has_font(void) const;

Description:

hasGlyphScale
bool TextProperties::has_glyph_scale(void) const;

Description:

hasGlyphShift
bool TextProperties::has_glyph_shift(void) const;

Description:

hasIndent
bool TextProperties::has_indent(void) const;

Description:

hasPreserveTrailingWhitespace
bool TextProperties::has_preserve_trailing_whitespace(void) const;

Description:

hasShadow
bool TextProperties::has_shadow(void) const;

Description:

hasShadowColor
bool TextProperties::has_shadow_color(void) const;

Description:

hasSlant
bool TextProperties::has_slant(void) const;

Description:

hasSmallCaps
bool TextProperties::has_small_caps(void) const;

Description:

hasSmallCapsScale
bool TextProperties::has_small_caps_scale(void) const;

Description:

hasTabWidth
bool TextProperties::has_tab_width(void) const;

Description:

hasTextColor
bool TextProperties::has_text_color(void) const;

Description:

hasUnderscore
bool TextProperties::has_underscore(void) const;

Description:

hasUnderscoreHeight
bool TextProperties::has_underscore_height(void) const;

Description:

hasWordwrap
bool TextProperties::has_wordwrap(void) const;

Description:

isAnySpecified
bool TextProperties::is_any_specified(void) const;

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

operator !=
bool TextProperties::operator !=(TextProperties const &other) const;

Description:

operator =
void TextProperties::operator =(TextProperties const &copy);

Description:

operator ==
bool TextProperties::operator ==(TextProperties const &other) const;

Description:

setAlign
void TextProperties::set_align(TextProperties::Alignment align_type);

Description: Specifies the alignment of the text within its margins.

setBin
void TextProperties::set_bin(string const &bin);

Description: 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".

setDefaultFont
static void TextProperties::set_default_font(TextFont *);

Description: Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. See set_font().

setDrawOrder
int TextProperties::set_draw_order(int draw_order);

Description: 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.

setFont
void TextProperties::set_font(TextFont *font);

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

setGlyphScale
void TextProperties::set_glyph_scale(float glyph_scale);

Description: 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.

setGlyphShift
void TextProperties::set_glyph_shift(float glyph_shift);

Description: 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.

setIndent
void TextProperties::set_indent(float indent);

Description: 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.

setPreserveTrailingWhitespace
void TextProperties::set_preserve_trailing_whitespace(bool preserve_trailing_whitespace);

Description: 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.

setShadow
void TextProperties::set_shadow(float xoffset, float yoffset);

Description: 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.

setShadowColor
void TextProperties::set_shadow_color(float r, float g, float b, float a);

Description:

setSlant
void TextProperties::set_slant(float slant);

Description: Specifies the factor by which the text slants to the right.

setSmallCaps
void TextProperties::set_small_caps(bool small_caps);

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

setSmallCapsScale
void TextProperties::set_small_caps_scale(float small_caps_scale);

Description: 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.

setTabWidth
void TextProperties::set_tab_width(float tab_width);

Description: 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.

setTextColor
void TextProperties::set_text_color(float r, float g, float b, float a);

Description:

setUnderscore
void TextProperties::set_underscore(bool underscore);

Description: 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.

setUnderscoreHeight
void TextProperties::set_underscore_height(float underscore_height);

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

setWordwrap
void TextProperties::set_wordwrap(float wordwrap);

Description: 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.

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

Description: