Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

AnimBundle Class Reference

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

#include <animBundle.h>

Inheritance diagram for AnimBundle:


Public Member Functions
	AnimBundle (const string &name, float fps, int num_frames)
double	get_base_frame_rate () const
	Returns the ideal number of frames per second of the animation, when it is running at normal speed.
int	get_num_frames () const
	Returns the number of frames of animation, or 0 if the animation has no fixed number of frames.
virtual void	output (ostream &out) const
	Writes a one-line description of the bundle.
virtual void	write_datagram (BamWriter *manager, Datagram &me)
	Function to write the important information in the particular object to a Datagram.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
int	get_num_children () const
	Returns the number of child nodes of the group.
AnimGroup *	get_child (int n) const
	Returns the nth child of the group.
AnimGroup *	find_child (const string &name) const
	Returns the first descendant found with the indicated name, or NULL if no such descendant exists.
virtual TypeHandle	get_value_type () const
	Returns the TypeHandle associated with the ValueType we are concerned with.
void	sort_descendants ()
	Sorts the children nodes at each level of the hierarchy into alphabetical order.
virtual void	write (ostream &out, int indent_level) const
	Writes a brief description of the group and all of its descendants.
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.
virtual void	finalize ()
	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.
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
void	set_name (const string &name)
void	clear_name ()
	Resets the Namable's name to empty.
bool	has_name () const
	Returns true if the Namable has a nonempty name set, false if the name is empty.
const string &	get_name () const
Static Public Member Functions
void	register_with_read_factory (void)
	Factory method to generate a AnimBundle object.
TypedWritable *	make_AnimBundle (const FactoryParams &params)
	Factory method to generate a AnimBundle object.
TypeHandle	get_class_type ()
void	init_type ()
TypedWritable *	make_AnimGroup (const FactoryParams &params)
	Factory method to generate a AnimGroup object.
Static Public Attributes
TypedWritable *const	Null = (TypedWritable*)0L
Protected Types
typedef pvector< PointerTo< AnimGroup > >	Children
Protected Member Functions
	AnimBundle (void)
void	fillin (DatagramIterator &scan, BamReader *manager)
	Function that reads out of the datagram (or asks manager to read) all of the data that is needed to re-create this object and stores it in the appropiate place.
void	write_descendants (ostream &out, int indent_level) const
	Writes a brief description of all of the group's descendants.
Protected Attributes
float	_fps
int	_num_frames
Children	_children
AnimBundle *	_root
Static Private Attributes
TypeHandle	_type_handle

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 43 of file animBundle.h.

Member Typedef Documentation

typedef pvector< PointerTo< AnimGroup > > AnimGroup::Children [protected, inherited]

Definition at line 78 of file animGroup.h.

Constructor & Destructor Documentation

AnimBundle::AnimBundle ( const string & name,

float fps,

int num_frames

) [inline]

Definition at line 30 of file animBundle.I.
References INLINE.

AnimBundle::AnimBundle ( void ) [inline, protected]

Definition at line 44 of file animBundle.I.
References _fps, and INLINE.

Member Function Documentation

void Namable::clear_name ( ) [inline, inherited]

Resets the Namable's name to empty.

Definition at line 82 of file namable.I.
References Namable::_name, and INLINE.

int AnimGroup::complete_pointers ( TypedWritable ** p_list,

BamReader * manager

) [virtual, inherited]

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.
Definition at line 281 of file animGroup.cxx.

void AnimBundle::fillin ( DatagramIterator & scan,

BamReader * manager

) [protected]

Function that reads out of the datagram (or asks manager to read) all of the data that is needed to re-create this object and stores it in the appropiate place.

Reimplemented from AnimGroup.
Definition at line 80 of file animBundle.cxx.

void TypedWritable::finalize ( void ) [virtual, inherited]

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.

Reimplemented in PartBundle, RenderAttrib, RenderEffect, RenderEffects, RenderState, and TransformState.
Definition at line 112 of file typedWritable.cxx.
Referenced by BamReader::skip_pointer().

AnimGroup * AnimGroup::find_child ( const string & name ) const [inherited]

Returns the first descendant found with the indicated name, or NULL if no such descendant exists.

Definition at line 99 of file animGroup.cxx.
References TypeHandle::none().

virtual TypeHandle AnimBundle::force_init_type ( void ) [inline, virtual]

Reimplemented from AnimGroup.
Definition at line 72 of file animBundle.h.

double AnimBundle::get_base_frame_rate ( ) const [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 66 of file animBundle.I.
Referenced by AnimControl::set_play_rate().

AnimGroup * AnimGroup::get_child ( int n ) const [inherited]

Returns the nth child of the group.

Definition at line 83 of file animGroup.cxx.
References AnimGroup::_children.

TypeHandle AnimBundle::get_class_type ( void ) [inline, static]

Reimplemented from AnimGroup.
Definition at line 73 of file animBundle.h.

const string & Namable::get_name ( ) const [inline, inherited]

Definition at line 109 of file namable.I.
Referenced by ComputedVerticesMaker::add_normal(), GLGraphicsStateGuardian::begin_bind_clip_planes(), GLGraphicsStateGuardian::begin_bind_lights(), BuilderBucket::BuilderBucket(), EggVertex::clear_grefs(), AnimBundleMaker::create_xfm_channel(), SceneGraphReducer::do_flatten_siblings(), BuilderBucket::done_geom(), DXTextureContext8::DXTextureContext8(), PartGroup::find_child(), EggLoader::find_collision_geometry(), EggGroupUniquifier::get_category(), PartBundle::get_control_effect(), PartGroup::get_num_children(), EggMorph< Parameter >::get_offset(), AnimChannelBase::has_changed(), Namable::has_name(), EggMaterial::is_equivalent_to(), Texture::load(), EggLoader::make_node(), AnimBundleMaker::make_node(), FindApproxPath::Component::matches(), LineSegs::move_to(), MovingPartBase::MovingPartBase(), NodeMap::NodeMap(), EggMorph< Parameter >::operator<(), operator<<(), MouseWatcherRegion::output(), AnimGroup::output(), EggXfmSAnim::r_transform(), Texture::read(), MouseWatcherGroup::remove_region(), EggLoader::reparent_decals(), CRGraphicsStateGuardian::set_blend_mode(), NodePath::set_color(), GLGraphicsStateGuardian::set_draw_buffer(), AnimChannelScalarTable::set_table(), NodePath::set_transparency(), NodePathComponent::uncollapse(), Texture::unprepare(), TextNode::wordwrap_to(), MovingPartBase::write(), CollisionNode::xform(), and EggVertex::~EggVertex().

int AnimGroup::get_num_children ( ) const [inherited]

Returns the number of child nodes of the group.

Definition at line 69 of file animGroup.cxx.
References AnimGroup::_children, nassertr, and NULL.
Referenced by PartGroup::sort_descendants().

int AnimBundle::get_num_frames ( ) const [inline]

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

Definition at line 81 of file animBundle.I.
Referenced by AnimChannelMatrixXfmTable::get_scale().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]

Returns the current reference count.

Definition at line 183 of file referenceCount.I.
Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle AnimBundle::get_type ( void ) const [inline, virtual]

Reimplemented from AnimGroup.
Definition at line 69 of file animBundle.h.

int TypedObject::get_type_index ( ) const [inline, 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().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

TypeHandle AnimGroup::get_value_type ( ) const [virtual, inherited]

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 >, AnimChannelBase, AnimChannel< ACScalarSwitchType >, and AnimChannel< ACMatrixSwitchType >.
Definition at line 130 of file animGroup.cxx.
References AnimGroup::_children.
Referenced by PartGroupAlphabeticalOrder::operator()().

bool Namable::has_name ( ) const [inline, inherited]

Returns true if the Namable has a nonempty name set, false if the name is empty.

Definition at line 97 of file namable.I.
References Namable::get_name(), and INLINE.
Referenced by EggGroupUniquifier::EggGroupUniquifier(), Texture::read(), and Texture::Texture().

void AnimBundle::init_type ( void ) [inline, static]

Reimplemented from AnimGroup.
Definition at line 76 of file animBundle.h.

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

TypedWritable * AnimBundle::make_AnimBundle ( const FactoryParams & params ) [static]

Factory method to generate a AnimBundle object.

Definition at line 96 of file animBundle.cxx.

TypedWritable * AnimGroup::make_AnimGroup ( const FactoryParams & params ) [static, inherited]

Factory method to generate a AnimGroup object.

Definition at line 309 of file animGroup.cxx.

void AnimBundle::output ( ostream & out ) const [virtual]

Writes a one-line description of the bundle.

Reimplemented from AnimGroup.
Definition at line 42 of file animBundle.cxx.
References _fps, _num_frames, Datagram::add_float32(), Datagram::add_uint16(), and AnimGroup::write_datagram().

int ReferenceCount::ref ( ) const [inline, 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.
The return value is the new reference count.
Definition at line 225 of file referenceCount.I.
Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

void AnimBundle::register_with_read_factory ( void ) [static]

Factory method to generate a AnimBundle object.

Reimplemented from AnimGroup.
Definition at line 116 of file animBundle.cxx.

void Namable::set_name ( const string & name ) [inline, inherited]

Definition at line 69 of file namable.I.
References Namable::_name.
Referenced by BuilderBucket::BuilderBucket(), SceneGraphReducer::do_flatten_siblings(), Texture::read(), PandaNode::reparent(), and Texture::Texture().

void AnimGroup::sort_descendants ( ) [inherited]

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 160 of file animGroup.cxx.

void ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.
References INLINE.
Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref ( ) const [inline, 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; plus, we don't have a virtual destructor anyway.) 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 the new reference count.
Definition at line 293 of file referenceCount.I.
References INLINE.
Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

void AnimGroup::write ( ostream & out,

int indent_level

) const [virtual, inherited]

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

Reimplemented in AnimChannelMatrixXfmTable, and AnimChannelScalarTable.
Definition at line 194 of file animGroup.cxx.

void AnimBundle::write_datagram ( BamWriter * manager,

Datagram & me

) [virtual]

Function to write the important information in the particular object to a Datagram.

Reimplemented from AnimGroup.
Definition at line 58 of file animBundle.cxx.
References _fps, _num_frames, AnimGroup::fillin(), DatagramIterator::get_float32(), and DatagramIterator::get_uint16().

void AnimGroup::write_descendants ( ostream & out,

int indent_level

) const [protected, inherited]

Writes a brief description of all of the group's descendants.

Definition at line 211 of file animGroup.cxx.
References BamReader::read_pointer().
Referenced by AnimChannelScalarTable::set_table().

Member Data Documentation

Children AnimGroup::_children [protected, inherited]

Definition at line 79 of file animGroup.h.
Referenced by AnimGroup::AnimGroup(), AnimGroup::get_child(), AnimGroup::get_num_children(), AnimGroup::get_value_type(), AnimGroup::output(), and AnimChannelScalarTable::set_table().

float AnimBundle::_fps [protected]

Definition at line 55 of file animBundle.h.
Referenced by AnimBundle(), output(), and write_datagram().

int AnimBundle::_num_frames [protected]

Definition at line 56 of file animBundle.h.
Referenced by output(), and write_datagram().

AnimBundle* AnimGroup::_root [protected, inherited]

Definition at line 80 of file animGroup.h.
Referenced by AnimChannelMatrixXfmTable::get_scale(), and AnimChannelScalarTable::get_value().

TypeHandle AnimBundle::_type_handle [static, private]

Reimplemented from AnimGroup.
Definition at line 31 of file animBundle.cxx.

TypedWritable *const TypedWritable::Null = (TypedWritable*)0L [static, inherited]

Definition at line 25 of file typedWritable.cxx.
Referenced by Child::complete_pointers(), Parent::complete_pointers(), Person::complete_pointers(), LoaderFileTypeBam::get_extension(), PartGroup::pick_channel_index(), BamReader::read_pointer(), and AnimGroup::write_datagram().

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

panda/src/chan/animBundle.h
panda/src/chan/animBundle.cxx
panda/src/chan/animBundle.I

Generated on Fri May 2 00:47:19 2003 for Panda by

1.3

AnimBundle Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation