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

#include "animBundle.h"

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

Public Member Functions

 AnimBundle (const std::string &name, PN_stdfloat fps, int num_frames)
 
virtual TypeHandle force_init_type ()
 
double get_base_frame_rate () const
 
int get_num_frames () const
 
virtual TypeHandle get_type () const
 
virtual void output (std::ostream &out) const
 Writes a one-line description of the group. More...
 
 PT (AnimBundle) copy_bundle() const
 
virtual void write_datagram (BamWriter *manager, Datagram &me)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from AnimGroup
 AnimGroup (AnimGroup *parent, const std::string &name)
 Creates the AnimGroup, and adds it to the indicated parent. More...
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Takes in a vector of pointes to TypedWritable objects that correspond to all the requests for pointers that this object made to BamReader. More...
 
AnimGroupfind_child (const std::string &name) const
 Returns the first descendant found with the indicated name, or NULL if no such descendant exists. More...
 
AnimGroupget_child (int n) const
 
AnimGroupget_child_named (const std::string &name) const
 Returns the first child found with the indicated name, or NULL if no such child exists. More...
 
int get_num_children () const
 
virtual TypeHandle get_value_type () const
 Returns the TypeHandle associated with the ValueType we are concerned with. More...
 
void sort_descendants ()
 Sorts the children nodes at each level of the hierarchy into alphabetical order. More...
 
virtual void write (std::ostream &out, int indent_level) const
 Writes a brief description of the group and all of its descendants. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const std::string &initial_name="")
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const std::string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
void output (std::ostream &out) const
 Outputs the Namable. More...
 
void set_name (const std::string &name)
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
static TypedWritablemake_AnimBundle (const FactoryParams &params)
 Factory method to generate a AnimBundle object. More...
 
static void register_with_read_factory ()
 Factory method to generate a AnimBundle object. More...
 
- Static Public Member Functions inherited from AnimGroup
static TypeHandle get_class_type ()
 
static void init_type ()
 
static TypedWritablemake_AnimGroup (const FactoryParams &params)
 Factory method to generate a AnimGroup object. More...
 
static void register_with_read_factory ()
 Factory method to generate a AnimGroup object. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_base_frame_rate
 Returns the ideal number of frames per second of the animation, when it is running at normal speed. More...
 
 get_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
 get_child
 Returns the nth child of the group. More...
 
 get_num_children
 Returns the number of child nodes of the group. More...
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from Namable
 get_name
 
 set_name
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

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

Definition at line 29 of file animBundle.h.

Member Function Documentation

◆ make_AnimBundle()

TypedWritable * AnimBundle::make_AnimBundle ( const FactoryParams params)
static

Factory method to generate a AnimBundle object.

Definition at line 96 of file animBundle.cxx.

References parse_params().

Referenced by register_with_read_factory().

◆ output()

virtual void AnimBundle::output ( std::ostream &  out) const
virtual

Writes a one-line description of the group.

Reimplemented from AnimGroup.

◆ register_with_read_factory()

void AnimBundle::register_with_read_factory ( )
static

Factory method to generate a AnimBundle object.

Definition at line 110 of file animBundle.cxx.

References BamReader::get_factory(), make_AnimBundle(), and Factory< Type >::register_factory().

◆ write_datagram()

virtual void AnimBundle::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from AnimGroup.

Member Data Documentation

◆ get_base_frame_rate

double AnimBundle::get_base_frame_rate
inline

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

Definition at line 41 of file animBundle.h.

◆ get_num_frames

int AnimBundle::get_num_frames
inline

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

Definition at line 42 of file animBundle.h.


The documentation for this class was generated from the following files: