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

The primary interface to this module. More...

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

Public Types

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

Public Member Functions

 __init__ (str name)
 
 __init__ (str name, const TextProperties copy)
 It's sort of a copy constructor: it copies the indicated TextProperties, without copying a complete TextNode. More...
 
float calcWidth (str line)
 Returns the width of a line of text of arbitrary characters. More...
 
float calcWidth (str line)
 Returns the width of a line of text of arbitrary characters. More...
 
float calcWidth (wchar_t character)
 Returns the width of a single character of the font, or 0.0 if the character is not known. More...
 
 clearAlign ()
 
 clearBin ()
 Removes the effect of a previous call to set_bin(). More...
 
 clearCard ()
 Specifies that a card will not be drawn behind the text. More...
 
 clearCardBorder ()
 
 clearCardTexture ()
 
 clearDrawOrder ()
 
 clearFont ()
 Resets the font to the default font. More...
 
 clearFrame ()
 Specifies that a border will not be drawn around the text. More...
 
 clearGlyphScale ()
 
 clearGlyphShift ()
 
 clearIndent ()
 
 clearMaxRows ()
 Resets the TextNode's default behavior of not limiting the number of rows of text. More...
 
 clearShadow ()
 Specifies that a shadow will not be drawn behind the text. More...
 
 clearShadowColor ()
 
 clearSlant ()
 
 clearSmallCaps ()
 
 clearSmallCapsScale ()
 
 clearTabWidth ()
 
 clearTextColor ()
 Removes the text color specification; the text will be colored whatever it was in the source font file. More...
 
 clearWordwrap ()
 Removes the wordwrap setting from the TextNode. More...
 
 forceUpdate ()
 Forces the TextNode to recompute itself now, even if it believes nothing has changed. More...
 
PandaNode generate ()
 Generates the text, according to the parameters indicated within the TextNode, and returns a Node that may be parented within the tree to represent it. More...
 
float getBottom ()
 Returns the bottommost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
LVecBase4 getCardActual ()
 Returns the actual dimensions of the card around the text. More...
 
LVecBase4 getCardAsSet ()
 Returns the dimensions of the card as set by set_card_as_margin() or set_card_actual(). More...
 
float getCardBorderSize ()
 
float getCardBorderUvPortion ()
 
LColor getCardColor ()
 
bool getCardDecal ()
 Returns the card_decal flag. More...
 
Texture getCardTexture ()
 
LVecBase4 getCardTransformed ()
 Returns the actual card dimensions, transformed by the matrix set by set_transform(). More...
 
CoordinateSystem getCoordinateSystem ()
 
int getFlattenFlags ()
 Returns the flatten flags. More...
 
LVecBase4 getFrameActual ()
 Returns the actual dimensions of the frame around the text. More...
 
LVecBase4 getFrameAsSet ()
 Returns the dimensions of the frame as set by set_frame_as_margin() or set_frame_actual(). More...
 
LColor getFrameColor ()
 
bool getFrameCorners ()
 
float getFrameLineWidth ()
 Returns the thickness of the lines that will be used to draw the frame. More...
 
float getHeight ()
 Returns the net height of the text in local 2-d coordinates. More...
 
PandaNode getInternalGeom ()
 Returns the actual node that is used internally to render the text, if the TextNode is parented within the scene graph. More...
 
float getLeft ()
 Returns the leftmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
float getLineHeight ()
 Returns the number of units high each line of text is. More...
 
LPoint3 getLowerRight3d ()
 Returns the lower-right extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix. More...
 
int getMaxRows ()
 Returns the limit on the height of the TextNode specified by set_max_rows(). More...
 
int getNumRows ()
 Returns the number of rows of text that were generated. More...
 
float getRight ()
 Returns the rightmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
float getTop ()
 Returns the topmost extent of the text in local 2-d coordinates, unmodified by the set_transform() matrix. More...
 
LMatrix4 getTransform ()
 
LPoint3 getUpperLeft3d ()
 Returns the upper-left extent of the text object, after it has been transformed into 3-d space by applying the set_transform() matrix. More...
 
GeomEnums::UsageHint getUsageHint ()
 Returns the UsageHint that will be applied to generated geometry. More...
 
float getWidth ()
 Returns the net width of the text in local 2-d coordinates. More...
 
str getWordwrappedText ()
 Returns a string that represents the contents of the text, as it has been formatted by wordwrap rules. More...
 
str getWordwrappedWtext ()
 Returns a wstring that represents the contents of the text, as it has been formatted by wordwrap rules. More...
 
bool hasCard ()
 
bool hasCardBorder ()
 
bool hasCardTexture ()
 
bool hasCharacter (wchar_t character)
 Returns true if the named character exists in the font or can be synthesized by Panda, false otherwise. More...
 
bool hasExactCharacter (wchar_t character)
 Returns true if the named character exists in the font exactly as named, false otherwise. More...
 
bool hasFrame ()
 
bool hasMaxRows ()
 Returns true if a limit on the height of the TextNode has been set via set_max_rows(), false otherwise. More...
 
bool hasOverflow ()
 Returns true if the last text set on the text node exceeded the max_rows constraint, or false if it all fit. More...
 
bool isCardAsMargin ()
 If this is true, the card was set via a call to set_card_as_margin(), and the dimension of the card as returned by get_card_as_set() represent a margin all around the text. More...
 
bool isFrameAsMargin ()
 If this is true, the frame was set via a call to set_frame_as_margin(), and the dimension of the frame as returned by get_frame_as_set() represent a margin all around the text. More...
 
bool isWhitespace (wchar_t character)
 Returns true if the indicated character represents whitespace in the font, or false if anything visible will be rendered for it. More...
 
 output (Ostream out)
 
 setAlign (TextProperties::Alignment align_type)
 
 setBin (str bin)
 Names the GeomBin that the TextNode geometry should be assigned to. More...
 
 setCardActual (float left, float right, float bottom, float top)
 Similar to set_card_as_margin, except the card is specified in actual coordinate units (relative to the text's origin), irrespective of the size of the text. More...
 
 setCardAsMargin (float left, float right, float bottom, float top)
 Specifies that a (possibly opaque or semitransparent) card will be held behind the text when it is next created. More...
 
 setCardBorder (float size, float uv_portion)
 
 setCardColor (const LColor card_color)
 
 setCardColor (float r, float g, float b, float a)
 
 setCardDecal (bool card_decal)
 Sets the card_decal flag. More...
 
 setCardTexture (Texture card_texture)
 
 setCoordinateSystem (CoordinateSystem cs)
 Specifies the coordinate system in which the text will be generated. More...
 
int setDrawOrder (int draw_order)
 Sets the drawing order of text created by the TextMaker. More...
 
 setFlattenFlags (int flatten_flags)
 Sets the flatten flags. More...
 
 setFont (TextFont font)
 Sets the font that will be used when making text. More...
 
 setFrameActual (float left, float right, float bottom, float top)
 Similar to set_frame_as_margin, except the frame is specified in actual coordinate units (relative to the text's origin), irrespective of the size of the text. More...
 
 setFrameAsMargin (float left, float right, float bottom, float top)
 Specifies that a border will be drawn around the text when it is next created. More...
 
 setFrameColor (const LColor frame_color)
 
 setFrameColor (float r, float g, float b, float a)
 
 setFrameCorners (bool corners)
 Enables or disables the drawing of corners for the frame. More...
 
 setFrameLineWidth (float line_width)
 Specifies the thickness of the lines that will be used to draw the frame. More...
 
 setGlyphScale (float glyph_scale)
 Specifies the factor by which to scale each letter of the text as it is placed. More...
 
 setGlyphShift (float glyph_shift)
 Specifies a vertical amount to shift each letter of the text as it is placed. More...
 
 setIndent (float indent)
 Specifies the amount of extra space that is inserted before the first character of each line. More...
 
 setMaxRows (int max_rows)
 Sets the maximum number of rows that may be formatted by the TextNode. More...
 
 setShadow (const LVecBase2 shadow_offset)
 Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first. More...
 
 setShadow (float xoffset, float yoffset)
 Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first. More...
 
 setShadowColor (const LColor shadow_color)
 
 setShadowColor (float r, float g, float b, float a)
 
 setSlant (float slant)
 
 setSmallCaps (bool small_caps)
 Sets the small_caps flag. More...
 
 setSmallCapsScale (float small_caps_scale)
 Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. More...
 
 setTabWidth (float tab_width)
 Sets the width of each tab stop, in screen units. More...
 
 setTextColor (const LColor text_color)
 
 setTextColor (float r, float g, float b, float a)
 
 setTransform (const LMatrix4 transform)
 Sets an additional transform that is applied to the entire text paragraph. More...
 
 setUsageHint (GeomEnums::UsageHint usage_hint)
 Specifies the UsageHint that will be applied to generated geometry. More...
 
 setWordwrap (float wordwrap)
 Sets the text up to automatically wordwrap when it exceeds the indicated width. More...
 
 update ()
 Can be called after the TextNode has been fully configured, to force the node to recompute its text immediately, rather than waiting for it to be drawn. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from PandaNode
PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
int __traverse__ (Visitproc visit, void arg)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node, directly as a stashed child. More...
 
 adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
Light asLight ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
 clearAttrib (TypeHandle type)
 Removes the render attribute of the given type from this node. More...
 
 clearAttrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
 clearBounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
 clearEffect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
 clearEffects (Thread current_thread)
 Resets this node to have no render effects. More...
 
 clearPythonTag (object key)
 
 clearState (Thread current_thread)
 Resets this node to leave the render state alone. More...
 
 clearTag (str key, Thread current_thread)
 Removes the value defined for this key on this particular node. More...
 
 clearTransform (Thread current_thread)
 Resets the transform on this node to the identity transform. More...
 
 clearUnexpectedChange (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
PandaNode combineWith (PandaNode other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compareTags (const PandaNode other)
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
 copyAllProperties (PandaNode other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
 copyChildren (PandaNode other, Thread current_thread)
 Makes another instance of all the children of the other node, copying them to this node. More...
 
PandaNode copySubgraph (Thread current_thread)
 Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. More...
 
 copyTags (PandaNode other)
 Copies all of the tags stored on the other node onto this node. More...
 
int countNumDescendants ()
 Returns the number of nodes at and below this level. More...
 
int findChild (PandaNode node, Thread current_thread)
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int findParent (PandaNode node, Thread current_thread)
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int findStashed (PandaNode node, Thread current_thread)
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
const RenderAttrib getAttrib (TypeHandle type)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderAttrib getAttrib (int slot)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const BoundingVolume getBounds (Thread current_thread)
 Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes. More...
 
const BoundingVolume getBounds (UpdateSeq seq, Thread current_thread)
 This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. More...
 
BoundingVolume::BoundsType getBoundsType ()
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode getChild (int n, Thread current_thread)
 Returns the nth child node of this node. More...
 
list getChildren ()
 
int getChildSort (int n, Thread current_thread)
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. More...
 
const RenderEffect getEffect (TypeHandle type)
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderEffects getEffects (Thread current_thread)
 Returns the complete RenderEffects that will be applied to this node. More...
 
int getFancyBits (Thread current_thread)
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 Returns the node's internal bounding volume. More...
 
int getInternalVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask getIntoCollideMask ()
 Returns the "into" collide mask for this node. More...
 
CollideMask getLegalCollideMask ()
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int getNestedVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask getNetCollideMask (Thread current_thread)
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask getNetDrawControlMask ()
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask getNetDrawShowMask ()
 Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below. More...
 
int getNumChildren (Thread current_thread)
 Returns the number of child nodes this node has. More...
 
int getNumParents (Thread current_thread)
 Returns the number of parent nodes this node has. More...
 
int getNumStashed (Thread current_thread)
 Returns the number of stashed nodes this node has. More...
 
const RenderAttrib getOffClipPlanes (Thread current_thread)
 Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More...
 
PandaNode getParent (int n, Thread current_thread)
 Returns the nth parent node of this node. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. More...
 
object getPythonTag (object key)
 
object getPythonTagKeys ()
 
object getPythonTags ()
 
PandaNode::Stashed getStashed (Thread current_thread)
 Returns an object that can be used to walk through the list of children of the node. More...
 
PandaNode getStashed (int n, Thread current_thread)
 Returns the nth stashed child of this node. More...
 
list getStashed ()
 
int getStashedSort (int n, Thread current_thread)
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
const RenderState getState (Thread current_thread)
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
str getTag (str key, Thread current_thread)
 Retrieves the user-defined value that was previously set on this node for the particular key, if any. More...
 
object getTagKeys ()
 
const TransformState getTransform (Thread current_thread)
 Returns the transform that has been set on this particular node. More...
 
unsigned int getUnexpectedChange (unsigned int flags)
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
bool hasAttrib (TypeHandle type)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasAttrib (int slot)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasDirtyPrevTransform ()
 Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). More...
 
bool hasEffect (TypeHandle type)
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
bool hasPythonTag (object key)
 
bool hasTag (str key, Thread current_thread)
 Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More...
 
bool hasTags ()
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
bool isAmbientLight ()
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool isBoundsStale ()
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
bool isCollisionNode ()
 A simple downcast check. More...
 
bool isFinal (Thread current_thread)
 Returns the current state of the "final" flag. More...
 
bool isGeomNode ()
 A simple downcast check. More...
 
bool isLodNode ()
 A simple downcast check. More...
 
bool isOverallHidden ()
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool isSceneRoot ()
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool isUnderSceneRoot ()
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
 listTags (Ostream out, str separator)
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
 ls (Ostream out, int indent_level)
 Lists all the nodes at and below the current path hierarchically. More...
 
PandaNode makeCopy ()
 Returns a newly-allocated PandaNode that is a shallow copy of this one. More...
 
 markBoundsStale (Thread current_thread)
 Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More...
 
 markInternalBoundsStale (Thread current_thread)
 Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More...
 
 output (Ostream out)
 
 prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. More...
 
 removeAllChildren (Thread current_thread)
 Removes all the children from the node at once, including stashed children. More...
 
bool removeChild (PandaNode child_node, Thread current_thread)
 Removes the indicated child from the node. More...
 
 removeChild (int child_index, Thread current_thread)
 Removes the nth child from the node. More...
 
 removeStashed (int child_index, Thread current_thread)
 Removes the nth stashed child from the node. More...
 
bool replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread)
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
 replaceNode (PandaNode other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
 resetPrevTransform (Thread current_thread)
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 Adds the indicated render attribute to the scene graph on this node. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. More...
 
 setBounds (const BoundingVolume volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
 setEffect (const RenderEffect effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 Sets the complete RenderEffects that will be applied this node. More...
 
 setFinal (bool flag)
 Sets the "final" flag on this PandaNode. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
 setPrevTransform (const TransformState transform, Thread current_thread)
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
 setPythonTag (object key, object value)
 
 setState (const RenderState state, Thread current_thread)
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
 setTag (str key, str value, Thread current_thread)
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 Sets the transform that will be applied to this node and below. More...
 
 setUnexpectedChange (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stashChild (PandaNode child_node, Thread current_thread)
 Stashes the indicated child node. More...
 
 stashChild (int child_index, Thread current_thread)
 Stashes the indicated child node. More...
 
 stealChildren (PandaNode other, Thread current_thread)
 Moves all the children from the other node onto this node. More...
 
bool unstashChild (PandaNode child_node, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 
- Public Member Functions inherited from TextEncoder
 __init__ ()
 
 __init__ (const TextEncoder copy)
 
 appendText (object text)
 
 appendUnicodeChar (char32_t character)
 Appends a single character to the end of the stored text. More...
 
 appendWtext (str text)
 Appends the indicates string to the end of the stored wide-character text. More...
 
 clearText ()
 Removes the text from the TextEncoder. More...
 
object decodeText (object text)
 
object encodeWtext (str wtext)
 Encodes a wide-text string into a single-char string, according to the current encoding. More...
 
str getEncodedChar (int index)
 Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. More...
 
str getEncodedChar (int index, TextEncoder::Encoding encoding)
 Returns the nth char of the stored text, as a one-, two-, or three-byte encoded string. More...
 
TextEncoder::Encoding getEncoding ()
 Returns the encoding by which the string set via set_text() is to be interpreted. More...
 
int getNumChars ()
 Returns the number of characters in the stored text. More...
 
object getText ()
 Returns the current text, as encoded via the current encoding system. More...
 
object getText (TextEncoder::Encoding encoding)
 Returns the current text, as encoded via the indicated encoding system. More...
 
str getTextAsAscii ()
 Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. More...
 
int getUnicodeChar (int index)
 Returns the Unicode value of the nth character in the stored text. More...
 
str getWtext ()
 Returns the text associated with the TextEncoder, as a wide-character string. More...
 
str getWtextAsAscii ()
 Returns the text associated with the node, converted as nearly as possible to a fully-ASCII representation. More...
 
bool hasText ()
 
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()). More...
 
 makeLower ()
 Adjusts the text stored within the encoder to all lowercase letters (preserving accent marks correctly). More...
 
 makeUpper ()
 Adjusts the text stored within the encoder to all uppercase letters (preserving accent marks correctly). More...
 
 setEncoding (TextEncoder::Encoding encoding)
 Specifies how the string set via set_text() is to be interpreted. More...
 
 setText (object text)
 
 setText (object text, TextEncoder::Encoding encoding)
 
 setUnicodeChar (int index, char32_t character)
 Sets the Unicode value of the nth character in the stored text. More...
 
 setWtext (str wtext)
 Changes the text that is stored in the encoder. More...
 
- Public Member Functions inherited from TextProperties
 __init__ ()
 
 __init__ (const TextProperties copy)
 
 addProperties (const TextProperties other)
 Sets any properties that are explicitly specified in other on this object. More...
 
 clear ()
 Unsets all properties that have been specified so far, and resets the TextProperties structure to its initial empty state. More...
 
 clearAlign ()
 Restores the default alignment of the text. More...
 
 clearBin ()
 Removes the effect of a previous call to set_bin(). More...
 
 clearDirection ()
 Clears the text direction setting. More...
 
 clearDrawOrder ()
 
 clearFont ()
 Restores the default font to the text. More...
 
 clearGlyphScale ()
 
 clearGlyphShift ()
 
 clearIndent ()
 Removes the indent setting from the text. More...
 
 clearPreserveTrailingWhitespace ()
 
 clearShadow ()
 Specifies that a shadow will not be drawn behind the text. More...
 
 clearShadowColor ()
 Removes the shadow color specification. More...
 
 clearSlant ()
 
 clearSmallCaps ()
 
 clearSmallCapsScale ()
 
 clearTabWidth ()
 
 clearTextColor ()
 Removes the text color specification; the text will be colored whatever it was in the source font file. More...
 
 clearTextScale ()
 
 clearUnderscore ()
 
 clearUnderscoreHeight ()
 
 clearWordwrap ()
 Removes the wordwrap setting from the text. More...
 
TextProperties::Alignment getAlign ()
 
str getBin ()
 Returns the drawing bin set with set_bin(), or empty string if no bin has been set. More...
 
TextProperties::Direction getDirection ()
 Returns the direction of the text as specified by set_direction(). More...
 
int getDrawOrder ()
 Returns the drawing order set with set_draw_order(). More...
 
TextFont getFont ()
 Returns the font currently in use, if any. More...
 
float getGlyphScale ()
 Returns the scale factor of each letter as specified by set_glyph_scale(). More...
 
float getGlyphShift ()
 Returns the vertical shift of each letter as specified by set_glyph_shift(). More...
 
float getIndent ()
 
bool getPreserveTrailingWhitespace ()
 Returns the preserve_trailing_whitespace flag. More...
 
LVector2 getShadow ()
 Returns the offset of the shadow as set by set_shadow(). More...
 
LColor getShadowColor ()
 
float getSlant ()
 Returns the factor by which the text is specified to slant to the right. More...
 
bool getSmallCaps ()
 Returns the small_caps flag. More...
 
float getSmallCapsScale ()
 Returns the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. More...
 
float getTabWidth ()
 Returns the width set via set_tab_width(). More...
 
LColor getTextColor ()
 
float getTextScale ()
 Returns the scale factor of the text as specified by set_text_scale(). More...
 
bool getUnderscore ()
 Returns the underscore flag. More...
 
float getUnderscoreHeight ()
 Returns the vertical height of the underscore; see set_underscore_height(). More...
 
float getWordwrap ()
 
bool hasAlign ()
 
bool hasBin ()
 Returns true if an explicit drawing bin has been set via set_bin(), false otherwise. More...
 
bool hasDirection ()
 
bool hasDrawOrder ()
 
bool hasFont ()
 
bool hasGlyphScale ()
 
bool hasGlyphShift ()
 
bool hasIndent ()
 
bool hasPreserveTrailingWhitespace ()
 
bool hasShadow ()
 
bool hasShadowColor ()
 
bool hasSlant ()
 
bool hasSmallCaps ()
 
bool hasSmallCapsScale ()
 
bool hasTabWidth ()
 
bool hasTextColor ()
 
bool hasTextScale ()
 
bool hasUnderscore ()
 
bool hasUnderscoreHeight ()
 
bool hasWordwrap ()
 
bool isAnySpecified ()
 Returns true if any properties have been specified, false otherwise. More...
 
bool operator != (const TextProperties other)
 
TextProperties operator= (const TextProperties copy)
 
bool operator== (const TextProperties other)
 
 setAlign (TextProperties::Alignment align_type)
 Specifies the alignment of the text within its margins. More...
 
 setBin (str bin)
 Names the CullBin that the text geometry should be assigned to. More...
 
 setDirection (TextProperties::Direction direction)
 Specifies the text direction. More...
 
int setDrawOrder (int draw_order)
 Sets the drawing order of text created by the TextNode. More...
 
 setFont (TextFont font)
 Sets the font that will be used when making text. More...
 
 setGlyphScale (float glyph_scale)
 Specifies the factor by which to scale each letter of the text as it is placed, in addition to any scales inherited from the node or from set_text_scale(). More...
 
 setGlyphShift (float glyph_shift)
 Specifies a vertical amount to shift each letter of the text as it is placed. More...
 
 setIndent (float indent)
 Specifies the amount of extra space that is inserted before the first character of each line. More...
 
 setPreserveTrailingWhitespace (bool preserve_trailing_whitespace)
 Sets the preserve_trailing_whitespace flag. More...
 
 setShadow (const LVecBase2 shadow_offset)
 Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first. More...
 
 setShadow (float xoffset, float yoffset)
 Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first. More...
 
 setShadowColor (const LColor shadow_color)
 
 setShadowColor (float r, float g, float b, float a)
 
 setSlant (float slant)
 Specifies the factor by which the text slants to the right. More...
 
 setSmallCaps (bool small_caps)
 Sets the small_caps flag. More...
 
 setSmallCapsScale (float small_caps_scale)
 Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. More...
 
 setTabWidth (float tab_width)
 Sets the width of each tab stop, in screen units. More...
 
 setTextColor (const LColor text_color)
 
 setTextColor (float r, float g, float b, float a)
 
 setTextScale (float text_scale)
 Specifies the factor by which to scale the text, in addition to any scalings imposed by the node, as well as in addition to the glyph scale. More...
 
 setUnderscore (bool underscore)
 Sets the underscore flag. More...
 
 setUnderscoreHeight (float underscore_height)
 Specifies the vertical height of the underscore, relative to the text baseline. More...
 
 setWordwrap (float wordwrap)
 Sets the text up to automatically wordwrap when it exceeds the indicated width. More...
 
 write (Ostream out, int indent_level)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from PandaNode
static PandaNode decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static DrawMask getAllCameraMask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle getClassType ()
 
static DrawMask getOverallBit ()
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
static resetAllPrevTransform (Thread current_thread)
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TextEncoder
static object decodeText (object text, TextEncoder::Encoding encoding)
 
static object encodeWchar (char32_t ch, TextEncoder::Encoding encoding)
 Encodes a single Unicode character into a one-, two-, three-, or four-byte string, according to the given encoding system. More...
 
static object encodeWtext (str wtext, TextEncoder::Encoding encoding)
 Encodes a wide-text string into a single-char string, according to the given encoding. More...
 
static TextEncoder::Encoding getDefaultEncoding ()
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. More...
 
static str lower (str source)
 Converts the string to lowercase, assuming the string is encoded in the default encoding. More...
 
static str lower (str source, TextEncoder::Encoding encoding)
 Converts the string to lowercase, assuming the string is encoded in the indicated encoding. More...
 
static str reencodeText (str text, TextEncoder::Encoding from, TextEncoder::Encoding to)
 Given the indicated text string, which is assumed to be encoded via the encoding "from", decodes it and then reencodes it into the encoding "to", and returns the newly encoded string. More...
 
static setDefaultEncoding (TextEncoder::Encoding encoding)
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. More...
 
static bool unicodeIsalpha (char32_t character)
 Returns true if the indicated character is an alphabetic letter, false otherwise. More...
 
static bool unicodeIsdigit (char32_t character)
 Returns true if the indicated character is a numeric digit, false otherwise. More...
 
static bool unicodeIslower (char32_t character)
 Returns true if the indicated character is a lowercase letter, false otherwise. More...
 
static bool unicodeIspunct (char32_t character)
 Returns true if the indicated character is a punctuation mark, false otherwise. More...
 
static bool unicodeIsspace (char32_t character)
 Returns true if the indicated character is a whitespace letter, false otherwise. More...
 
static bool unicodeIsupper (char32_t character)
 Returns true if the indicated character is an uppercase letter, false otherwise. More...
 
static int unicodeTolower (char32_t character)
 Returns the uppercase equivalent of the given Unicode character. More...
 
static int unicodeToupper (char32_t character)
 Returns the uppercase equivalent of the given Unicode character. More...
 
static str upper (str source)
 Converts the string to uppercase, assuming the string is encoded in the default encoding. More...
 
static str upper (str source, TextEncoder::Encoding encoding)
 Converts the string to uppercase, assuming the string is encoded in the indicated encoding. More...
 
- Static Public Member Functions inherited from TextProperties
static TypeHandle getClassType ()
 
static TextFont getDefaultFont ()
 Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. More...
 
static setDefaultFont (TextFont)
 Specifies the default font to be used for any TextNode whose font is uninitialized or NULL. More...
 

Public Attributes

TextProperties::Alignment align
 **

More...
 
const String bin
 ** More...
 
LColor card_color
 
Texture card_texture
 
CoordinateSystem coordinate_system
 
int draw_order
 ** More...
 
int flatten_flags
 Returns the flatten flags. More...
 
TextFont font
 ** More...
 
LColor frame_color
 
bool frame_corners
 
float frame_line_width
 Returns the thickness of the lines that will be used to draw the frame. More...
 
float glyph_scale
 ** More...
 
float glyph_shift
 ** More...
 
float indent
 **

More...
 
int max_rows
 Returns the limit on the height of the TextNode specified by set_max_rows(). More...
 
bool preserve_trailing_whitespace
 ** More...
 
LVector2 shadow
 ** More...
 
LColor shadow_color
 **

More...
 
float slant
 ** More...
 
bool small_caps
 ** More...
 
float small_caps_scale
 ** More...
 
float tab_width
 ** More...
 
LColor text_color
 **

More...
 
float text_scale
 ** More...
 
LMatrix4 transform
 
bool underscore
 ** More...
 
float underscore_height
 ** More...
 
GeomEnums::UsageHint usage_hint
 Returns the UsageHint that will be applied to generated geometry. More...
 
float wordwrap
 **

More...
 
- Public Attributes inherited from PandaNode
DrawMask all_camera_mask
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
bool bounds_stale
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
BoundingVolume::BoundsType bounds_type
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode::Children children
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask draw_control_mask
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask draw_show_mask
 Returns the hide/show bits of this particular node. More...
 
ConstPointerToRenderEffects effects
 Returns the complete RenderEffects that will be applied to this node. More...
 
bool final
 Returns the current state of the "final" flag. More...
 
ConstPointerToBoundingVolume internal_bounds
 Returns the node's internal bounding volume. More...
 
int internal_vertices
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask into_collide_mask
 Returns the "into" collide mask for this node. More...
 
CollideMask legal_collide_mask
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int nested_vertices
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
DrawMask overall_bit
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
bool overall_hidden
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
PandaNode::Parents parents
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
ConstPointerToTransformState prev_transform
 Returns the transform that has been set as this node's "previous" position. More...
 
object python_tags
 
PandaNode::Stashed stashed
 Returns the nth stashed child of this node. More...
 
ConstPointerToRenderState state
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
String tags []
 
ConstPointerToTransformState transform
 Returns the transform that has been set on this particular node. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 
- Public Attributes inherited from Namable
const String name
 
- Public Attributes inherited from TextEncoder
TextEncoder::Encoding default_encoding
 Specifies the default encoding to be used for all subsequently created TextEncoder objects. More...
 
object text
 Returns the current text, as encoded via the current encoding system. More...
 
- Public Attributes inherited from TextProperties
TextProperties::Alignment align
 
const String bin
 Returns the drawing bin set with set_bin(), or empty string if no bin has been set. More...
 
TextProperties::Direction direction
 Returns the direction of the text as specified by set_direction(). More...
 
int draw_order
 Returns the drawing order set with set_draw_order(). More...
 
TextFont font
 Returns the font currently in use, if any. More...
 
float glyph_scale
 Returns the scale factor of each letter as specified by set_glyph_scale(). More...
 
float glyph_shift
 Returns the vertical shift of each letter as specified by set_glyph_shift(). More...
 
float indent
 
bool preserve_trailing_whitespace
 Returns the preserve_trailing_whitespace flag. More...
 
LVector2 shadow
 Returns the offset of the shadow as set by set_shadow(). More...
 
LColor shadow_color
 
float slant
 Returns the factor by which the text is specified to slant to the right. More...
 
bool small_caps
 Returns the small_caps flag. More...
 
float small_caps_scale
 Returns the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect. More...
 
float tab_width
 Returns the width set via set_tab_width(). More...
 
LColor text_color
 
float text_scale
 Returns the scale factor of the text as specified by set_text_scale(). More...
 
bool underscore
 Returns the underscore flag. More...
 
float underscore_height
 Returns the vertical height of the underscore; see set_underscore_height(). More...
 
float wordwrap
 

Detailed Description

The primary interface to this module.

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

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

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

Member Enumeration Documentation

◆ FlattenFlags

Enumerator
FF_none 
FF_light 
FF_medium 
FF_strong 
FF_dynamic_merge 

Member Function Documentation

◆ __init__() [1/2]

__init__ ( str  name)

◆ __init__() [2/2]

__init__ ( str  name,
const TextProperties  copy 
)

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

◆ calcWidth() [1/3]

float calcWidth ( str  line)

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

The line should not include the newline character.

◆ calcWidth() [2/3]

float calcWidth ( str  line)

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

The line should not include the newline character or any embedded control characters like \1 or \3.

◆ calcWidth() [3/3]

float calcWidth ( wchar_t  character)

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

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

◆ clearAlign()

clearAlign ( )

◆ clearBin()

clearBin ( )

Removes the effect of a previous call to set_bin().

Text will be drawn in whatever bin it would like to be drawn in, with no explicit ordering.

◆ clearCard()

clearCard ( )

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

◆ clearCardBorder()

clearCardBorder ( )

◆ clearCardTexture()

clearCardTexture ( )

◆ clearDrawOrder()

clearDrawOrder ( )

◆ clearFont()

clearFont ( )

Resets the font to the default font.

◆ clearFrame()

clearFrame ( )

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

◆ clearGlyphScale()

clearGlyphScale ( )

◆ clearGlyphShift()

clearGlyphShift ( )

◆ clearIndent()

clearIndent ( )

◆ clearMaxRows()

clearMaxRows ( )

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

◆ clearShadow()

clearShadow ( )

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

◆ clearShadowColor()

clearShadowColor ( )

◆ clearSlant()

clearSlant ( )

◆ clearSmallCaps()

clearSmallCaps ( )

◆ clearSmallCapsScale()

clearSmallCapsScale ( )

◆ clearTabWidth()

clearTabWidth ( )

◆ clearTextColor()

clearTextColor ( )

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

◆ clearWordwrap()

clearWordwrap ( )

Removes the wordwrap setting from the TextNode.

Text will be as wide as it is.

◆ forceUpdate()

forceUpdate ( )

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

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

◆ generate()

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.

◆ getBottom()

float getBottom ( )

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

◆ getCardActual()

LVecBase4 getCardActual ( )

Returns the actual dimensions of the card around the text.

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

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

◆ getCardAsSet()

LVecBase4 getCardAsSet ( )

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

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

◆ getCardBorderSize()

float getCardBorderSize ( )

◆ getCardBorderUvPortion()

float getCardBorderUvPortion ( )

◆ getCardColor()

LColor getCardColor ( )

◆ getCardDecal()

bool getCardDecal ( )

Returns the card_decal flag.

See set_card_decal().

◆ getCardTexture()

Texture getCardTexture ( )

◆ getCardTransformed()

LVecBase4 getCardTransformed ( )

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

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

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getCoordinateSystem()

CoordinateSystem getCoordinateSystem ( )

◆ getFlattenFlags()

int getFlattenFlags ( )

Returns the flatten flags.

See set_flatten_flags().

◆ getFrameActual()

LVecBase4 getFrameActual ( )

Returns the actual dimensions of the frame around the text.

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

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

◆ getFrameAsSet()

LVecBase4 getFrameAsSet ( )

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

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

◆ getFrameColor()

LColor getFrameColor ( )

◆ getFrameCorners()

bool getFrameCorners ( )

◆ getFrameLineWidth()

float getFrameLineWidth ( )

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

◆ getHeight()

float getHeight ( )

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

◆ getInternalGeom()

PandaNode getInternalGeom ( )

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

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

◆ getLeft()

float getLeft ( )

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

◆ getLineHeight()

float getLineHeight ( )

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

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

◆ getLowerRight3d()

LPoint3 getLowerRight3d ( )

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

◆ getMaxRows()

int getMaxRows ( )

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

◆ getNumRows()

int getNumRows ( )

Returns the number of rows of text that were generated.

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

◆ getRight()

float getRight ( )

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

◆ getTop()

float getTop ( )

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

◆ getTransform()

LMatrix4 getTransform ( )

◆ getUpperLeft3d()

LPoint3 getUpperLeft3d ( )

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

◆ getUsageHint()

GeomEnums::UsageHint getUsageHint ( )

Returns the UsageHint that will be applied to generated geometry.

See set_usage_hint().

◆ getWidth()

float getWidth ( )

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

◆ getWordwrappedText()

str getWordwrappedText ( )

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

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

◆ getWordwrappedWtext()

str getWordwrappedWtext ( )

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

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

◆ hasCard()

bool hasCard ( )

◆ hasCardBorder()

bool hasCardBorder ( )

◆ hasCardTexture()

bool hasCardTexture ( )

◆ hasCharacter()

bool hasCharacter ( wchar_t  character)

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

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

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

◆ hasExactCharacter()

bool hasExactCharacter ( wchar_t  character)

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

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

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

◆ hasFrame()

bool hasFrame ( )

◆ hasMaxRows()

bool hasMaxRows ( )

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

◆ hasOverflow()

bool hasOverflow ( )

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

◆ isCardAsMargin()

bool isCardAsMargin ( )

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

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

◆ isFrameAsMargin()

bool isFrameAsMargin ( )

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

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

◆ isWhitespace()

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.

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.

◆ output()

output ( Ostream  out)

◆ setAlign()

setAlign ( TextProperties::Alignment  align_type)

◆ setBin()

setBin ( str  bin)

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

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

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

◆ setCardActual()

setCardActual ( float  left,
float  right,
float  bottom,
float  top 
)

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

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

◆ setCardAsMargin()

setCardAsMargin ( float  left,
float  right,
float  bottom,
float  top 
)

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

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

◆ setCardBorder()

setCardBorder ( float  size,
float  uv_portion 
)

◆ setCardColor() [1/2]

setCardColor ( const LColor  card_color)

◆ setCardColor() [2/2]

setCardColor ( float  r,
float  g,
float  b,
float  a 
)

◆ setCardDecal()

setCardDecal ( bool  card_decal)

Sets the card_decal flag.

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

◆ setCardTexture()

setCardTexture ( Texture  card_texture)

◆ setCoordinateSystem()

setCoordinateSystem ( CoordinateSystem  cs)

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

◆ setDrawOrder()

int setDrawOrder ( int  draw_order)

Sets the drawing order of text created by the TextMaker.

This is actually the draw order of the card and frame. The shadow is drawn at _draw_order+1, and the text at _draw_order+2.

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.

◆ setFlattenFlags()

setFlattenFlags ( int  flatten_flags)

Sets the flatten flags.

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

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()

setFont ( TextFont  font)

Sets the font that will be used when making text.

If this is set to NULL, the default font will be used, which can be set via set_default_font().

◆ setFrameActual()

setFrameActual ( float  left,
float  right,
float  bottom,
float  top 
)

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

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

◆ setFrameAsMargin()

setFrameAsMargin ( float  left,
float  right,
float  bottom,
float  top 
)

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

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

◆ setFrameColor() [1/2]

setFrameColor ( const LColor  frame_color)

◆ setFrameColor() [2/2]

setFrameColor ( float  r,
float  g,
float  b,
float  a 
)

◆ setFrameCorners()

setFrameCorners ( bool  corners)

Enables or disables the drawing of corners for the frame.

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

◆ setFrameLineWidth()

setFrameLineWidth ( float  line_width)

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

◆ setGlyphScale()

setGlyphScale ( float  glyph_scale)

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

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

◆ setGlyphShift()

setGlyphShift ( float  glyph_shift)

Specifies a vertical amount to shift each letter of the text as it is placed.

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

◆ setIndent()

setIndent ( float  indent)

Specifies the amount of extra space that is inserted before the first character of each line.

This can be thought of as a left margin.

◆ setMaxRows()

setMaxRows ( int  max_rows)

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

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

◆ setShadow() [1/2]

setShadow ( const LVecBase2  shadow_offset)

Specifies that the text should be drawn with a shadow, by creating a second copy of the text and offsetting it slightly behind the first.

◆ setShadow() [2/2]

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() [1/2]

setShadowColor ( const LColor  shadow_color)

◆ setShadowColor() [2/2]

setShadowColor ( float  r,
float  g,
float  b,
float  a 
)

◆ setSlant()

setSlant ( float  slant)

◆ setSmallCaps()

setSmallCaps ( bool  small_caps)

Sets the small_caps flag.

When this is set, lowercase letters are generated as scaled-down versions of their uppercase equivalents. This is particularly useful to set for fonts that do not have lowercase letters.

It is also a good idea to set this for a (dynamic) font that has already implemented lowercase letters as scaled-down versions of their uppercase equivalents, since without this flag the texture memory may needlessly duplicate equivalent glyphs for upper and lowercase letters. Setting this flag causes the texture memory to share the mixed-case letters.

The amount by which the lowercase letters are scaled is specified by set_small_caps_scale().

◆ setSmallCapsScale()

setSmallCapsScale ( float  small_caps_scale)

Sets the scale factor applied to lowercase letters from their uppercase equivalents, when the small_caps flag is in effect.

See set_small_caps(). Normally, this will be a number less than one.

◆ setTabWidth()

setTabWidth ( float  tab_width)

Sets the width of each tab stop, in screen units.

A tab character embedded in the text will advance the horizontal position to the next tab stop.

◆ setTextColor() [1/2]

setTextColor ( const LColor  text_color)

◆ setTextColor() [2/2]

setTextColor ( float  r,
float  g,
float  b,
float  a 
)

◆ setTransform()

setTransform ( const LMatrix4  transform)

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

◆ setUsageHint()

setUsageHint ( GeomEnums::UsageHint  usage_hint)

Specifies the UsageHint that will be applied to generated geometry.

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

◆ setWordwrap()

setWordwrap ( float  wordwrap)

Sets the text up to automatically wordwrap when it exceeds the indicated width.

This can be thought of as a right margin or margin width.

◆ update()

update ( )

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

This call is optional.

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ align

**

◆ bin

const String bin

**

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

◆ card_color

LColor card_color

◆ card_texture

Texture card_texture

◆ coordinate_system

CoordinateSystem coordinate_system

◆ draw_order

int draw_order

**

  • Returns the drawing order set with set_draw_order().

◆ flatten_flags

int flatten_flags

Returns the flatten flags.

See set_flatten_flags().

◆ font

TextFont font

**

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

◆ frame_color

LColor frame_color

◆ frame_corners

bool frame_corners

◆ frame_line_width

float frame_line_width

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

◆ glyph_scale

float glyph_scale

**

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

◆ glyph_shift

float glyph_shift

**

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

◆ indent

float indent

**

◆ max_rows

int max_rows

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

◆ preserve_trailing_whitespace

bool preserve_trailing_whitespace

**

  • Returns the preserve_trailing_whitespace flag. See
  • set_preserve_trailing_whitespace().

◆ shadow

LVector2 shadow

**

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

◆ shadow_color

LColor shadow_color

**

◆ slant

float slant

**

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

◆ small_caps

bool small_caps

**

  • Returns the small_caps flag. See set_small_caps().

◆ small_caps_scale

float small_caps_scale

**

  • 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().

◆ tab_width

float tab_width

**

  • Returns the width set via set_tab_width().

◆ text_color

LColor text_color

**

◆ text_scale

float text_scale

**

  • Returns the scale factor of the text as specified by set_text_scale().

◆ transform

LMatrix4 transform

◆ underscore

bool underscore

**

  • Returns the underscore flag. See set_underscore().

◆ underscore_height

float underscore_height

**

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

◆ usage_hint

Returns the UsageHint that will be applied to generated geometry.

See set_usage_hint().

◆ wordwrap

float wordwrap

**