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

This is the root of an AnimChannel hierarchy. It knows the frame rate and number of frames of all the channels in the hierarchy (which must all match). More...

Inheritance diagram for AnimBundle:
AnimGroup TypedWritableReferenceCount Namable TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase

Public Member Functions

 __init__ (str name, float fps, int num_frames)
 
AnimBundle copyBundle ()
 Returns a full copy of the bundle and its entire tree of nested AnimGroups. However, the actual data stored in the leaves–that is, animation tables, such as those stored in an AnimChannelMatrixXfmTable–will be shared. More...
 
double getBaseFrameRate ()
 Returns the ideal number of frames per second of the animation, when it is running at normal speed. This may not be the same as the actual playing frame rate, as it might have been adjusted through set_play_rate() on the AnimControl object. See AnimControl::get_effective_frame_rate(). More...
 
int getNumFrames ()
 Returns the number of frames of animation, or 0 if the animation has no fixed number of frames. More...
 
- Public Member Functions inherited from AnimGroup
 __init__ (AnimGroup parent, str name)
 Creates the AnimGroup, and adds it to the indicated parent. The only way to delete it subsequently is to delete the entire hierarchy. More...
 
AnimGroup findChild (str name)
 Returns the first descendant found with the indicated name, or NULL if no such descendant exists. This method searches the entire graph beginning at this AnimGroup; see also get_child_named(). More...
 
AnimGroup getChild (int n)
 Returns the nth child of the group. More...
 
AnimGroup getChildNamed (str name)
 Returns the first child found with the indicated name, or NULL if no such child exists. This method searches only the children of this particular AnimGroup; it does not recursively search the entire graph. See also find_child(). More...
 
list getChildren ()
 
int getNumChildren ()
 Returns the number of child nodes of the group. More...
 
 output (Ostream out)
 Writes a one-line description of the group. More...
 
 sortDescendants ()
 Sorts the children nodes at each level of the hierarchy into alphabetical order. This should be done after creating the hierarchy, to guarantee that the correct names will match up together when the AnimBundle is later bound to a PlayerRoot. More...
 
 write (Ostream out, int indent_level)
 Writes a brief description of the group and all of its descendants. 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...
 
- 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 AnimGroup
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 ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Detailed Description

This is the root of an AnimChannel hierarchy. It knows the frame rate and number of frames of all the channels in the hierarchy (which must all match).

Member Function Documentation

◆ __init__()

__init__ ( str  name,
float  fps,
int  num_frames 
)

◆ copyBundle()

AnimBundle copyBundle ( )

Returns a full copy of the bundle and its entire tree of nested AnimGroups. However, the actual data stored in the leaves–that is, animation tables, such as those stored in an AnimChannelMatrixXfmTable–will be shared.

◆ getBaseFrameRate()

double getBaseFrameRate ( )

Returns the ideal number of frames per second of the animation, when it is running at normal speed. This may not be the same as the actual playing frame rate, as it might have been adjusted through set_play_rate() on the AnimControl object. See AnimControl::get_effective_frame_rate().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getNumFrames()

int getNumFrames ( )

Returns the number of frames of animation, or 0 if the animation has no fixed number of frames.