Panda3D
|
This is a special TextNode that automatically updates itself with output from a SceneGraphAnalyzer instance. More...
Public Types | |
enum | Alignment { ALeft = 0, ARight = 1, ACenter = 2, ABoxedLeft = 3, ABoxedRight = 4, ABoxedCenter = 5 } |
enum | Encoding { EIso8859 = 0, EUtf8 = 1, EUnicode = 2 } |
enum | FancyBits { FBTransform = 1, FBState = 2, FBEffects = 4, FBTag = 16, FBDrawMask = 32, FBCullCallback = 64 } |
enum | FlattenFlags { FFNone = 0, FFLight = 1, FFMedium = 2, FFStrong = 4, FFDynamicMerge = 8 } |
enum | UnexpectedChange { UCParents = 1, UCChildren = 2, UCTransform = 4, UCState = 8, UCDrawMask = 16 } |
Public Member Functions | |
SceneGraphAnalyzerMeter (string name, PandaNode node) | |
addChild (PandaNode child_node, int sort, Thread current_thread) | |
Adds a new child to the node. | |
addChild (PandaNode child_node, int sort) | |
Adds a new child to the node. | |
addChild (PandaNode child_node) | |
Adds a new child to the node. | |
addProperties (TextProperties const other) | |
Sets any properties that are explicitly specified in other on this object. | |
addStashed (PandaNode child_node, int sort) | |
Adds a new child to the node, directly as a stashed child. | |
addStashed (PandaNode child_node, int sort, Thread current_thread) | |
Adds a new child to the node, directly as a stashed child. | |
addStashed (PandaNode child_node) | |
Adds a new child to the node, directly as a stashed child. | |
adjustDrawMask (BitMaskunsigned int, 32 show_mask, BitMaskunsigned int, 32 hide_mask, BitMaskunsigned int, 32 clear_mask) | |
Adjusts the hide/show bits of this particular node. | |
appendText (string text) | |
Appends the indicates string to the end of the stored text. | |
appendUnicodeChar (wchar_t character) | |
Appends a single character to the end of the stored text. | |
appendUnicodeChar (int character) | |
Appends a single character to the end of the stored text. | |
appendWtext (string text) | |
Appends the indicates string to the end of the stored wide-character text. | |
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. | |
float | calcWidth (string line) |
Returns the width of a line of text of arbitrary characters. | |
float | calcWidth (wchar_t character) |
Returns the width of a single character of the font, or 0.0 if the character is not known. | |
float | calcWidth (string line) |
Returns the width of a line of text of arbitrary characters. | |
clear () | |
Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state. | |
clearAlign () | |
Restores the default alignment of the text. | |
clearAttrib (TypeHandle type) | |
Removes the render attribute of the given type from this node. | |
clearAttrib (int slot) | |
Removes the render attribute of the given type from this node. | |
clearBin () | |
Removes the effect of a previous call to set_bin(). | |
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. | |
clearCard () | |
Specifies that a card will not be drawn behind the text. | |
clearCardBorder () | |
clearCardTexture () | |
clearDrawOrder () | |
clearEffect (TypeHandle type) | |
Removes the render effect of the given type from this node. | |
clearEffects (Thread current_thread) | |
Resets this node to have no render effects. | |
clearEffects () | |
Resets this node to have no render effects. | |
clearFont () | |
Resets the font to the default font. | |
clearFrame () | |
Specifies that a border will not be drawn around the text. | |
clearGlyphScale () | |
clearGlyphShift () | |
clearIndent () | |
Removes the indent setting from the text. | |
clearMaxRows () | |
Resets the TextNode's default behavior of not limiting the number of rows of text. | |
clearName () | |
Resets the Namable's name to empty. | |
clearPreserveTrailingWhitespace () | |
clearPythonTag (string key) | |
Removes the Python object defined for this key on this particular node. | |
clearShadow () | |
Specifies that a shadow will not be drawn behind the text. | |
clearShadowColor () | |
Removes the shadow color specification. | |
clearSlant () | |
clearSmallCaps () | |
clearSmallCapsScale () | |
clearState (Thread current_thread) | |
Resets this node to leave the render state alone. | |
clearState () | |
Resets this node to leave the render state alone. | |
clearTabWidth () | |
clearTag (string key, Thread current_thread) | |
Removes the value defined for this key on this particular node. | |
clearTag (string key) | |
Removes the value defined for this key on this particular node. | |
clearText () | |
Removes the text from the TextNode. | |
clearTextColor () | |
Removes the text color specification; the text will be colored whatever it was in the source font file. | |
clearTextScale () | |
clearTransform (Thread current_thread) | |
Resets the transform on this node to the identity transform. | |
clearTransform () | |
Resets the transform on this node to the identity transform. | |
clearUnderscore () | |
clearUnderscoreHeight () | |
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. | |
clearWindow () | |
Undoes the effect of a previous call to setup_window(). | |
clearWordwrap () | |
Removes the wordwrap setting from the TextNode. | |
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. | |
int | compareTags (PandaNode const 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. | |
PandaNode | copy () |
A special Python method that is invoked by copy.copy(node). | |
copyAllProperties (PandaNode other) | |
Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. | |
copyChildren (PandaNode other, Thread current_thread) | |
Makes another instance of all the children of the other node, copying them to this node. | |
copyChildren (PandaNode other) | |
Makes another instance of all the children of the other node, copying them to this node. | |
PandaNode | copySubgraph (Thread current_thread) |
Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. | |
PandaNode | copySubgraph () |
Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. | |
copyTags (PandaNode other) | |
Copies all of the tags stored on the other node onto this node. | |
int | countNumDescendants () |
Returns the number of nodes at and below this level. | |
string | decodeText (string text) |
Returns the given wstring decoded to a single-byte string, via the current encoding system. | |
PyObject | deepcopy (PyObject self, PyObject memo) |
A special Python method that is invoked by copy.deepcopy(node). | |
string | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. | |
bool | encodeToBamStream (basic_stringchar data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
bool | encodeToBamStream (basic_stringchar data) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
string | encodeWtext (string wtext) |
Encodes a wide-text string into a single-char string, according to the current encoding. | |
int | findChild (PandaNode node) |
Returns the index of the indicated child node, if it is a child, or -1 if it is not. | |
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. | |
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. | |
int | findParent (PandaNode node) |
Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. | |
int | findStashed (PandaNode node) |
Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. | |
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. | |
forceUpdate () | |
Forces the TextNode to recompute itself now, even if it believes nothing has changed. | |
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. | |
Alignment | getAlign () |
static BitMaskunsigned | getAllCameraMask () |
RenderAttrib const | getAttrib (TypeHandle type) |
Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. | |
RenderAttrib const | getAttrib (int slot) |
Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
string | getBin () |
Returns the drawing bin set with set_bin(), or empty string if no bin has been set. | |
float | getBottom () |
Returns the bottommost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. | |
BoundingVolume const | 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. | |
BoundingVolume const | getBounds () |
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. | |
BoundingVolume const | 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. | |
BoundingVolume const | getBounds (UpdateSeq seq) |
This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. | |
BoundsType | getBoundsType () |
VBase4 | getCardActual () |
Returns the actual dimensions of the card around the text. | |
VBase4 | getCardAsSet () |
Returns the dimensions of the card as set by set_card_as_margin() or set_card_actual(). | |
float | getCardBorderSize () |
float | getCardBorderUvPortion () |
VBase4 | getCardColor () |
bool | getCardDecal () |
Returns the card_decal flag. | |
Texture | getCardTexture () |
VBase4 | getCardTransformed () |
Returns the actual card dimensions, transformed by the matrix set by set_transform(). | |
PandaNode | getChild (int n, Thread current_thread) |
Returns the nth child node of this node. | |
PandaNode | getChild (int n) |
Returns the nth child node of this node. | |
int | getChildSort (int n) |
Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). | |
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()). | |
CoordinateSystem | getCoordinateSystem () |
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. | |
BitMaskunsigned | getDrawControlMask () |
int | getDrawOrder () |
Returns the drawing order set with set_draw_order(). | |
BitMaskunsigned | getDrawShowMask () |
RenderEffect const | getEffect (TypeHandle type) |
Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. | |
RenderEffects const | getEffects (Thread current_thread) |
Returns the complete RenderEffects that will be applied to this node. | |
RenderEffects const | getEffects () |
Returns the complete RenderEffects that will be applied to this node. | |
string | getEncodedChar (int index) |
Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. | |
string | getEncodedChar (int index, Encoding encoding) |
Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. | |
Encoding | getEncoding () |
Returns the encoding by which the string set via set_text() is to be interpreted. | |
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. | |
int | getFancyBits () |
Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. | |
int | getFlattenFlags () |
Returns the flatten flags. | |
TextFont | getFont () |
Returns the font currently in use, if any. | |
VBase4 | getFrameActual () |
Returns the actual dimensions of the frame around the text. | |
VBase4 | getFrameAsSet () |
Returns the dimensions of the frame as set by set_frame_as_margin() or set_frame_actual(). | |
VBase4 | getFrameColor () |
bool | getFrameCorners () |
float | getFrameLineWidth () |
Returns the thickness of the lines that will be used to draw the frame. | |
float | getGlyphScale () |
Returns the scale factor of each letter as specified by set_glyph_scale(). | |
float | getGlyphShift () |
Returns the vertical shift of each letter as specified by set_glyph_shift(). | |
float | getHeight () |
Returns the net height of the text in local 2-d coordinates. | |
float | getIndent () |
BoundingVolume const | getInternalBounds (Thread current_thread) |
Returns the node's internal bounding volume. | |
BoundingVolume const | getInternalBounds () |
Returns the node's internal bounding volume. | |
PandaNode | getInternalGeom () |
Returns the actual node that is used internally to render the text, if the TextNode is parented within the scene graph. | |
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. | |
int | getInternalVertices () |
Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. | |
BitMaskunsigned | getIntoCollideMask () |
float | getLeft () |
Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. | |
BitMaskunsigned | getLegalCollideMask () |
float | getLineHeight () |
Returns the number of units high each line of text is. | |
Point3 | 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. | |
int | getMaxRows () |
Returns the limit on the height of the TextNode specified by set_max_rows(). | |
string | getName () |
int | getNestedVertices (Thread current_thread) |
Returns the total number of vertices that will be rendered by this node and all of its descendents. | |
int | getNestedVertices () |
Returns the total number of vertices that will be rendered by this node and all of its descendents. | |
BitMaskunsigned | getNetCollideMask (Thread current_thread) |
BitMaskunsigned | getNetCollideMask () |
BitMaskunsigned | getNetDrawControlMask () |
BitMaskunsigned | getNetDrawShowMask () |
PandaNode | getNode () |
Returns the node to be analyzed. | |
int | getNumChars () |
Returns the number of characters in the stored text. | |
int | getNumChildren (Thread current_thread) |
Returns the number of child nodes this node has. | |
int | getNumChildren () |
Returns the number of child nodes this node has. | |
int | getNumParents (Thread current_thread) |
Returns the number of parent nodes this node has. | |
int | getNumParents () |
Returns the number of parent nodes this node has. | |
int | getNumRows () |
Returns the number of rows of text that were generated. | |
int | getNumStashed (Thread current_thread) |
Returns the number of stashed nodes this node has. | |
int | getNumStashed () |
Returns the number of stashed nodes this node has. | |
RenderAttrib const | getOffClipPlanes () |
Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned *off* at this level and below. | |
RenderAttrib const | 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. | |
static BitMaskunsigned | getOverallBit () |
PandaNode | getParent (int n) |
Returns the nth parent node of this node. | |
PandaNode | getParent (int n, Thread current_thread) |
Returns the nth parent node of this node. | |
bool | getPreserveTrailingWhitespace () |
Returns the preserve_trailing_whitespace flag. | |
TransformState const | getPrevTransform (Thread current_thread) |
Returns the transform that has been set as this node's "previous" position. | |
TransformState const | getPrevTransform () |
Returns the transform that has been set as this node's "previous" position. | |
PyObject | getPythonTag (string key) |
Retrieves the Python object that was previously set on this node for the particular key, if any. | |
int | getRefCount () |
Returns the current reference count. | |
float | getRight () |
Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. | |
Vec2 | getShadow () |
Returns the offset of the shadow as set by set_shadow(). | |
VBase4 | getShadowColor () |
float | getSlant () |
Returns the factor by which the text is specified to slant to the right. | |
bool | getSmallCaps () |
Returns the small_caps flag. | |
float | getSmallCapsScale () |
Returns the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. | |
PandaNode | getStashed (int n) |
Returns the nth stashed child of this node. | |
PandaNode | getStashed (int n, Thread current_thread) |
Returns the nth stashed child of this node. | |
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()). | |
int | getStashedSort (int n) |
Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). | |
RenderState const | 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. | |
RenderState const | getState () |
Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. | |
float | getTabWidth () |
Returns the width set via set_tab_width(). | |
string | getTag (string key, Thread current_thread) |
Retrieves the user-defined value that was previously set on this node for the particular key, if any. | |
string | getTag (string key) |
Retrieves the user-defined value that was previously set on this node for the particular key, if any. | |
string | getText (Encoding encoding) |
Returns the current text, as encoded via the indicated encoding system. | |
string | getText () |
Returns the current text, as encoded via the current encoding system. | |
string | getTextAsAscii () |
Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. | |
VBase4 | getTextColor () |
float | getTextScale () |
Returns the scale factor of the text as specified by set_text_scale(). | |
float | getTop () |
Returns the topmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. | |
Mat4 | getTransform () |
Returns the transform that has been set on this particular node. | |
TransformState const | getTransform (Thread current_thread) |
Returns the transform that has been set on this particular node. | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
bool | getUnderscore () |
Returns the underscore flag. | |
float | getUnderscoreHeight () |
Returns the vertical height of the underscore; see set_underscore_height(). | |
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. | |
int | getUnicodeChar (int index) |
Returns the Unicode value of the nth character in the stored text. | |
double | getUpdateInterval () |
Returns the number of seconds that will elapse between updates to the frame rate indication. | |
Point3 | 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. | |
UsageHint | getUsageHint () |
Returns the UsageHint that will be applied to generated geometry. | |
float | getWidth () |
Returns the net width of the text in local 2-d coordinates. | |
GraphicsOutput | getWindow () |
Returns the GraphicsOutput that was passed to setup_window(), or NULL if setup_window() has not been called. | |
float | getWordwrap () |
string | getWordwrappedText () |
Returns a string that represents the contents of the text, as it has been formatted by wordwrap rules. | |
string | getWordwrappedWtext () |
Returns a wstring that represents the contents of the text, as it has been formatted by wordwrap rules. | |
string | getWtext () |
Returns the text associated with the TextEncoder, as a wide-character string. | |
string | getWtextAsAscii () |
Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. | |
bool | hasAlign () |
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. | |
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. | |
bool | hasBin () |
Returns true if an explicit drawing bin has been set via set_bin(), false otherwise. | |
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. | |
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). | |
bool | hasDrawOrder () |
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. | |
bool | hasExactCharacter (wchar_t character) |
Returns true if the named character exists in the font exactly as named, false otherwise. | |
bool | hasFont () |
bool | hasFrame () |
bool | hasGlyphScale () |
bool | hasGlyphShift () |
bool | hasIndent () |
bool | hasMaxRows () |
Returns true if a limit on the height of the TextNode has been set via set_max_rows(), false otherwise. | |
bool | hasName () |
Returns true if the Namable has a nonempty name set, false if the name is empty. | |
bool | hasOverflow () |
Returns true if the last text set on the text node exceeded the max_rows constraint, or false if it all fit. | |
bool | hasPreserveTrailingWhitespace () |
bool | hasPythonTag (string key) |
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. | |
bool | hasShadow () |
bool | hasShadowColor () |
bool | hasSlant () |
bool | hasSmallCaps () |
bool | hasSmallCapsScale () |
bool | hasTabWidth () |
bool | hasTag (string 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. | |
bool | hasTag (string key) |
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. | |
bool | hasTags () |
Returns true if the node has any tags (or any Python tags) at all, false if it has none. | |
bool | hasText () |
bool | hasTextColor () |
bool | hasTextScale () |
bool | hasUnderscore () |
bool | hasUnderscoreHeight () |
bool | hasWordwrap () |
bool | isAmbientLight () |
Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. | |
bool | isAnySpecified () |
Returns true if any properties have been specified, false otherwise. | |
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. | |
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. | |
bool | isExactType (TypeHandle handle) |
Returns true if the current object is the indicated type exactly. | |
bool | isFinal (Thread current_thread) |
Returns the current state of the "final" flag. | |
bool | isFinal () |
Returns the current state of the "final" flag. | |
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. | |
bool | isGeomNode () |
A simple downcast check. | |
bool | isLodNode () |
A simple downcast check. | |
bool | isOfType (TypeHandle handle) |
Returns true if the current object is or derives from the indicated type. | |
bool | isOverallHidden () |
Returns true if the node has been hidden to all cameras by clearing its overall bit. | |
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. | |
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. | |
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. | |
bool | isWtext () |
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()). | |
listTags (ostream out, string separator) | |
Writes a list of all the tag keys assigned to the node to the indicated stream. | |
listTags (ostream out) | |
Writes a list of all the tag keys assigned to the node to the indicated stream. | |
ls (ostream out, int indent_level) | |
Lists all the nodes at and below the current path hierarchically. | |
PandaNode | makeCopy () |
Returns a newly-allocated PandaNode that is a shallow copy of this one. | |
makeLower () | |
Adjusts the text stored within the encoder to all lowercase letters (preserving accent marks correctly). | |
makeUpper () | |
Adjusts the text stored within the encoder to all uppercase letters (preserving accent marks correctly). | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
markBoundsStale () | |
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. | |
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. | |
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. | |
markInternalBoundsStale () | |
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. | |
bool | operator!= (TextProperties const other) |
bool | operator== (TextProperties const other) |
output (ostream out) | |
Outputs the Namable. | |
prepareScene (GraphicsStateGuardianBase gsg, RenderState const net_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. | |
PyObject | reduce (PyObject self) |
This special Python method is implement to provide support for the pickle module. | |
PyObject | reducePersist (PyObject self, PyObject pickler) |
This special Python method is implement to provide support for the pickle module. | |
ref () | |
Explicitly increments the reference count. | |
removeAllChildren () | |
Removes all the children from the node at once, including stashed children. | |
removeAllChildren (Thread current_thread) | |
Removes all the children from the node at once, including stashed children. | |
bool | removeChild (PandaNode child_node, Thread current_thread) |
Removes the indicated child from the node. | |
bool | removeChild (PandaNode child_node) |
Removes the indicated child from the node. | |
removeChild (int child_index, Thread current_thread) | |
Removes the nth child from the node. | |
removeChild (int child_index) | |
Removes the nth child from the node. | |
removeStashed (int child_index, Thread current_thread) | |
Removes the nth stashed child from the node. | |
removeStashed (int child_index) | |
Removes the nth stashed child from the node. | |
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. | |
bool | replaceChild (PandaNode orig_child, PandaNode new_child) |
Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. | |
replaceNode (PandaNode other) | |
Inserts this node into the scene graph in place of the other one, and removes the other node. | |
resetPrevTransform (Thread current_thread) | |
Resets the transform that represents this node's "previous" position to the same as the current transform. | |
resetPrevTransform () | |
Resets the transform that represents this node's "previous" position to the same as the current transform. | |
setAlign (Alignment align_type) | |
Specifies the alignment of the text within its margins. | |
setAttrib (RenderAttrib const attrib, int override) | |
Adds the indicated render attribute to the scene graph on this node. | |
setAttrib (RenderAttrib const attrib) | |
Adds the indicated render attribute to the scene graph on this node. | |
setBin (string bin) | |
Names the GeomBin that the TextNode geometry should be assigned to. | |
setBound (BoundingVolume const volume) | |
Deprecated. | |
setBounds (BoundingVolume const volume) | |
Resets the bounding volume so that it is the indicated volume. | |
setBoundsType (BoundsType bounds_type) | |
Specifies the desired type of bounding volume that will be created for this node. | |
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. | |
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. | |
setCardBorder (float size, float uv_portion) | |
setCardColor (VBase4 const card_color) | |
setCardColor (float r, float g, float b, float a) | |
setCardDecal (bool card_decal) | |
Sets the card_decal flag. | |
setCardTexture (Texture card_texture) | |
setCoordinateSystem (CoordinateSystem cs) | |
Specifies the coordinate system in which the text will be generated. | |
int | setDrawOrder (int draw_order) |
Sets the drawing order of text created by the TextMaker. | |
setEffect (RenderEffect const effect) | |
Adds the indicated render effect to the scene graph on this node. | |
setEffects (RenderEffects const effects, Thread current_thread) | |
Sets the complete RenderEffects that will be applied this node. | |
setEffects (RenderEffects const effects) | |
Sets the complete RenderEffects that will be applied this node. | |
setEncoding (Encoding encoding) | |
Specifies how the string set via set_text() is to be interpreted. | |
setFinal (bool flag) | |
Sets the "final" flag on this PandaNode. | |
setFlattenFlags (int flatten_flags) | |
Sets the flatten flags. | |
setFont (TextFont font) | |
Sets the font that will be used when making text. | |
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. | |
setFrameAsMargin (float left, float right, float bottom, float top) | |
Specifies that a border will be drawn around the text when it is next created. | |
setFrameColor (float r, float g, float b, float a) | |
setFrameColor (VBase4 const frame_color) | |
setFrameCorners (bool corners) | |
Enables or disables the drawing of corners for the frame. | |
setFrameLineWidth (float line_width) | |
Specifies the thickness of the lines that will be used to draw the frame. | |
setGlyphScale (float glyph_scale) | |
Specifies the factor by which to scale each letter of the text as it is placed. | |
setGlyphShift (float glyph_shift) | |
Specifies a vertical amount to shift each letter of the text as it is placed. | |
setIndent (float indent) | |
Specifies the amount of extra space that is inserted before the first character of each line. | |
setIntoCollideMask (BitMaskunsigned int, 32 mask) | |
Sets the "into" CollideMask. | |
setMaxRows (int max_rows) | |
Sets the maximum number of rows that may be formatted by the TextNode. | |
setName (string name) | |
setNode (PandaNode node) | |
Sets the node to be analyzed. | |
setOverallHidden (bool overall_hidden) | |
Sets or clears the hidden flag. | |
setPreserveTrailingWhitespace (bool preserve_trailing_whitespace) | |
Sets the preserve_trailing_whitespace flag. | |
setPrevTransform (TransformState const 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. | |
setPrevTransform (TransformState const transform) | |
Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. | |
setPythonTag (string key, PyObject value) | |
Associates an arbitrary Python object with a user-defined key which is stored on the node. | |
setShadow (VBase2 const 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. | |
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. | |
setShadowColor (VBase4 const 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. | |
setSmallCaps (bool small_caps) | |
Sets the small_caps flag. | |
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. | |
setState (RenderState const state) | |
Sets the complete RenderState that will be applied to all nodes at this level and below. | |
setState (RenderState const state, Thread current_thread) | |
Sets the complete RenderState that will be applied to all nodes at this level and below. | |
setTabWidth (float tab_width) | |
Sets the width of each tab stop, in screen units. | |
setTag (string key, string value) | |
Associates a user-defined value with a user-defined key which is stored on the node. | |
setTag (string key, string value, Thread current_thread) | |
Associates a user-defined value with a user-defined key which is stored on the node. | |
setText (string text, Encoding encoding) | |
The two-parameter version of set_text() accepts an explicit encoding; the text is immediately decoded and stored as a wide-character string. | |
setText (string text) | |
Changes the text that is displayed under the TextNode. | |
setTextColor (VBase4 const 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. | |
setTransform (TransformState const transform, Thread current_thread) | |
Sets the transform that will be applied to this node and below. | |
setTransform (Mat4 const transform) | |
Sets an additional transform that is applied to the entire text paragraph. | |
setTransform (TransformState const transform) | |
Sets the transform that will be applied to this node and below. | |
setUnderscore (bool underscore) | |
Sets the underscore flag. | |
setUnderscoreHeight (float underscore_height) | |
Specifies the vertical height of the underscore, relative to the text baseline. | |
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. | |
setUnicodeChar (int index, int character) | |
Sets the Unicode value of the nth character in the stored text. | |
setUpdateInterval (double update_interval) | |
Specifies the number of seconds that should elapse between updates to the meter. | |
setupWindow (GraphicsOutput window) | |
Sets up the frame rate meter to create a DisplayRegion to render itself into the indicated window. | |
setUsageHint (UsageHint usage_hint) | |
Specifies the UsageHint that will be applied to generated geometry. | |
setWordwrap (float wordwrap) | |
Sets the text up to automatically wordwrap when it exceeds the indicated width. | |
setWtext (string wtext) | |
Changes the text that is displayed under the TextNode, with a wide text. | |
stashChild (int child_index) | |
Stashes the indicated child node. | |
bool | stashChild (PandaNode child_node) |
Stashes the indicated child node. | |
stashChild (int child_index, Thread current_thread) | |
Stashes the indicated child node. | |
bool | stashChild (PandaNode child_node, Thread current_thread) |
Stashes the indicated child node. | |
stealChildren (PandaNode other, Thread current_thread) | |
Moves all the children from the other node onto this node. | |
stealChildren (PandaNode other) | |
Moves all the children from the other node onto this node. | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | testRefCountNonzero () |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
bool | unref () |
Explicitly decrements the reference count. | |
unstashChild (int stashed_index) | |
Returns the indicated stashed node to normal child status. | |
unstashChild (int stashed_index, Thread current_thread) | |
Returns the indicated stashed node to normal child status. | |
bool | unstashChild (PandaNode child_node, Thread current_thread) |
Returns the indicated stashed node to normal child status. | |
bool | unstashChild (PandaNode child_node) |
Returns the indicated stashed node to normal child status. | |
update () | |
You can call this to explicitly force the SceneGraphAnalyzerMeter to update itself with the latest scene graph analysis information. | |
write (ostream out, int indent_level) | |
write (ostream out) | |
Static Public Member Functions | |
static PandaNode | decodeFromBamStream (string 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. | |
static PandaNode | decodeFromBamStream (string data) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. | |
static string | decodeText (string text, Encoding encoding) |
Returns the given wstring decoded to a single-byte string, via the given encoding system. | |
static string | encodeWchar (wchar_t ch, Encoding encoding) |
Encodes a single wide char into a one-, two-, or three-byte string, according to the given encoding system. | |
static string | encodeWtext (string wtext, Encoding encoding) |
Encodes a wide-text string into a single-char string, according to the given encoding. | |
static TypeHandle | getClassType () |
static Encoding | getDefaultEncoding () |
Specifies the default encoding to be used for all subsequently created TextEncoder objects. | |
static TextFont | getDefaultFont () |
Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. | |
static string | lower (string source) |
Converts the string to lowercase, assuming the string is encoded in the default encoding. | |
static string | lower (string source, Encoding encoding) |
Converts the string to lowercase, assuming the string is encoded in the indicated encoding. | |
static string | reencodeText (string text, Encoding from, Encoding to) |
Given the indicated text string, which is assumed to be encoded via the encoding "from", decodes it and then reencodes it into the encoding "to", and returns the newly encoded string. | |
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. | |
static | resetAllPrevTransform () |
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. | |
static | setDefaultEncoding (Encoding encoding) |
Specifies the default encoding to be used for all subsequently created TextEncoder objects. | |
static | setDefaultFont (TextFont) |
Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. | |
static bool | unicodeIsalpha (int character) |
Returns true if the indicated character is an alphabetic letter, false otherwise. | |
static bool | unicodeIsdigit (int character) |
Returns true if the indicated character is a numeric digit, false otherwise. | |
static bool | unicodeIslower (int character) |
Returns true if the indicated character is a lowercase letter, false otherwise. | |
static bool | unicodeIspunct (int character) |
Returns true if the indicated character is a punctuation mark, false otherwise. | |
static bool | unicodeIsspace (int character) |
Returns true if the indicated character is a whitespace letter, false otherwise. | |
static bool | unicodeIsupper (int character) |
Returns true if the indicated character is an uppercase letter, false otherwise. | |
static int | unicodeTolower (int character) |
Returns the uppercase equivalent of the given Unicode character. | |
static int | unicodeToupper (int character) |
Returns the uppercase equivalent of the given Unicode character. | |
static string | upper (string source) |
Converts the string to uppercase, assuming the string is encoded in the default encoding. | |
static string | upper (string source, Encoding encoding) |
Converts the string to uppercase, assuming the string is encoded in the indicated encoding. | |
Public Attributes | |
BitMaskunsigned | int |
Returns the set of bits in draw_show_mask that are considered meaningful. | |
Static Public Attributes | |
static BitMaskunsigned | int |
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. |
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.
enum Alignment [inherited] |
enum Encoding [inherited] |
enum FancyBits [inherited] |
enum FlattenFlags [inherited] |
enum UnexpectedChange [inherited] |
SceneGraphAnalyzerMeter | ( | string | name, |
PandaNode | node | ||
) |
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.
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.
addChild | ( | PandaNode | child_node | ) | [inherited] |
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.
addProperties | ( | TextProperties const | other | ) | [inherited] |
Sets any properties that are explicitly specified in other on this object.
Leaves other properties unchanged.
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).
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).
addStashed | ( | PandaNode | child_node | ) | [inherited] |
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 | ( | BitMaskunsigned | int, |
32 | show_mask, | ||
BitMaskunsigned | int, | ||
32 | hide_mask, | ||
BitMaskunsigned | int, | ||
32 | clear_mask | ||
) | [inherited] |
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.
appendText | ( | string | text | ) | [inherited] |
Appends the indicates string to the end of the stored text.
Reimplemented from TextEncoder.
appendUnicodeChar | ( | int | character | ) | [inherited] |
Appends a single character to the end of the stored text.
This may be a wide character, up to 16 bits in Unicode.
appendUnicodeChar | ( | wchar_t | character | ) | [inherited] |
Appends a single character to the end of the stored text.
This may be a wide character, up to 16 bits in Unicode.
appendWtext | ( | string | text | ) | [inherited] |
Appends the indicates string to the end of the stored wide-character text.
Reimplemented from TextEncoder.
Light asLight | ( | ) | [inherited] |
float calcWidth | ( | string | line | ) | [inherited] |
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.
float calcWidth | ( | wchar_t | character | ) | [inherited] |
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).
float calcWidth | ( | string | line | ) | [inherited] |
Returns the width of a line of text of arbitrary characters.
The line should not include the newline character.
clear | ( | ) | [inherited] |
Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state.
clearAlign | ( | ) | [inherited] |
Restores the default alignment of the text.
Reimplemented from TextProperties.
clearAttrib | ( | TypeHandle | type | ) | [inherited] |
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.
clearAttrib | ( | int | slot | ) | [inherited] |
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.
clearBin | ( | ) | [inherited] |
Removes the effect of a previous call to set_bin().
Text will be drawn in whatever bin it would like to be drawn in, with no explicit ordering.
Reimplemented from TextProperties.
clearBounds | ( | ) | [inherited] |
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.
clearCard | ( | ) | [inherited] |
Specifies that a card will not be drawn behind the text.
clearCardBorder | ( | ) | [inherited] |
clearCardTexture | ( | ) | [inherited] |
clearDrawOrder | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearEffect | ( | TypeHandle | type | ) | [inherited] |
Removes the render effect of the given type from this node.
clearEffects | ( | Thread | current_thread | ) | [inherited] |
Resets this node to have no render effects.
clearEffects | ( | ) | [inherited] |
Resets this node to have no render effects.
clearFont | ( | ) | [inherited] |
Resets the font to the default font.
Reimplemented from TextProperties.
clearFrame | ( | ) | [inherited] |
Specifies that a border will not be drawn around the text.
clearGlyphScale | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearGlyphShift | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearIndent | ( | ) | [inherited] |
Removes the indent setting from the text.
Text will be as wide as it is.
Reimplemented from TextProperties.
clearMaxRows | ( | ) | [inherited] |
Resets the TextNode's default behavior of not limiting the number of rows of text.
clearName | ( | ) | [inherited] |
Resets the Namable's name to empty.
Reimplemented in AsyncTask.
clearPreserveTrailingWhitespace | ( | ) | [inherited] |
clearPythonTag | ( | string | key | ) | [inherited] |
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.
clearShadow | ( | ) | [inherited] |
Specifies that a shadow will not be drawn behind the text.
Reimplemented from TextProperties.
clearShadowColor | ( | ) | [inherited] |
Removes the shadow color specification.
Reimplemented from TextProperties.
clearSlant | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearSmallCaps | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearSmallCapsScale | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearState | ( | Thread | current_thread | ) | [inherited] |
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.
clearState | ( | ) | [inherited] |
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.
clearTabWidth | ( | ) | [inherited] |
Reimplemented from TextProperties.
clearTag | ( | string | key, |
Thread | current_thread | ||
) | [inherited] |
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.
clearTag | ( | string | key | ) | [inherited] |
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.
clearText | ( | ) | [inherited] |
Removes the text from the TextNode.
Reimplemented from TextEncoder.
clearTextColor | ( | ) | [inherited] |
Removes the text color specification; the text will be colored whatever it was in the source font file.
Reimplemented from TextProperties.
clearTextScale | ( | ) | [inherited] |
clearTransform | ( | Thread | current_thread | ) | [inherited] |
Resets the transform on this node to the identity transform.
clearTransform | ( | ) | [inherited] |
Resets the transform on this node to the identity transform.
clearUnderscore | ( | ) | [inherited] |
clearUnderscoreHeight | ( | ) | [inherited] |
clearUnexpectedChange | ( | unsigned int | flags | ) | [inherited] |
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.
clearWindow | ( | ) |
Undoes the effect of a previous call to setup_window().
clearWordwrap | ( | ) | [inherited] |
Removes the wordwrap setting from the TextNode.
Text will be as wide as it is.
Reimplemented from TextProperties.
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.
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.
PandaNode copy | ( | ) | [inherited] |
A special Python method that is invoked by copy.copy(node).
Unlike the PandaNode copy constructor, which creates a new node without children, this shares child pointers (essentially making every child an instance). This is intended to simulate the behavior of copy.copy() for other objects.
copyAllProperties | ( | PandaNode | other | ) | [inherited] |
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()).
Makes another instance of all the children of the other node, copying them to this node.
copyChildren | ( | PandaNode | other | ) | [inherited] |
Makes another instance of all the children of the other node, copying them to this node.
PandaNode copySubgraph | ( | ) | [inherited] |
copyTags | ( | PandaNode | other | ) | [inherited] |
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.
int countNumDescendants | ( | ) | [inherited] |
Returns the number of nodes at and below this level.
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.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type PandaNode, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
static PandaNode decodeFromBamStream | ( | string | data | ) | [static, inherited] |
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.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type PandaNode, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
string decodeText | ( | string | text | ) | [inherited] |
Returns the given wstring decoded to a single-byte string, via the current encoding system.
static string decodeText | ( | string | text, |
Encoding | encoding | ||
) | [static, inherited] |
Returns the given wstring decoded to a single-byte string, via the given encoding system.
PyObject deepcopy | ( | PyObject | self, |
PyObject | memo | ||
) | [inherited] |
A special Python method that is invoked by copy.deepcopy(node).
This calls copy_subgraph() unless the node is already present in the provided dictionary.
string encodeToBamStream | ( | ) | [inherited] |
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.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data, |
BamWriter | writer | ||
) | [inherited] |
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.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data | ) | [inherited] |
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.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
static string encodeWchar | ( | wchar_t | ch, |
Encoding | encoding | ||
) | [static, inherited] |
Encodes a single wide char into a one-, two-, or three-byte string, according to the given encoding system.
string encodeWtext | ( | string | wtext | ) | [inherited] |
Encodes a wide-text string into a single-char string, according to the current encoding.
static string encodeWtext | ( | string | wtext, |
Encoding | encoding | ||
) | [static, inherited] |
Encodes a wide-text string into a single-char string, according to the given encoding.
Returns the index of the indicated child node, if it is a child, or -1 if it is not.
Returns the index of the indicated child node, if it is a child, or -1 if it is not.
Returns the index of the indicated parent node, if it is a parent, or -1 if it is not.
Returns the index of the indicated parent node, if it is a parent, or -1 if it is not.
Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not.
Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not.
forceUpdate | ( | ) | [inherited] |
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).
PandaNode generate | ( | ) | [inherited] |
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.
Alignment getAlign | ( | ) | [inherited] |
static BitMaskunsigned getAllCameraMask | ( | ) | [inherited] |
RenderAttrib const getAttrib | ( | TypeHandle | type | ) | [inherited] |
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.
RenderAttrib const getAttrib | ( | int | slot | ) | [inherited] |
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.
UpdateSeq getBamModified | ( | ) | [inherited] |
Returns the current bam_modified counter.
This counter is normally incremented automatically whenever the object is modified.
string getBin | ( | ) | [inherited] |
Returns the drawing bin set with set_bin(), or empty string if no bin has been set.
float getBottom | ( | ) | [inherited] |
Returns the bottommost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.
BoundingVolume const getBounds | ( | Thread | current_thread | ) | [inherited] |
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.
BoundingVolume const getBounds | ( | ) | [inherited] |
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.
BoundingVolume const getBounds | ( | UpdateSeq | seq, |
Thread | current_thread | ||
) | [inherited] |
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.
BoundingVolume const getBounds | ( | UpdateSeq | seq | ) | [inherited] |
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.
BoundsType getBoundsType | ( | ) | [inherited] |
VBase4 getCardActual | ( | ) | [inherited] |
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.
VBase4 getCardAsSet | ( | ) | [inherited] |
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.
float getCardBorderSize | ( | ) | [inherited] |
float getCardBorderUvPortion | ( | ) | [inherited] |
VBase4 getCardColor | ( | ) | [inherited] |
bool getCardDecal | ( | ) | [inherited] |
Returns the card_decal flag.
See set_card_decal().
Texture getCardTexture | ( | ) | [inherited] |
VBase4 getCardTransformed | ( | ) | [inherited] |
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().
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.
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.
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().
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().
static TypeHandle getClassType | ( | ) | [static] |
Reimplemented from TextNode.
CoordinateSystem getCoordinateSystem | ( | ) | [inherited] |
static Encoding getDefaultEncoding | ( | ) | [static, inherited] |
Specifies the default encoding to be used for all subsequently created TextEncoder objects.
See set_encoding().
static TextFont getDefaultFont | ( | ) | [static, inherited] |
Specifies the default font to be used for any TextNode whose font is uninitialized or NULL.
See set_font().
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.
BitMaskunsigned getDrawControlMask | ( | ) | [inherited] |
int getDrawOrder | ( | ) | [inherited] |
Returns the drawing order set with set_draw_order().
BitMaskunsigned getDrawShowMask | ( | ) | [inherited] |
RenderEffect const getEffect | ( | TypeHandle | type | ) | [inherited] |
Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not.
RenderEffects const getEffects | ( | Thread | current_thread | ) | [inherited] |
Returns the complete RenderEffects that will be applied to this node.
RenderEffects const getEffects | ( | ) | [inherited] |
Returns the complete RenderEffects that will be applied to this node.
string getEncodedChar | ( | int | index | ) | [inherited] |
Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string.
Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string.
Encoding getEncoding | ( | ) | [inherited] |
Returns the encoding by which the string set via set_text() is to be interpreted.
See set_encoding().
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.
int getFancyBits | ( | ) | [inherited] |
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.
int getFlattenFlags | ( | ) | [inherited] |
Returns the flatten flags.
See set_flatten_flags().
TextFont getFont | ( | ) | [inherited] |
Returns the font currently in use, if any.
If no font is in use, this returns the default font.
VBase4 getFrameActual | ( | ) | [inherited] |
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.
VBase4 getFrameAsSet | ( | ) | [inherited] |
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.
VBase4 getFrameColor | ( | ) | [inherited] |
bool getFrameCorners | ( | ) | [inherited] |
float getFrameLineWidth | ( | ) | [inherited] |
Returns the thickness of the lines that will be used to draw the frame.
float getGlyphScale | ( | ) | [inherited] |
Returns the scale factor of each letter as specified by set_glyph_scale().
float getGlyphShift | ( | ) | [inherited] |
Returns the vertical shift of each letter as specified by set_glyph_shift().
float getHeight | ( | ) | [inherited] |
Returns the net height of the text in local 2-d coordinates.
float getIndent | ( | ) | [inherited] |
BoundingVolume const getInternalBounds | ( | Thread | current_thread | ) | [inherited] |
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.
BoundingVolume const getInternalBounds | ( | ) | [inherited] |
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.
PandaNode getInternalGeom | ( | ) | [inherited] |
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.
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.
int getInternalVertices | ( | ) | [inherited] |
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.
BitMaskunsigned getIntoCollideMask | ( | ) | [inherited] |
Reimplemented in CollisionNode.
float getLeft | ( | ) | [inherited] |
Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.
BitMaskunsigned getLegalCollideMask | ( | ) | [inherited] |
float getLineHeight | ( | ) | [inherited] |
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.
Point3 getLowerRight3d | ( | ) | [inherited] |
Returns the lower-right extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix.
int getMaxRows | ( | ) | [inherited] |
Returns the limit on the height of the TextNode specified by set_max_rows().
string getName | ( | ) | [inherited] |
Reimplemented in DynamicTextFont.
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.
int getNestedVertices | ( | ) | [inherited] |
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.
BitMaskunsigned getNetCollideMask | ( | Thread | current_thread | ) | [inherited] |
BitMaskunsigned getNetCollideMask | ( | ) | [inherited] |
BitMaskunsigned getNetDrawControlMask | ( | ) | [inherited] |
BitMaskunsigned getNetDrawShowMask | ( | ) | [inherited] |
PandaNode getNode | ( | ) |
Returns the node to be analyzed.
int getNumChars | ( | ) | [inherited] |
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().
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.
int getNumChildren | ( | ) | [inherited] |
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.
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.
int getNumParents | ( | ) | [inherited] |
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.
int getNumRows | ( | ) | [inherited] |
Returns the number of rows of text that were generated.
This counts word-wrapped rows as well as rows generated due to embedded newlines.
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().
int getNumStashed | ( | ) | [inherited] |
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().
RenderAttrib const getOffClipPlanes | ( | Thread | current_thread | ) | [inherited] |
Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned *off* at this level and below.
RenderAttrib const getOffClipPlanes | ( | ) | [inherited] |
Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned *off* at this level and below.
static BitMaskunsigned getOverallBit | ( | ) | [inherited] |
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.
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.
bool getPreserveTrailingWhitespace | ( | ) | [inherited] |
Returns the preserve_trailing_whitespace flag.
See set_preserve_trailing_whitespace().
TransformState const getPrevTransform | ( | Thread | current_thread | ) | [inherited] |
Returns the transform that has been set as this node's "previous" position.
See set_prev_transform().
TransformState const getPrevTransform | ( | ) | [inherited] |
Returns the transform that has been set as this node's "previous" position.
See set_prev_transform().
PyObject getPythonTag | ( | string | key | ) | [inherited] |
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.
int getRefCount | ( | ) | [inherited] |
Returns the current reference count.
float getRight | ( | ) | [inherited] |
Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.
Vec2 getShadow | ( | ) | [inherited] |
Returns the offset of the shadow as set by set_shadow().
It is an error to call this if has_shadow() is false.
VBase4 getShadowColor | ( | ) | [inherited] |
float getSlant | ( | ) | [inherited] |
Returns the factor by which the text is specified to slant to the right.
bool getSmallCaps | ( | ) | [inherited] |
Returns the small_caps flag.
See set_small_caps().
float getSmallCapsScale | ( | ) | [inherited] |
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().
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.
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.
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().
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().
RenderState const getState | ( | Thread | current_thread | ) | [inherited] |
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.
RenderState const getState | ( | ) | [inherited] |
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.
Reimplemented in PGItem.
float getTabWidth | ( | ) | [inherited] |
Returns the width set via set_tab_width().
string getTag | ( | string | key, |
Thread | current_thread | ||
) | [inherited] |
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.
string getTag | ( | string | key | ) | [inherited] |
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.
string getText | ( | Encoding | encoding | ) | [inherited] |
Returns the current text, as encoded via the indicated encoding system.
string getText | ( | ) | [inherited] |
Returns the current text, as encoded via the current encoding system.
string getTextAsAscii | ( | ) | [inherited] |
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().
VBase4 getTextColor | ( | ) | [inherited] |
float getTextScale | ( | ) | [inherited] |
Returns the scale factor of the text as specified by set_text_scale().
float getTop | ( | ) | [inherited] |
Returns the topmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix.
Mat4 getTransform | ( | ) | [inherited] |
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.
Reimplemented from PandaNode.
TransformState const getTransform | ( | Thread | current_thread | ) | [inherited] |
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.
TypeHandle getType | ( | ) | [inherited] |
Reimplemented in AnimChannelBase.
int getTypeIndex | ( | ) | [inherited] |
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().
bool getUnderscore | ( | ) | [inherited] |
Returns the underscore flag.
See set_underscore().
float getUnderscoreHeight | ( | ) | [inherited] |
Returns the vertical height of the underscore; see set_underscore_height().
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.
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().
double getUpdateInterval | ( | ) |
Returns the number of seconds that will elapse between updates to the frame rate indication.
Point3 getUpperLeft3d | ( | ) | [inherited] |
Returns the upper-left extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix.
UsageHint getUsageHint | ( | ) | [inherited] |
Returns the UsageHint that will be applied to generated geometry.
See set_usage_hint().
float getWidth | ( | ) | [inherited] |
Returns the net width of the text in local 2-d coordinates.
GraphicsOutput getWindow | ( | ) |
Returns the GraphicsOutput that was passed to setup_window(), or NULL if setup_window() has not been called.
float getWordwrap | ( | ) | [inherited] |
string getWordwrappedText | ( | ) | [inherited] |
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.
string getWordwrappedWtext | ( | ) | [inherited] |
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.
string getWtext | ( | ) | [inherited] |
Returns the text associated with the TextEncoder, as a wide-character string.
string getWtextAsAscii | ( | ) | [inherited] |
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.
bool hasAlign | ( | ) | [inherited] |
bool hasAttrib | ( | int | slot | ) | [inherited] |
Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not.
bool hasAttrib | ( | TypeHandle | type | ) | [inherited] |
Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not.
bool hasBin | ( | ) | [inherited] |
Returns true if an explicit drawing bin has been set via set_bin(), false otherwise.
bool hasCard | ( | ) | [inherited] |
bool hasCardBorder | ( | ) | [inherited] |
bool hasCardTexture | ( | ) | [inherited] |
bool hasCharacter | ( | wchar_t | character | ) | [inherited] |
Returns true if the named character exists in the font or can be synthesized by Panda, false otherwise.
(Panda can synthesize some accented characters by combining similar-looking glyphs from the font.)
This returns true for whitespace and Unicode whitespace characters (if they exist in the font), but returns false for characters that would render with the "invalid glyph".
bool hasDirtyPrevTransform | ( | ) | [inherited] |
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().
bool hasDrawOrder | ( | ) | [inherited] |
bool hasEffect | ( | TypeHandle | type | ) | [inherited] |
Returns true if there is a render effect of the indicated type defined on this node, or false if there is not.
bool hasExactCharacter | ( | wchar_t | character | ) | [inherited] |
Returns true if the named character exists in the font exactly as named, false otherwise.
Note that because Panda can assemble glyphs together automatically using cheesy accent marks, this is not a reliable indicator of whether a suitable glyph can be rendered for the character. For that, use has_character() instead.
This returns true for whitespace and Unicode whitespace characters (if they exist in the font), but returns false for characters that would render with the "invalid glyph". It also returns false for characters that would be synthesized within Panda, but see has_character().
bool hasFont | ( | ) | [inherited] |
bool hasFrame | ( | ) | [inherited] |
bool hasGlyphScale | ( | ) | [inherited] |
bool hasGlyphShift | ( | ) | [inherited] |
bool hasIndent | ( | ) | [inherited] |
bool hasMaxRows | ( | ) | [inherited] |
Returns true if a limit on the height of the TextNode has been set via set_max_rows(), false otherwise.
bool hasName | ( | ) | [inherited] |
Returns true if the Namable has a nonempty name set, false if the name is empty.
bool hasOverflow | ( | ) | [inherited] |
Returns true if the last text set on the text node exceeded the max_rows constraint, or false if it all fit.
bool hasPreserveTrailingWhitespace | ( | ) | [inherited] |
bool hasPythonTag | ( | string | key | ) | [inherited] |
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.
bool hasShadow | ( | ) | [inherited] |
bool hasShadowColor | ( | ) | [inherited] |
bool hasSlant | ( | ) | [inherited] |
bool hasSmallCaps | ( | ) | [inherited] |
bool hasSmallCapsScale | ( | ) | [inherited] |
bool hasTabWidth | ( | ) | [inherited] |
bool hasTag | ( | string | key | ) | [inherited] |
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.
bool hasTag | ( | string | key, |
Thread | current_thread | ||
) | [inherited] |
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.
bool hasTags | ( | ) | [inherited] |
Returns true if the node has any tags (or any Python tags) at all, false if it has none.
bool hasText | ( | ) | [inherited] |
bool hasTextColor | ( | ) | [inherited] |
bool hasTextScale | ( | ) | [inherited] |
bool hasUnderscore | ( | ) | [inherited] |
bool hasUnderscoreHeight | ( | ) | [inherited] |
bool hasWordwrap | ( | ) | [inherited] |
bool isAmbientLight | ( | ) | [inherited] |
Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light.
bool isAnySpecified | ( | ) | [inherited] |
Returns true if any properties have been specified, false otherwise.
bool isBoundsStale | ( | ) | [inherited] |
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.
bool isCardAsMargin | ( | ) | [inherited] |
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.
bool isExactType | ( | TypeHandle | handle | ) | [inherited] |
Returns true if the current object is the indicated type exactly.
bool isFinal | ( | Thread | current_thread | ) | [inherited] |
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().
bool isFinal | ( | ) | [inherited] |
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().
bool isFrameAsMargin | ( | ) | [inherited] |
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.
bool isGeomNode | ( | ) | [inherited] |
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.
bool isLodNode | ( | ) | [inherited] |
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()).
bool isOfType | ( | TypeHandle | handle | ) | [inherited] |
Returns true if the current object is or derives from the indicated type.
bool isOverallHidden | ( | ) | [inherited] |
Returns true if the node has been hidden to all cameras by clearing its overall bit.
bool isSceneRoot | ( | ) | [inherited] |
Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise.
bool isUnderSceneRoot | ( | ) | [inherited] |
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.
bool isWhitespace | ( | wchar_t | character | ) | [inherited] |
Returns true if the indicated character represents whitespace in the font, or false if anything visible will be rendered for it.
This returns true for whitespace and Unicode whitespace characters (if they exist in the font), and returns false for any other characters, including characters that do not exist in the font (these would be rendered with the "invalid glyph", which is visible).
Note that this function can be reliably used to identify Unicode whitespace characters only if the font has all of the whitespace characters defined. It will return false for any character not in the font, even if it is an official Unicode whitespace character.
bool isWtext | ( | ) | [inherited] |
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()).
listTags | ( | ostream | out | ) | [inherited] |
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.
listTags | ( | ostream | out, |
string | separator | ||
) | [inherited] |
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.
static string lower | ( | string | source | ) | [static, inherited] |
Converts the string to lowercase, assuming the string is encoded in the default encoding.
static string lower | ( | string | source, |
Encoding | encoding | ||
) | [static, inherited] |
Converts the string to lowercase, assuming the string is encoded in the indicated encoding.
Lists all the nodes at and below the current path hierarchically.
PandaNode makeCopy | ( | ) | [inherited] |
makeLower | ( | ) | [inherited] |
Adjusts the text stored within the encoder to all lowercase letters (preserving accent marks correctly).
makeUpper | ( | ) | [inherited] |
Adjusts the text stored within the encoder to all uppercase letters (preserving accent marks correctly).
markBamModified | ( | ) | [inherited] |
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.
markBoundsStale | ( | Thread | current_thread | ) | [inherited] |
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.
markBoundsStale | ( | ) | [inherited] |
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 | ( | ) | [inherited] |
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.
markInternalBoundsStale | ( | Thread | current_thread | ) | [inherited] |
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.
bool operator!= | ( | TextProperties const | other | ) | [inherited] |
bool operator== | ( | TextProperties const | other | ) | [inherited] |
output | ( | ostream | out | ) | [inherited] |
prepareScene | ( | GraphicsStateGuardianBase | gsg, |
RenderState const | net_state | ||
) | [inherited] |
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.
In particular, this will ensure that textures within the scene are loaded in texture memory, and display lists are built up from static geometry.
PyObject reduce | ( | PyObject | self | ) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.
PyObject reducePersist | ( | PyObject | self, |
PyObject | pickler | ||
) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.
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.
ref | ( | ) | [inherited] |
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.
removeAllChildren | ( | ) | [inherited] |
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).
removeAllChildren | ( | Thread | current_thread | ) | [inherited] |
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).
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.
removeChild | ( | int | child_index | ) | [inherited] |
Removes the nth child from the node.
bool removeChild | ( | PandaNode | child_node | ) | [inherited] |
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.
Removes the nth child from the node.
removeStashed | ( | int | child_index | ) | [inherited] |
Removes the nth stashed child from the node.
Removes the nth stashed child from the node.
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.
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 | ( | PandaNode | other | ) | [inherited] |
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.
static resetAllPrevTransform | ( | ) | [static, inherited] |
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.
static resetAllPrevTransform | ( | Thread | current_thread | ) | [static, inherited] |
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 | ( | Thread | current_thread | ) | [inherited] |
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.
resetPrevTransform | ( | ) | [inherited] |
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.
setAlign | ( | Alignment | align_type | ) | [inherited] |
Specifies the alignment of the text within its margins.
Reimplemented from TextProperties.
setAttrib | ( | RenderAttrib const | attrib | ) | [inherited] |
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.
setAttrib | ( | RenderAttrib const | attrib, |
int | override | ||
) | [inherited] |
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.
setBin | ( | string | bin | ) | [inherited] |
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".
Reimplemented from TextProperties.
setBound | ( | BoundingVolume const | volume | ) | [inherited] |
Deprecated.
Use set_bounds() instead.
setBounds | ( | BoundingVolume const | volume | ) | [inherited] |
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.
setBoundsType | ( | BoundsType | bounds_type | ) | [inherited] |
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".
If this is BT_sphere or BT_box, a BoundingSphere or BoundingBox is explicitly created. If it is BT_best, the appropriate type to best enclose the node's children is created.
This affects the bounding volume returned by get_bounds(), which is not exactly the same bounding volume modified by set_bounds(), because a new bounding volume has to be created that includes this node and all of its children.
setCardActual | ( | float | left, |
float | right, | ||
float | bottom, | ||
float | top | ||
) | [inherited] |
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 | ( | float | left, |
float | right, | ||
float | bottom, | ||
float | top | ||
) | [inherited] |
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 | ( | float | size, |
float | uv_portion | ||
) | [inherited] |
setCardColor | ( | float | r, |
float | g, | ||
float | b, | ||
float | a | ||
) | [inherited] |
setCardColor | ( | VBase4 const | card_color | ) | [inherited] |
setCardDecal | ( | bool | card_decal | ) | [inherited] |
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 | ( | Texture | card_texture | ) | [inherited] |
setCoordinateSystem | ( | CoordinateSystem | cs | ) | [inherited] |
Specifies the coordinate system in which the text will be generated.
static setDefaultEncoding | ( | Encoding | encoding | ) | [static, inherited] |
Specifies the default encoding to be used for all subsequently created TextEncoder objects.
See set_encoding().
static setDefaultFont | ( | TextFont | ) | [static, inherited] |
Specifies the default font to be used for any TextNode whose font is uninitialized or NULL.
See set_font().
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.
Reimplemented from TextProperties.
setEffect | ( | RenderEffect const | effect | ) | [inherited] |
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 | ( | RenderEffects const | effects | ) | [inherited] |
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().
setEffects | ( | RenderEffects const | effects, |
Thread | current_thread | ||
) | [inherited] |
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().
setEncoding | ( | Encoding | encoding | ) | [inherited] |
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.
setFinal | ( | bool | flag | ) | [inherited] |
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.
setFlattenFlags | ( | int | flatten_flags | ) | [inherited] |
Sets the flatten flags.
This should be a union of the TextNode.FlattenFlags options. This controls the degree of flattening performed on the TextNode's internal geometry (i.e. the scene graph returned by generate()) each time the text is changed. In general, more flattening means a more optimal result, but it will take more time to generate.
The choice may be any of these three:
FF_none - No flatten operation is called. The letters are left as independent Geoms.
FF_light - A flatten_light() operation is called. The attributes are applied to the vertices, but no nodes are removed.
FF_medium - A flatten_medium() operation is called. The attributes are applied to the vertices, and a few trivial nodes are removed.
FF_strong - A flatten_strong() operation is called. The attributes are applied to the vertices, and the resulting nodes are aggressively combined into as few nodes as possible.
In addition to the above choices, you may optionally include the following flag:
FF_dynamic_merge - Copy the geoms into a single GeomVertexData as we go, instead of relying on the flatten operation at the end. This pre-flattens the text considerably, and may obviate the need for flatten altogether; it also tends to improve performance considerably even if you do call flatten. However, it is not as fast as not calling flatten at all.
The default is taken from the text-flatten and text-dynamic-merge config variables.
setFont | ( | TextFont | font | ) | [inherited] |
Sets the font that will be used when making text.
If this is set to NULL, the default font will be used, which can be set via set_default_font().
Reimplemented from TextProperties.
setFrameActual | ( | float | left, |
float | right, | ||
float | bottom, | ||
float | top | ||
) | [inherited] |
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 | ( | float | left, |
float | right, | ||
float | bottom, | ||
float | top | ||
) | [inherited] |
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 | ( | VBase4 const | frame_color | ) | [inherited] |
setFrameColor | ( | float | r, |
float | g, | ||
float | b, | ||
float | a | ||
) | [inherited] |
setFrameCorners | ( | bool | corners | ) | [inherited] |
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 | ( | float | line_width | ) | [inherited] |
Specifies the thickness of the lines that will be used to draw the frame.
setGlyphScale | ( | float | glyph_scale | ) | [inherited] |
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.
Reimplemented from TextProperties.
setGlyphShift | ( | float | glyph_shift | ) | [inherited] |
Specifies a vertical amount to shift each letter of the text as it is placed.
This can be used (possibly in conjunction with set_glyph_scale()) to implement superscripting or subscripting.
Reimplemented from TextProperties.
setIndent | ( | float | indent | ) | [inherited] |
Specifies the amount of extra space that is inserted before the first character of each line.
This can be thought of as a left margin.
Reimplemented from TextProperties.
setIntoCollideMask | ( | BitMaskunsigned | int, |
32 | mask | ||
) | [inherited] |
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.
Reimplemented in CollisionNode.
setMaxRows | ( | int | max_rows | ) | [inherited] |
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.
setNode | ( | PandaNode | node | ) |
Sets the node to be analyzed.
setOverallHidden | ( | bool | overall_hidden | ) | [inherited] |
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.
setPreserveTrailingWhitespace | ( | bool | preserve_trailing_whitespace | ) | [inherited] |
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.
setPrevTransform | ( | TransformState const | transform, |
Thread | current_thread | ||
) | [inherited] |
Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations.
setPrevTransform | ( | TransformState const | transform | ) | [inherited] |
Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations.
setPythonTag | ( | string | key, |
PyObject | value | ||
) | [inherited] |
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.
setShadow | ( | VBase2 const | shadow_offset | ) | [inherited] |
Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first.
Reimplemented from TextProperties.
setShadow | ( | float | xoffset, |
float | yoffset | ||
) | [inherited] |
Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first.
Reimplemented from TextProperties.
setShadowColor | ( | VBase4 const | shadow_color | ) | [inherited] |
Reimplemented from TextProperties.
setShadowColor | ( | float | r, |
float | g, | ||
float | b, | ||
float | a | ||
) | [inherited] |
Reimplemented from TextProperties.
setSlant | ( | float | slant | ) | [inherited] |
Specifies the factor by which the text slants to the right.
Reimplemented from TextProperties.
setSmallCaps | ( | bool | small_caps | ) | [inherited] |
Sets the small_caps flag.
When this is set, lowercase letters are generated as scaled-down versions of their uppercase equivalents. This is particularly useful to set for fonts that do not have lowercase letters.
It is also a good idea to set this for a (dynamic) font that has already implemented lowercase letters as scaled-down versions of their uppercase equivalents, since without this flag the texture memory may needlessly duplicate equivalent glyphs for upper and lowercase letters. Setting this flag causes the texture memory to share the mixed-case letters.
The amount by which the lowercase letters are scaled is specified by set_small_caps_scale().
Reimplemented from TextProperties.
setSmallCapsScale | ( | float | small_caps_scale | ) | [inherited] |
Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect.
See set_small_caps(). Normally, this will be a number less than one.
Reimplemented from TextProperties.
setState | ( | RenderState const | state | ) | [inherited] |
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().
setState | ( | RenderState const | state, |
Thread | current_thread | ||
) | [inherited] |
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().
setTabWidth | ( | float | tab_width | ) | [inherited] |
Sets the width of each tab stop, in screen units.
A tab character embedded in the text will advance the horizontal position to the next tab stop.
Reimplemented from TextProperties.
setTag | ( | string | key, |
string | value | ||
) | [inherited] |
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.
setTag | ( | string | key, |
string | value, | ||
Thread | current_thread | ||
) | [inherited] |
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.
setText | ( | string | text | ) | [inherited] |
Changes the text that is displayed under the TextNode.
Reimplemented from TextEncoder.
setText | ( | string | text, |
Encoding | encoding | ||
) | [inherited] |
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().
Reimplemented from TextEncoder.
setTextColor | ( | VBase4 const | text_color | ) | [inherited] |
Reimplemented from TextProperties.
setTextColor | ( | float | r, |
float | g, | ||
float | b, | ||
float | a | ||
) | [inherited] |
Reimplemented from TextProperties.
setTextScale | ( | float | text_scale | ) | [inherited] |
Specifies the factor by which to scale the text, in addition to any scalings imposed by the node, as well as in addition to the glyph scale.
The text scale is not cumulative when applied to nested TextProperties. See also set_glyph_scale(), which is cumulative.
setTransform | ( | TransformState const | transform, |
Thread | current_thread | ||
) | [inherited] |
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.
setTransform | ( | Mat4 const | transform | ) | [inherited] |
Sets an additional transform that is applied to the entire text paragraph.
setTransform | ( | TransformState const | transform | ) | [inherited] |
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.
setUnderscore | ( | bool | underscore | ) | [inherited] |
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 | ( | float | underscore_height | ) | [inherited] |
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().
setUnexpectedChange | ( | unsigned int | flags | ) | [inherited] |
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.
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().
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 | ( | GraphicsOutput | window | ) |
Sets up the frame rate meter to create a DisplayRegion to render itself into the indicated window.
setUsageHint | ( | UsageHint | usage_hint | ) | [inherited] |
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 | ( | float | wordwrap | ) | [inherited] |
Sets the text up to automatically wordwrap when it exceeds the indicated width.
This can be thought of as a right margin or margin width.
Reimplemented from TextProperties.
setWtext | ( | string | wtext | ) | [inherited] |
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.
Reimplemented from TextEncoder.
stashChild | ( | int | child_index | ) | [inherited] |
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 can only be called from the top pipeline stage (i.e. from App).
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).
bool stashChild | ( | PandaNode | child_node | ) | [inherited] |
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).
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 can only be called from the top pipeline stage (i.e. from App).
Moves all the children from the other node onto this node.
Any NodePaths to child nodes of the other node are truncated, rather than moved to the new parent.
stealChildren | ( | PandaNode | other | ) | [inherited] |
Moves all the children from the other node onto this node.
Any NodePaths to child nodes of the other node are truncated, rather than moved to the new parent.
bool testRefCountIntegrity | ( | ) | [inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
bool testRefCountNonzero | ( | ) | [inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
static bool unicodeIsalpha | ( | int | character | ) | [static, inherited] |
Returns true if the indicated character is an alphabetic letter, false otherwise.
This is akin to ctype's isalpha(), extended to Unicode.
static bool unicodeIsdigit | ( | int | character | ) | [static, inherited] |
Returns true if the indicated character is a numeric digit, false otherwise.
This is akin to ctype's isdigit(), extended to Unicode.
static bool unicodeIslower | ( | int | character | ) | [static, inherited] |
Returns true if the indicated character is a lowercase letter, false otherwise.
This is akin to ctype's islower(), extended to Unicode.
static bool unicodeIspunct | ( | int | character | ) | [static, inherited] |
Returns true if the indicated character is a punctuation mark, false otherwise.
This is akin to ctype's ispunct(), extended to Unicode.
static bool unicodeIsspace | ( | int | character | ) | [static, inherited] |
Returns true if the indicated character is a whitespace letter, false otherwise.
This is akin to ctype's isspace(), extended to Unicode.
static bool unicodeIsupper | ( | int | character | ) | [static, inherited] |
Returns true if the indicated character is an uppercase letter, false otherwise.
This is akin to ctype's isupper(), extended to Unicode.
Returns the uppercase equivalent of the given Unicode character.
This is akin to ctype's tolower(), extended to Unicode.
Returns the uppercase equivalent of the given Unicode character.
This is akin to ctype's toupper(), extended to Unicode.
bool unref | ( | ) | [inherited] |
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().
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.
Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.
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).
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 can only be called from the top pipeline stage (i.e. from App).
unstashChild | ( | int | stashed_index | ) | [inherited] |
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 can only be called from the top pipeline stage (i.e. from App).
bool unstashChild | ( | PandaNode | child_node | ) | [inherited] |
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).
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.
Reimplemented from TextNode.
static string upper | ( | string | source | ) | [static, inherited] |
Converts the string to uppercase, assuming the string is encoded in the default encoding.
static string upper | ( | string | source, |
Encoding | encoding | ||
) | [static, inherited] |
Converts the string to uppercase, assuming the string is encoded in the indicated encoding.
write | ( | ostream | out | ) | [inherited] |
Reimplemented from TextProperties.
BitMaskunsigned int [static, inherited] |
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.
Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below.
Returns the subset of CollideMask bits that may be set for this particular type of PandaNode.
Returns the "into" collide mask for this node.
Returns the union of all draw_show_mask values--of renderable nodes only--at this level and below.
Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited.
Returns the hide/show bits of this particular node.
Returns a DrawMask that is appropriate for rendering to all cameras.
See adjust_draw_mask().
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.
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.
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.
Reimplemented in CollisionNode, CollisionNode, Camera, GeomNode, and PortalNode.
BitMaskunsigned int [inherited] |
Returns the set of bits in draw_show_mask that are considered meaningful.
Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below.
Returns the subset of CollideMask bits that may be set for this particular type of PandaNode.
Returns the "into" collide mask for this node.
Returns the union of all draw_show_mask values--of renderable nodes only--at this level and below.
Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited.
Returns the hide/show bits of this particular node.
See adjust_draw_mask().
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.
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.
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.
Reimplemented in CollisionNode, CollisionNode, Camera, GeomNode, and PortalNode.