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

An encapsulation of a font; i.e. a set of glyphs that may be assembled together by a TextNode to represent a string of text. More...

Inheritance diagram for TextFont:
TypedReferenceCount Namable TypedObject ReferenceCount MemoryBase MemoryBase MemoryBase DynamicTextFont StaticTextFont

Public Types

enum  RenderMode {
  RM_texture = 0, RM_wireframe = 1, RM_polygon = 2, RM_extruded = 3,
  RM_solid = 4, RM_invalid = 5
}
 
enum  WindingOrder { WO_default = 0, WO_left = 1, WO_right = 2, WO_invalid = 3 }
 

Public Member Functions

const TextGlyph getGlyph (int character)
 Gets the glyph associated with the given character code, as well as an optional scaling parameter that should be applied to the glyph's geometry and advance parameters. Returns the glyph on success. On failure, it may still return a printable glyph, or it may return NULL. More...
 
float getLineHeight ()
 Returns the number of units high each line of text is. More...
 
float getSpaceAdvance ()
 Returns the number of units wide a space is. More...
 
bool isValid ()
 Returns true if the font is valid and ready to use, false otherwise. More...
 
TextFont makeCopy ()
 
 setLineHeight (float line_height)
 Changes the number of units high each line of text is. More...
 
 setSpaceAdvance (float space_advance)
 Changes the number of units wide a space is. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable copy)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namable operator= (const Namable other)
 
 output (Ostream out)
 Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
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 ()
 

Detailed Description

An encapsulation of a font; i.e. a set of glyphs that may be assembled together by a TextNode to represent a string of text.

This is just an abstract interface; see StaticTextFont or DynamicTextFont for an actual implementation.

Member Enumeration Documentation

◆ RenderMode

enum RenderMode
Enumerator
RM_texture 

Each glyph is a single textured rectangle.

RM_wireframe 

Each glyph is a lot of line segments.

RM_polygon 

Each glyph is a lot of triangles.

RM_extruded 

a 3-D outline, like a cookie cutter

RM_solid 

combination of RM_extruded and RM_polygon

RM_invalid 

Returned by string_render_mode() for an invalid match.

◆ WindingOrder

Enumerator
WO_default 
WO_left 
WO_right 
WO_invalid 

Member Function Documentation

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getGlyph()

const TextGlyph getGlyph ( int  character)

Gets the glyph associated with the given character code, as well as an optional scaling parameter that should be applied to the glyph's geometry and advance parameters. Returns the glyph on success. On failure, it may still return a printable glyph, or it may return NULL.

◆ getLineHeight()

float getLineHeight ( )

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

◆ getSpaceAdvance()

float getSpaceAdvance ( )

Returns the number of units wide a space is.

◆ isValid()

bool isValid ( )

Returns true if the font is valid and ready to use, false otherwise.

◆ makeCopy()

TextFont makeCopy ( )

◆ setLineHeight()

setLineHeight ( float  line_height)

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

◆ setSpaceAdvance()

setSpaceAdvance ( float  space_advance)

Changes the number of units wide a space is.

◆ write()

write ( Ostream  out,
int  indent_level 
)