Panda3D
Public Member Functions | Static Public Member Functions

AnimBundle Class Reference

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

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

List of all members.

Public Member Functions

 AnimBundle (string name, float fps, int num_frames)
 clearName ()
 Resets the Namable's name to empty.
AnimBundle copyBundle ()
 Returns a full copy of the bundle and its entire tree of nested AnimGroups.
string encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encodeToBamStream (basic_stringchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
bool encodeToBamStream (basic_stringchar data)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
AnimGroup findChild (string name)
 Returns the first descendant found with the indicated name, or NULL if no such descendant exists.
UpdateSeq getBamModified ()
 Returns the current bam_modified counter.
double getBaseFrameRate ()
 Returns the ideal number of frames per second of the animation, when it is running at normal speed.
AnimGroup getChild (int n)
 Returns the nth child of the group.
AnimGroup getChildNamed (string name)
 Returns the first child found with the indicated name, or NULL if no such child exists.
list getChildren ()
string getName ()
int getNumChildren ()
 Returns the number of child nodes of the group.
int getNumFrames ()
 Returns the number of frames of animation, or 0 if the animation has no fixed number of frames.
int getRefCount ()
 Returns the current reference count.
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.
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
 output (ostream out)
 Writes a one-line description of the group.
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
PyObject reducePersist (PyObject self, PyObject pickler)
 This special Python method is implement to provide support for the pickle module.
 ref ()
 Explicitly increments the reference count.
 setName (string name)
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)
 Writes a brief description of the group and all of its descendants.

Static Public Member Functions

static TypedWritableReferenceCount decodeFromBamStream (string 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.
static TypedWritableReferenceCount decodeFromBamStream (string data)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
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).


Constructor & Destructor Documentation

AnimBundle ( string  name,
float  fps,
int  num_frames 
)

Member Function Documentation

clearName ( ) [inherited]

Resets the Namable's name to empty.

Reimplemented in AsyncTask.

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.

static TypedWritableReferenceCount decodeFromBamStream ( string  data) [static, inherited]

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.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

static TypedWritableReferenceCount decodeFromBamStream ( string  data,
BamReader  reader 
) [static, inherited]

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.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

string encodeToBamStream ( ) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data,
BamWriter  writer 
) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

AnimGroup findChild ( string  name) [inherited]

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

UpdateSeq getBamModified ( ) [inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

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

AnimGroup getChild ( int  n) [inherited]

Returns the nth child of the group.

AnimGroup getChildNamed ( string  name) [inherited]

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

list getChildren ( ) [inherited]
static TypeHandle getClassType ( ) [static]

Reimplemented from AnimGroup.

string getName ( ) [inherited]

Reimplemented in DynamicTextFont.

int getNumChildren ( ) [inherited]

Returns the number of child nodes of the group.

int getNumFrames ( )

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

int getRefCount ( ) [inherited]

Returns the current reference count.

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.

markBamModified ( ) [inherited]

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.

output ( ostream  out) [inherited]

Writes a one-line description of the group.

Reimplemented from Namable.

PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.

PyObject reducePersist ( PyObject  self,
PyObject  pickler 
) [inherited]

This special Python method is implement to provide support for the pickle module.

This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.

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.

setName ( string  name) [inherited]

Reimplemented in PGItem, and AsyncTask.

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]

Writes a brief description of the group and all of its descendants.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties