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

An encapsulation of a font; i.e. More...

Inheritance diagram for TextFont:
TypedReferenceCount Namable TypedObject ReferenceCount DynamicTextFont StaticTextFont

Public Types

enum  RenderMode {
  RM_texture = 0, RM_wireframe = 1, RM_polygon = 2, RM_extruded = 3,
  RM_solid = 4, RM_distance_field = 5, RM_invalid = 6
}
 

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. More...
 
float getKerning (int first, int second)
 Returns the amount by which to offset the second glyph when it directly follows the first glyph. 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 ()
 
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)
 

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

Public Attributes

float line_height
 Returns the number of units high each line of text is. More...
 
float space_advance
 Returns the number of units wide a space is. More...
 
bool valid
 Returns true if the font is valid and ready to use, false otherwise. 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
 

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_distance_field 
RM_invalid 

Returned by string_render_mode() for an invalid match.

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.

◆ getKerning()

float getKerning ( int  first,
int  second 
)

Returns the amount by which to offset the second glyph when it directly follows the first glyph.

This is an additional offset that is added on top of the advance.

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

Member Data Documentation

◆ line_height

float line_height

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

◆ space_advance

float space_advance

Returns the number of units wide a space is.

◆ valid

bool valid

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