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

This is the base class for AnimChannel and AnimBundle. More...

#include "animGroup.h"

Inheritance diagram for AnimGroup:
TypedWritableReferenceCount Namable TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase AnimBundle AnimChannelBase AnimChannel< SwitchType > AnimChannel< ACMatrixSwitchType > AnimChannelFixed< SwitchType > AnimChannelScalarDynamic AnimChannelScalarTable AnimChannelMatrixDynamic AnimChannelMatrixFixed AnimChannelMatrixXfmTable

Public Member Functions

 AnimGroup (AnimGroup *parent, const 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 string &name) const
 Returns the first descendant found with the indicated name, or NULL if no such descendant exists. More...
 
virtual TypeHandle force_init_type ()
 
AnimGroupget_child (int n) const
 Returns the nth child of the group. More...
 
AnimGroupget_child_named (const 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
 Returns the number of child nodes of the group. More...
 
virtual TypeHandle get_type () const
 
virtual TypeHandle get_value_type () const
 Returns the TypeHandle associated with the ValueType we are concerned with. More...
 
 MAKE_SEQ (get_children, get_num_children, get_child)
 
virtual void output (ostream &out) const
 Writes a one-line description of the group. More...
 
void sort_descendants ()
 Sorts the children nodes at each level of the hierarchy into alphabetical order. More...
 
virtual void write (ostream &out, int indent_level) const
 Writes a brief description of the group and all of its descendants. More...
 
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 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)
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) 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)
 
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...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
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 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...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const string &initial_name="")
 
 Namable (const Namable &copy)
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const 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...
 
Namableoperator= (const Namable &other)
 
void output (ostream &out) const
 Outputs the Namable. More...
 
void set_name (const string &name)
 

Static Public Member Functions

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(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. 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 ()
 

Additional Inherited Members

- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

This is the base class for AnimChannel and AnimBundle.

It implements a hierarchy of AnimChannels. The root of the hierarchy must be an AnimBundle.

Definition at line 36 of file animGroup.h.

Constructor & Destructor Documentation

◆ AnimGroup()

AnimGroup::AnimGroup ( AnimGroup parent,
const string &  name 
)

Creates the AnimGroup, and adds it to the indicated parent.

The only way to delete it subsequently is to delete the entire hierarchy.

Definition at line 78 of file animGroup.cxx.

References get_num_children().

Member Function Documentation

◆ complete_pointers()

int AnimGroup::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
virtual

Takes in a vector of pointes to TypedWritable objects that correspond to all the requests for pointers that this object made to BamReader.

Reimplemented from TypedWritable.

Reimplemented in AnimChannelMatrixDynamic, and AnimChannelScalarDynamic.

Definition at line 327 of file animGroup.cxx.

References make_AnimGroup().

Referenced by AnimChannelScalarDynamic::complete_pointers(), AnimChannelMatrixDynamic::complete_pointers(), and write().

◆ find_child()

AnimGroup * AnimGroup::find_child ( const string &  name) const

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

Definition at line 151 of file animGroup.cxx.

References find_child().

Referenced by find_child(), and get_child_named().

◆ get_child()

AnimGroup * AnimGroup::get_child ( int  n) const

Returns the nth child of the group.

Definition at line 115 of file animGroup.cxx.

References get_child_named().

Referenced by EggSaver::add_node(), PartGroup::check_hierarchy(), PartGroup::determine_effective_channels(), and get_num_children().

◆ get_child_named()

AnimGroup * AnimGroup::get_child_named ( const string &  name) const

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

Definition at line 130 of file animGroup.cxx.

References find_child().

Referenced by PartGroup::check_hierarchy(), and get_child().

◆ get_num_children()

int AnimGroup::get_num_children ( ) const

Returns the number of child nodes of the group.

Definition at line 104 of file animGroup.cxx.

References get_child().

Referenced by EggSaver::add_node(), AnimGroup(), PartGroup::check_hierarchy(), and PartGroup::determine_effective_channels().

◆ get_value_type()

TypeHandle AnimGroup::get_value_type ( ) const
virtual

Returns the TypeHandle associated with the ValueType we are concerned with.

This is provided to allow a bit of run-time checking that joints and channels are matching properly in type.

Reimplemented in AnimChannel< SwitchType >, AnimChannel< ACMatrixSwitchType >, and AnimChannelBase.

Definition at line 204 of file animGroup.cxx.

References TypeHandle::none(), and output().

Referenced by PartGroup::check_hierarchy(), and sort_descendants().

◆ make_AnimGroup()

TypedWritable * AnimGroup::make_AnimGroup ( const FactoryParams params)
static

Factory method to generate a AnimGroup object.

Definition at line 346 of file animGroup.cxx.

References register_with_read_factory().

Referenced by complete_pointers(), and register_with_read_factory().

◆ output()

void AnimGroup::output ( ostream &  out) const
virtual

Writes a one-line description of the group.

Reimplemented in AnimChannelFixed< SwitchType >, AnimChannelMatrixFixed, and AnimBundle.

Definition at line 214 of file animGroup.cxx.

References write().

Referenced by get_value_type(), AnimChannelMatrixFixed::output(), and AnimChannelFixed< SwitchType >::output().

◆ register_with_read_factory()

void AnimGroup::register_with_read_factory ( )
static

Factory method to generate a AnimGroup object.

Definition at line 362 of file animGroup.cxx.

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

Referenced by make_AnimGroup().

◆ sort_descendants()

void AnimGroup::sort_descendants ( )

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.

Definition at line 185 of file animGroup.cxx.

References get_value_type().

◆ write()

void AnimGroup::write ( ostream &  out,
int  indent_level 
) const
virtual

◆ write_datagram()

virtual void AnimGroup::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 TypedWritable.

Reimplemented in AnimChannelMatrixDynamic, AnimChannelMatrixXfmTable, AnimChannelScalarDynamic, AnimChannelScalarTable, AnimBundle, AnimChannelBase, and AnimChannelMatrixFixed.

Referenced by write(), and AnimChannelBase::write_datagram().


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