Panda3D
Public Types | Public Member Functions | Static Public Member Functions

StaticTextFont Class Reference

A StaticTextFont is loaded up from a model that was previously generated via egg-mkfont, and contains all of its glyphs already generated and available for use. More...

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

List of all members.

Public Types

enum  RenderMode {
  RMTexture = 0, RMWireframe = 1, RMPolygon = 2, RMExtruded = 3,
  RMSolid = 4, RMInvalid = 5
}
enum  WindingOrder { WODefault = 0, WOLeft = 1, WORight = 2, WOInvalid = 3 }

Public Member Functions

 StaticTextFont (PandaNode font_def)
 The constructor expects the root node to a model generated via egg-mkfont, which consists of a set of models, one per each character in the font.
 clearName ()
 Resets the Namable's name to empty.
float getLineHeight ()
 Returns the number of units high each line of text is.
string getName ()
int getRefCount ()
 Returns the current reference count.
float getSpaceAdvance ()
 Returns the number of units wide a space is.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
bool isValid ()
 Returns true if the font is valid and ready to use, false otherwise.
TextFont makeCopy ()
 output (ostream out)
 Outputs the Namable.
 ref ()
 Explicitly increments the reference count.
 setLineHeight (float line_height)
 Changes the number of units high each line of text is.
 setName (string name)
 setSpaceAdvance (float space_advance)
 Changes the number of units wide a space is.
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.
 write (ostream out, int indent_level)

Static Public Member Functions

static TypeHandle getClassType ()

Detailed Description

A StaticTextFont is loaded up from a model that was previously generated via egg-mkfont, and contains all of its glyphs already generated and available for use.

It doesn't require linking with any external libraries like FreeType.


Member Enumeration Documentation

enum RenderMode [inherited]
Enumerator:
RMTexture 
RMWireframe 
RMPolygon 
RMExtruded 
RMSolid 
RMInvalid 
enum WindingOrder [inherited]
Enumerator:
WODefault 
WOLeft 
WORight 
WOInvalid 

Constructor & Destructor Documentation

StaticTextFont ( PandaNode  font_def)

The constructor expects the root node to a model generated via egg-mkfont, which consists of a set of models, one per each character in the font.


Member Function Documentation

clearName ( ) [inherited]

Resets the Namable's name to empty.

Reimplemented in AsyncTask.

static TypeHandle getClassType ( ) [static]

Reimplemented from TextFont.

float getLineHeight ( ) [inherited]

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

Reimplemented in DynamicTextFont.

string getName ( ) [inherited]

Reimplemented in DynamicTextFont.

int getRefCount ( ) [inherited]

Returns the current reference count.

float getSpaceAdvance ( ) [inherited]

Returns the number of units wide a space is.

Reimplemented in DynamicTextFont.

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 hasName ( ) [inherited]

Returns true if the Namable has a nonempty name set, false if the name is empty.

bool isExactType ( TypeHandle  handle) [inherited]

Returns true if the current object is the indicated type exactly.

bool isOfType ( TypeHandle  handle) [inherited]

Returns true if the current object is or derives from the indicated type.

bool isValid ( ) [inherited]

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

TextFont makeCopy ( ) [inherited]

Reimplemented in DynamicTextFont.

output ( ostream  out) [inherited]

Outputs the Namable.

This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

Reimplemented in PandaNode, MouseWatcherRegion, TextNode, AdaptiveLru, SimpleLru, AsyncTask, Material, AsyncTaskChain, AsyncTaskManager, Thread, CollisionTraverser, PartBundle, AnimGroup, AnimControl, PandaLoader, LightNode, and LightLensNode.

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.

setLineHeight ( float  line_height) [inherited]

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

setName ( string  name) [inherited]

Reimplemented in PGItem, and AsyncTask.

setSpaceAdvance ( float  space_advance) [inherited]

Changes the number of units wide a space is.

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.

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.

write ( ostream  out,
int  indent_level 
) [inherited]

Reimplemented in DynamicTextFont.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties