Panda3D
Public Member Functions | Static Public Member Functions | List of all members
SceneGraphAnalyzerMeter Class Reference

This is a special TextNode that automatically updates itself with output from a SceneGraphAnalyzer instance. It can be placed anywhere in the world where you'd like to see the output from SceneGraphAnalyzer. More...

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

Public Member Functions

 __init__ (str name, PandaNode node)
 
 clearWindow ()
 Undoes the effect of a previous call to setup_window(). More...
 
DisplayRegion getDisplayRegion ()
 Returns the DisplayRegion that the meter has created to render itself into the window to setup_window(), or NULL if setup_window() has not been called. More...
 
PandaNode getNode ()
 Returns the node to be analyzed. More...
 
double getUpdateInterval ()
 Returns the number of seconds that will elapse between updates to the frame rate indication. More...
 
GraphicsOutput getWindow ()
 Returns the GraphicsOutput that was passed to setup_window(), or NULL if setup_window() has not been called. More...
 
 setNode (PandaNode node)
 Sets the node to be analyzed. More...
 
 setUpdateInterval (double update_interval)
 Specifies the number of seconds that should elapse between updates to the meter. This should be reasonably slow (e.g. 0.5 to 2.0) so that the calculation of the scene graph analysis does not itself dominate the frame rate. More...
 
 setupWindow (GraphicsOutput window)
 Sets up the frame rate meter to create a DisplayRegion to render itself into the indicated window. More...
 
 update ()
 You can call this to explicitly force the SceneGraphAnalyzerMeter to update itself with the latest scene graph analysis information. Normally, it is not necessary to call this explicitly. More...
 
- Public Member Functions inherited from TextNode
 __init__ (str name)
 
 __init__ (str name, const TextProperties copy)
 It's sort of a copy constructor: it copies the indicated TextProperties, without copying a complete TextNode. More...
 
 appendText (str text)
 Appends the indicates string to the end of the stored text. More...
 
 appendUnicodeChar (wchar_t character)
 Appends a single character to the end of the stored text. This may be a wide character, up to 16 bits in Unicode. More...
 
 appendWtext (str text)
 Appends the indicates string to the end of the stored wide-character text. More...
 
float calcWidth (str line)
 Returns the width of a line of text of arbitrary characters. The line should not include the newline character. More...
 
float calcWidth (wchar_t character)
 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). More...
 
float calcWidth (str line)
 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. More...
 
 clearAlign ()
 
 clearBin ()
 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. More...
 
 clearCard ()
 Specifies that a card will not be drawn behind the text. More...
 
 clearCardBorder ()
 
 clearCardTexture ()
 
 clearDrawOrder ()
 
 clearFont ()
 Resets the font to the default font. More...
 
 clearFrame ()
 Specifies that a border will not be drawn around the text. More...
 
 clearGlyphScale ()
 
 clearGlyphShift ()
 
 clearIndent ()
 
 clearMaxRows ()
 Resets the TextNode's default behavior of not limiting the number of rows of text. More...
 
 clearShadow ()
 Specifies that a shadow will not be drawn behind the text. More...
 
 clearShadowColor ()
 
 clearSlant ()
 
 clearSmallCaps ()
 
 clearSmallCapsScale ()
 
 clearTabWidth ()
 
 clearText ()
 Removes the text from the TextNode. More...
 
 clearTextColor ()
 Removes the text color specification; the text will be colored whatever it was in the source font file. More...
 
 clearWordwrap ()
 Removes the wordwrap setting from the TextNode. Text will be as wide as it is. More...
 
 forceUpdate ()
 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). More...
 
PandaNode generate ()
 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. More...
 
float getBottom ()
 Returns the bottommost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
LVecBase4 getCardActual ()
 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. More...
 
LVecBase4 getCardAsSet ()
 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. More...
 
float getCardBorderSize ()
 
float getCardBorderUvPortion ()
 
LColor getCardColor ()
 
bool getCardDecal ()
 Returns the card_decal flag. See set_card_decal(). More...
 
Texture getCardTexture ()
 
LVecBase4 getCardTransformed ()
 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(). More...
 
CoordinateSystem getCoordinateSystem ()
 
int getFlattenFlags ()
 Returns the flatten flags. See set_flatten_flags(). More...
 
LVecBase4 getFrameActual ()
 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. More...
 
LVecBase4 getFrameAsSet ()
 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. More...
 
LColor getFrameColor ()
 
bool getFrameCorners ()
 
float getFrameLineWidth ()
 Returns the thickness of the lines that will be used to draw the frame. More...
 
float getHeight ()
 Returns the net height of the text in local 2-d coordinates. More...
 
PandaNode getInternalGeom ()
 Returns the actual node that is used internally to render the text, if the TextNode is parented within the scene graph. More...
 
float getLeft ()
 Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
float getLineHeight ()
 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. More...
 
LPoint3 getLowerRight3d ()
 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 getMaxRows ()
 Returns the limit on the height of the TextNode specified by set_max_rows(). More...
 
int getNumRows ()
 Returns the number of rows of text that were generated. This counts word-wrapped rows as well as rows generated due to embedded newlines. More...
 
float getRight ()
 Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
float getTop ()
 Returns the topmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
LMatrix4 getTransform ()
 
LPoint3 getUpperLeft3d ()
 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...
 
GeomEnums::UsageHint getUsageHint ()
 Returns the UsageHint that will be applied to generated geometry. See set_usage_hint(). More...
 
float getWidth ()
 Returns the net width of the text in local 2-d coordinates. More...
 
str getWordwrappedText ()
 Returns a string that represents the contents of the text, as it has been formatted by wordwrap rules. More...
 
str getWordwrappedWtext ()
 Returns a wstring that represents the contents of the text, as it has been formatted by wordwrap rules. More...
 
bool hasCard ()
 
bool hasCardBorder ()
 
bool hasCardTexture ()
 
bool hasCharacter (wchar_t character)
 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.) More...
 
bool hasExactCharacter (wchar_t character)
 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. More...
 
bool hasFrame ()
 
bool hasMaxRows ()
 Returns true if a limit on the height of the TextNode has been set via set_max_rows(), false otherwise. More...
 
bool hasOverflow ()
 Returns true if the last text set on the text node exceeded the max_rows constraint, or false if it all fit. More...
 
bool isCardAsMargin ()
 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. More...
 
bool isFrameAsMargin ()
 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. More...
 
bool isWhitespace (wchar_t character)
 Returns true if the indicated character represents whitespace in the font, or false if anything visible will be rendered for it. More...
 
 output (Ostream out)
 
 setAlign (TextProperties::Alignment align_type)
 
 setBin (str bin)
 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. More...
 
 setCardActual (float left, float right, float bottom, float 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. The left and bottom coordinates should generally be negative, while the right and top coordinates should generally be positive. More...
 
 setCardAsMargin (float left, float right, float bottom, float top)
 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. More...
 
 setCardBorder (float size, float uv_portion)
 
 setCardColor (const LColor card_color)
 
 setCardColor (float r, float g, float b, float a)
 
 setCardDecal (bool card_decal)
 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. More...
 
 setCardTexture (Texture card_texture)
 
 setCoordinateSystem (CoordinateSystem cs)
 Specifies the coordinate system in which the text will be generated. More...
 
int setDrawOrder (int draw_order)
 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. More...
 
 setFlattenFlags (int flatten_flags)
 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. More...
 
 setFont (TextFont font)
 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(). More...
 
 setFrameActual (float left, float right, float bottom, float 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. The left and bottom coordinates should generally be negative, while the right and top coordinates should generally be positive. More...
 
 setFrameAsMargin (float left, float right, float bottom, float top)
 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. More...
 
 setFrameColor (const LColor frame_color)
 
 setFrameColor (float r, float g, float b, float a)
 
 setFrameCorners (bool corners)
 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. More...
 
 setFrameLineWidth (float line_width)
 Specifies the thickness of the lines that will be used to draw the frame. More...
 
 setGlyphScale (float glyph_scale)
 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. More...
 
 setGlyphShift (float glyph_shift)
 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. More...
 
 setIndent (float indent)
 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. More...
 
 setMaxRows (int max_rows)
 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. More...
 
 setShadow (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...
 
 setShadow (float xoffset, float 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...
 
 setShadowColor (const LColor shadow_color)
 
 setShadowColor (float r, float g, float b, float a)
 
 setSlant (float slant)
 
 setSmallCaps (bool small_caps)
 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. More...
 
 setSmallCapsScale (float small_caps_scale)
 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. More...
 
 setTabWidth (float tab_width)
 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. More...
 
 setText (str text)
 Changes the text that is displayed under the TextNode. More...
 
 setText (str text, TextEncoder::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. Subsequent calls to get_text() will return the same text re-encoded using whichever encoding is specified by set_encoding(). More...
 
 setTextColor (const LColor text_color)
 
 setTextColor (float r, float g, float b, float a)
 
 setTransform (const LMatrix4 transform)
 Sets an additional transform that is applied to the entire text paragraph. More...
 
 setUsageHint (GeomEnums::UsageHint usage_hint)
 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. More...
 
 setWordwrap (float wordwrap)
 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. More...
 
 setWtext (str wtext)
 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. More...
 
 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. This call is optional. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from PandaNode
PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 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. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 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. More...
 
 adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
Light asLight ()
 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...
 
 clearAttrib (TypeHandle type)
 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. More...
 
 clearAttrib (int slot)
 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. More...
 
 clearBounds ()
 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...
 
 clearEffect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
 clearEffects (Thread current_thread)
 Resets this node to have no render effects. More...
 
 clearPythonTag (str key)
 
 clearState (Thread current_thread)
 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. More...
 
 clearTag (str key, Thread current_thread)
 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. More...
 
 clearTransform (Thread current_thread)
 Resets the transform on this node to the identity transform. More...
 
 clearUnexpectedChange (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. See set_unexpected_change(). More...
 
PandaNode combineWith (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 compareTags (const PandaNode other)
 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. More...
 
 copyAllProperties (PandaNode other)
 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()). More...
 
 copyChildren (PandaNode other, Thread current_thread)
 Makes another instance of all the children of the other node, copying them to this node. More...
 
PandaNode copySubgraph (Thread current_thread)
 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. More...
 
 copyTags (PandaNode other)
 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. More...
 
int countNumDescendants ()
 Returns the number of nodes at and below this level. More...
 
int findChild (PandaNode node, Thread current_thread)
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int findParent (PandaNode node, Thread current_thread)
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int findStashed (PandaNode node, Thread current_thread)
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
const RenderAttrib getAttrib (TypeHandle type)
 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. More...
 
const RenderAttrib getAttrib (int slot)
 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. More...
 
const BoundingVolume getBounds (Thread current_thread)
 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. More...
 
const BoundingVolume getBounds (UpdateSeq seq, Thread current_thread)
 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. More...
 
BoundingVolume::BoundsType getBoundsType ()
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode getChild (int n, Thread current_thread)
 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. More...
 
list getChildren ()
 
int getChildSort (int n, Thread current_thread)
 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(). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. See adjust_draw_mask(). More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. See adjust_draw_mask(). More...
 
const RenderEffect getEffect (TypeHandle type)
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderEffects getEffects (Thread current_thread)
 Returns the complete RenderEffects that will be applied to this node. More...
 
int getFancyBits (Thread current_thread)
 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. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 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. More...
 
int getInternalVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask getIntoCollideMask ()
 Returns the "into" collide mask for this node. More...
 
CollideMask getLegalCollideMask ()
 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. More...
 
int getNestedVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask getNetCollideMask (Thread current_thread)
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask getNetDrawControlMask ()
 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 getNetDrawShowMask ()
 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. More...
 
int getNumChildren (Thread current_thread)
 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. More...
 
int getNumParents (Thread current_thread)
 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. More...
 
int getNumStashed (Thread current_thread)
 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(). More...
 
const RenderAttrib getOffClipPlanes (Thread current_thread)
 Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More...
 
PandaNode getParent (int n, Thread current_thread)
 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. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. See set_prev_transform(). More...
 
object getPythonTag (str key)
 
object getPythonTagKeys ()
 
 getPythonTagKeys (VectorString keys)
 
PandaNode getStashed (int n, Thread current_thread)
 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. More...
 
list getStashed ()
 
int getStashedSort (int n, Thread current_thread)
 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(). More...
 
const RenderState getState (Thread current_thread)
 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. More...
 
str getTag (str key, Thread current_thread)
 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. More...
 
object getTagKeys ()
 
 getTagKeys (VectorString keys)
 Fills the given vector up with the list of tags on this PandaNode. More...
 
const TransformState getTransform (Thread current_thread)
 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. More...
 
unsigned int getUnexpectedChange (unsigned int flags)
 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(). More...
 
bool hasAttrib (TypeHandle type)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasAttrib (int slot)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasDirtyPrevTransform ()
 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(). More...
 
bool hasEffect (TypeHandle type)
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
bool hasPythonTag (str key)
 
bool hasTag (str key, Thread current_thread)
 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. More...
 
bool hasTags ()
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
bool isAmbientLight ()
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool isBoundsStale ()
 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. More...
 
bool isCollisionNode ()
 A simple downcast check. Returns true if this kind of node happens to inherit from CollisionNode, false otherwise. More...
 
bool isFinal (Thread current_thread)
 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(). More...
 
bool isGeomNode ()
 A simple downcast check. Returns true if this kind of node happens to inherit from GeomNode, false otherwise. More...
 
bool isLodNode ()
 A simple downcast check. Returns true if this kind of node happens to inherit from LODNode, false otherwise. More...
 
bool isOverallHidden ()
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool isSceneRoot ()
 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 isUnderSceneRoot ()
 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. If this is true, this node may potentially be traversed by the render traverser. Stashed nodes don't count for this purpose, but hidden nodes do. More...
 
 listTags (Ostream out, str separator)
 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. More...
 
 ls (Ostream out, int indent_level)
 Lists all the nodes at and below the current path hierarchically. More...
 
PandaNode makeCopy ()
 Returns a newly-allocated PandaNode that is a shallow copy of this one. It will be a different pointer, but its internal data may or may not be shared with that of the original PandaNode. No children will be copied. More...
 
 markBoundsStale (Thread current_thread)
 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. More...
 
 markInternalBoundsStale (Thread current_thread)
 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. More...
 
 output (Ostream out)
 
 prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. It is not strictly necessary to call this, since the GSG will initialize itself when the scene is rendered, but this may take some of the overhead away from that process. More...
 
 removeAllChildren (Thread current_thread)
 Removes all the children from the node at once, including stashed children. More...
 
bool removeChild (PandaNode child_node, Thread current_thread)
 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. More...
 
 removeChild (int child_index, Thread current_thread)
 Removes the nth child from the node. More...
 
 removeStashed (int child_index, Thread current_thread)
 Removes the nth stashed child from the node. More...
 
bool replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread)
 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. More...
 
 replaceNode (PandaNode other)
 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. More...
 
 resetPrevTransform (Thread current_thread)
 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. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 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. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. Use set_bounds() instead. More...
 
 setBounds (const BoundingVolume volume)
 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). More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. This is normally BoundingVolume::BT_default, which means to set the type according to the config variable "bounds-type". More...
 
 setEffect (const RenderEffect effect)
 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. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 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(). More...
 
 setFinal (bool flag)
 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. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 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. More...
 
 setPrevTransform (const TransformState transform, Thread 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...
 
 setPythonTag (str key, object value)
 
 setState (const RenderState state, Thread current_thread)
 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(). More...
 
 setTag (str key, str value, Thread current_thread)
 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. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 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. More...
 
 setUnexpectedChange (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. 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. More...
 
bool stashChild (PandaNode child_node, Thread current_thread)
 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(). More...
 
 stashChild (int child_index, Thread current_thread)
 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(). More...
 
 stealChildren (PandaNode other, Thread current_thread)
 Moves all the children from the other node onto this node. More...
 
bool unstashChild (PandaNode child_node, Thread current_thread)
 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. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 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. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
str encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 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(). More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 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. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 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.) However, see the helper function unref_delete(). More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable copy)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namable operator= (const Namable other)
 
 output (Ostream out)
 Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More...
 
 setName (str name)
 
- Public Member Functions inherited from TextEncoder
 __init__ ()
 
 __init__ (const TextEncoder copy)
 
 appendText (str text)
 Appends the indicates string to the end of the stored text. More...
 
 appendUnicodeChar (int character)
 Appends a single character to the end of the stored text. This may be a wide character, up to 16 bits in Unicode. More...
 
 appendWtext (str text)
 Appends the indicates string to the end of the stored wide-character text. More...
 
 clearText ()
 Removes the text from the TextEncoder. More...
 
str decodeText (str text)
 Returns the given wstring decoded to a single-byte string, via the current encoding system. More...
 
str encodeWtext (str wtext)
 Encodes a wide-text string into a single-char string, according to the current encoding. More...
 
str getEncodedChar (int index)
 Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. More...
 
str getEncodedChar (int index, TextEncoder::Encoding encoding)
 Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. More...
 
TextEncoder::Encoding getEncoding ()
 Returns the encoding by which the string set via set_text() is to be interpreted. See set_encoding(). More...
 
int getNumChars ()
 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(). More...
 
str getText ()
 Returns the current text, as encoded via the current encoding system. More...
 
str getText (TextEncoder::Encoding encoding)
 Returns the current text, as encoded via the indicated encoding system. More...
 
str getTextAsAscii ()
 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. More...
 
int getUnicodeChar (int index)
 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(). More...
 
str getWtext ()
 Returns the text associated with the TextEncoder, as a wide-character string. More...
 
str getWtextAsAscii ()
 
bool hasText ()
 
bool isWtext ()
 
 makeLower ()
 
 makeUpper ()
 
 setEncoding (TextEncoder::Encoding encoding)
 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. More...
 
 setText (str text)
 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. More...
 
 setText (str text, TextEncoder::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. Subsequent calls to get_text() will return the same text re-encoded using whichever encoding is specified by set_encoding(). More...
 
 setUnicodeChar (int index, int character)
 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(). More...
 
 setWtext (str wtext)
 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. More...
 
- Public Member Functions inherited from TextProperties
 __init__ ()
 
 __init__ (const TextProperties copy)
 
 addProperties (const TextProperties other)
 Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged. More...
 
 clear ()
 Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state. More...
 
 clearAlign ()
 Restores the default alignment of the text. More...
 
 clearBin ()
 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. More...
 
 clearDrawOrder ()
 
 clearFont ()
 Restores the default font to the text. More...
 
 clearGlyphScale ()
 
 clearGlyphShift ()
 
 clearIndent ()
 Removes the indent setting from the text. Text will be as wide as it is. More...
 
 clearPreserveTrailingWhitespace ()
 
 clearShadow ()
 Specifies that a shadow will not be drawn behind the text. More...
 
 clearShadowColor ()
 Removes the shadow color specification. More...
 
 clearSlant ()
 
 clearSmallCaps ()
 
 clearSmallCapsScale ()
 
 clearTabWidth ()
 
 clearTextColor ()
 Removes the text color specification; the text will be colored whatever it was in the source font file. More...
 
 clearTextScale ()
 
 clearUnderscore ()
 
 clearUnderscoreHeight ()
 
 clearWordwrap ()
 Removes the wordwrap setting from the text. Text will be as wide as it is. More...
 
TextProperties::Alignment getAlign ()
 
str getBin ()
 Returns the drawing bin set with set_bin(), or empty string if no bin has been set. More...
 
int getDrawOrder ()
 Returns the drawing order set with set_draw_order(). More...
 
TextFont getFont ()
 Returns the font currently in use, if any. If no font is in use, this returns the default font. More...
 
float getGlyphScale ()
 Returns the scale factor of each letter as specified by set_glyph_scale(). More...
 
float getGlyphShift ()
 Returns the vertical shift of each letter as specified by set_glyph_shift(). More...
 
float getIndent ()
 
bool getPreserveTrailingWhitespace ()
 Returns the preserve_trailing_whitespace flag. See set_preserve_trailing_whitespace(). More...
 
LVector2 getShadow ()
 Returns the offset of the shadow as set by set_shadow(). It is an error to call this if has_shadow() is false. More...
 
LColor getShadowColor ()
 
float getSlant ()
 Returns the factor by which the text is specified to slant to the right. More...
 
bool getSmallCaps ()
 Returns the small_caps flag. See set_small_caps(). More...
 
float getSmallCapsScale ()
 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(). More...
 
float getTabWidth ()
 Returns the width set via set_tab_width(). More...
 
LColor getTextColor ()
 
float getTextScale ()
 Returns the scale factor of the text as specified by set_text_scale(). More...
 
bool getUnderscore ()
 Returns the underscore flag. See set_underscore(). More...
 
float getUnderscoreHeight ()
 Returns the vertical height of the underscore; see set_underscore_height(). More...
 
float getWordwrap ()
 
bool hasAlign ()
 
bool hasBin ()
 Returns true if an explicit drawing bin has been set via set_bin(), false otherwise. More...
 
bool hasDrawOrder ()
 
bool hasFont ()
 
bool hasGlyphScale ()
 
bool hasGlyphShift ()
 
bool hasIndent ()
 
bool hasPreserveTrailingWhitespace ()
 
bool hasShadow ()
 
bool hasShadowColor ()
 
bool hasSlant ()
 
bool hasSmallCaps ()
 
bool hasSmallCapsScale ()
 
bool hasTabWidth ()
 
bool hasTextColor ()
 
bool hasTextScale ()
 
bool hasUnderscore ()
 
bool hasUnderscoreHeight ()
 
bool hasWordwrap ()
 
bool isAnySpecified ()
 Returns true if any properties have been specified, false otherwise. More...
 
bool operator!= (const TextProperties other)
 
TextProperties operator= (const TextProperties copy)
 
bool operator== (const TextProperties other)
 
 setAlign (TextProperties::Alignment align_type)
 Specifies the alignment of the text within its margins. More...
 
 setBin (str bin)
 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. More...
 
int setDrawOrder (int draw_order)
 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. More...
 
 setFont (TextFont font)
 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(). More...
 
 setGlyphScale (float 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(). This can be used (possibly in conjunction with set_glyph_shift()) to implement superscripting or subscripting. More...
 
 setGlyphShift (float glyph_shift)
 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. More...
 
 setIndent (float indent)
 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. More...
 
 setPreserveTrailingWhitespace (bool preserve_trailing_whitespace)
 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. More...
 
 setShadow (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...
 
 setShadow (float xoffset, float 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...
 
 setShadowColor (const LColor shadow_color)
 
 setShadowColor (float r, float g, float b, float a)
 
 setSlant (float slant)
 Specifies the factor by which the text slants to the right. More...
 
 setSmallCaps (bool small_caps)
 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. More...
 
 setSmallCapsScale (float small_caps_scale)
 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. More...
 
 setTabWidth (float tab_width)
 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. More...
 
 setTextColor (const LColor text_color)
 
 setTextColor (float r, float g, float b, float a)
 
 setTextScale (float 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...
 
 setUnderscore (bool underscore)
 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. More...
 
 setUnderscoreHeight (float underscore_height)
 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(). More...
 
 setWordwrap (float wordwrap)
 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. More...
 
 write (Ostream out, int indent_level)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TextNode
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from PandaNode
static PandaNode decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
 
static DrawMask getAllCameraMask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle getClassType ()
 
static DrawMask getOverallBit ()
 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. More...
 
static resetAllPrevTransform (Thread 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 Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TextEncoder
static str decodeText (str text, TextEncoder::Encoding encoding)
 
static str encodeWchar (wchar_t ch, TextEncoder::Encoding encoding)
 
static str encodeWtext (str wtext, TextEncoder::Encoding encoding)
 
static TextEncoder::Encoding getDefaultEncoding ()
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. See set_encoding(). More...
 
static str lower (str source)
 Converts the string to lowercase, assuming the string is encoded in the default encoding. More...
 
static str lower (str source, TextEncoder::Encoding encoding)
 Converts the string to lowercase, assuming the string is encoded in the indicated encoding. More...
 
static str reencodeText (str text, TextEncoder::Encoding from, TextEncoder::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. This does not change or affect any properties on the TextEncoder itself. More...
 
static setDefaultEncoding (TextEncoder::Encoding encoding)
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. See set_encoding(). More...
 
static bool unicodeIsalpha (int character)
 Returns true if the indicated character is an alphabetic letter, false otherwise. This is akin to ctype's isalpha(), extended to Unicode. More...
 
static bool unicodeIsdigit (int character)
 Returns true if the indicated character is a numeric digit, false otherwise. This is akin to ctype's isdigit(), extended to Unicode. More...
 
static bool unicodeIslower (int character)
 Returns true if the indicated character is a lowercase letter, false otherwise. This is akin to ctype's islower(), extended to Unicode. More...
 
static bool unicodeIspunct (int character)
 Returns true if the indicated character is a punctuation mark, false otherwise. This is akin to ctype's ispunct(), extended to Unicode. More...
 
static bool unicodeIsspace (int character)
 Returns true if the indicated character is a whitespace letter, false otherwise. This is akin to ctype's isspace(), extended to Unicode. More...
 
static bool unicodeIsupper (int character)
 Returns true if the indicated character is an uppercase letter, false otherwise. This is akin to ctype's isupper(), extended to Unicode. More...
 
static int unicodeTolower (int character)
 Returns the uppercase equivalent of the given Unicode character. This is akin to ctype's tolower(), extended to Unicode. More...
 
static int unicodeToupper (int character)
 Returns the uppercase equivalent of the given Unicode character. This is akin to ctype's toupper(), extended to Unicode. More...
 
static str upper (str source)
 Converts the string to uppercase, assuming the string is encoded in the default encoding. More...
 
static str upper (str source, TextEncoder::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 getClassType ()
 
static TextFont getDefaultFont ()
 Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. See set_font(). More...
 
static setDefaultFont (TextFont)
 Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. See set_font(). More...
 

Additional Inherited Members

- Public Types inherited from TextNode
enum  FlattenFlags {
  FF_none = 0, FF_light = 1, FF_medium = 2, FF_strong = 4,
  FF_dynamic_merge = 8
}
 
- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 1, FB_state = 2, FB_effects = 4, FB_tag = 16,
  FB_draw_mask = 32, FB_cull_callback = 64
}
 
enum  UnexpectedChange {
  UC_parents = 1, UC_children = 2, UC_transform = 4, UC_state = 8,
  UC_draw_mask = 16
}
 
- Public Types inherited from TextEncoder
enum  Encoding { E_iso8859 = 0, E_utf8 = 1, E_unicode = 2 }
 
- Public Types inherited from TextProperties
enum  Alignment {
  A_left = 0, A_right = 1, A_center = 2, A_boxed_left = 3,
  A_boxed_right = 4, A_boxed_center = 5
}
 

Detailed Description

This is a special TextNode that automatically updates itself with output from a SceneGraphAnalyzer instance. It can be placed anywhere in the world where you'd like to see the output from SceneGraphAnalyzer.

It also has a special mode in which it may be attached directly to a channel or window. If this is done, it creates a DisplayRegion for itself and renders itself in the upper-right-hand corner.

Member Function Documentation

◆ __init__()

__init__ ( str  name,
PandaNode  node 
)

◆ clearWindow()

clearWindow ( )

Undoes the effect of a previous call to setup_window().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDisplayRegion()

DisplayRegion getDisplayRegion ( )

Returns the DisplayRegion that the meter has created to render itself into the window to setup_window(), or NULL if setup_window() has not been called.

◆ getNode()

PandaNode getNode ( )

Returns the node to be analyzed.

◆ getUpdateInterval()

double getUpdateInterval ( )

Returns the number of seconds that will elapse between updates to the frame rate indication.

◆ getWindow()

GraphicsOutput getWindow ( )

Returns the GraphicsOutput that was passed to setup_window(), or NULL if setup_window() has not been called.

◆ setNode()

setNode ( PandaNode  node)

Sets the node to be analyzed.

◆ setUpdateInterval()

setUpdateInterval ( double  update_interval)

Specifies the number of seconds that should elapse between updates to the meter. This should be reasonably slow (e.g. 0.5 to 2.0) so that the calculation of the scene graph analysis does not itself dominate the frame rate.

◆ setupWindow()

setupWindow ( GraphicsOutput  window)

Sets up the frame rate meter to create a DisplayRegion to render itself into the indicated window.

◆ update()

update ( )

You can call this to explicitly force the SceneGraphAnalyzerMeter to update itself with the latest scene graph analysis information. Normally, it is not necessary to call this explicitly.