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

This is the root of an AnimChannel hierarchy. More...

Inheritance diagram for AnimBundle:
AnimGroup TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject

Public Member Functions

 __init__ (const AnimBundle)
 
 __init__ (str name, float fps, int num_frames)
 
AnimBundle copyBundle ()
 Returns a full copy of the bundle and its entire tree of nested AnimGroups. More...
 
double getBaseFrameRate ()
 Returns the ideal number of frames per second of the animation, when it is running at normal speed. 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. More...
 
 __init__ (const AnimGroup)
 
AnimGroup findChild (str name)
 Returns the first descendant found with the indicated name, or NULL if no such descendant exists. 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. 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. 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)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- 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 AnimGroup
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. 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 ()
 

Public Attributes

double base_frame_rate
 Returns the ideal number of frames per second of the animation, when it is running at normal speed. More...
 
int num_frames
 Returns the number of frames of animation, or 0 if the animation has no fixed number of frames. More...
 
- Public Attributes inherited from AnimGroup
AnimGroup children []
 
- 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

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__() [1/2]

__init__ ( const  AnimBundle)

◆ __init__() [2/2]

__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.

Member Data Documentation

◆ base_frame_rate

double base_frame_rate

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

◆ num_frames

int num_frames

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