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

This table records data about a list of animations for a particular model, such as number of frames and frame rate. It's used for implementating asynchronous binding. More...

Inheritance diagram for AnimPreloadTable:
CopyOnWriteObject CachedTypedWritableReferenceCount TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Member Functions

 __init__ ()
 
 addAnim (str basename, float base_frame_rate, int num_frames)
 Adds a new animation record to the table. If there is already a record of this name, no operation is performed (the original record is unchanged). See find_anim(). This will invalidate existing index numbers. More...
 
 addAnimsFrom (const AnimPreloadTable other)
 Copies the animation records from the other table into this one. If a given record name exists in both tables, the record in this one supercedes. More...
 
 clearAnims ()
 Removes all animation records from the table. More...
 
int findAnim (str basename)
 Returns the index number in the table of the animation record with the indicated name, or -1 if the name is not present. By convention, the basename is the filename of the egg or bam file, without the directory part and without the extension. That is, it is Filename::get_basename_wo_extension(). More...
 
float getBaseFrameRate (int n)
 Returns the frame rate stored for the nth animation record. More...
 
str getBasename (int n)
 Returns the basename stored for the nth animation record. See find_anim(). More...
 
int getNumAnims ()
 Returns the number of animation records in the table. More...
 
int getNumFrames (int n)
 Returns the number of frames stored for the nth animation record. More...
 
 output (Ostream out)
 
 removeAnim (int n)
 Removes the nth animation records from the table. This renumbers indexes for following animations. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from CopyOnWriteObject
 cacheRef ()
 See CachedTypedWritableReferenceCount::cache_ref(). More...
 
bool cacheUnref ()
 See CachedTypedWritableReferenceCount::cache_unref(). More...
 
- Public Member Functions inherited from CachedTypedWritableReferenceCount
 cacheRef ()
 Explicitly increments the cache reference count and the normal reference count simultaneously. More...
 
bool cacheUnref ()
 Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
 
int getCacheRefCount ()
 Returns the current reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
str encodeToBamStream ()
 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. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 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. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 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. More...
 
- 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...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from CopyOnWriteObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from CachedTypedWritableReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (str 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. Returns NULL on error. 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 ()
 

Detailed Description

This table records data about a list of animations for a particular model, such as number of frames and frame rate. It's used for implementating asynchronous binding.

This table is normally built by an offline tool, such as egg-optchar.

Member Function Documentation

◆ __init__()

__init__ ( )

◆ addAnim()

addAnim ( str  basename,
float  base_frame_rate,
int  num_frames 
)

Adds a new animation record to the table. If there is already a record of this name, no operation is performed (the original record is unchanged). See find_anim(). This will invalidate existing index numbers.

◆ addAnimsFrom()

addAnimsFrom ( const AnimPreloadTable  other)

Copies the animation records from the other table into this one. If a given record name exists in both tables, the record in this one supercedes.

◆ clearAnims()

clearAnims ( )

Removes all animation records from the table.

◆ findAnim()

int findAnim ( str  basename)

Returns the index number in the table of the animation record with the indicated name, or -1 if the name is not present. By convention, the basename is the filename of the egg or bam file, without the directory part and without the extension. That is, it is Filename::get_basename_wo_extension().

◆ getBaseFrameRate()

float getBaseFrameRate ( int  n)

Returns the frame rate stored for the nth animation record.

◆ getBasename()

str getBasename ( int  n)

Returns the basename stored for the nth animation record. See find_anim().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getNumAnims()

int getNumAnims ( )

Returns the number of animation records in the table.

◆ getNumFrames()

int getNumFrames ( int  n)

Returns the number of frames stored for the nth animation record.

◆ output()

output ( Ostream  out)

◆ removeAnim()

removeAnim ( int  n)

Removes the nth animation records from the table. This renumbers indexes for following animations.

◆ write()

write ( Ostream  out,
int  indent_level 
)