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

AnimChannelScalarTable Class Reference

An animation channel that issues a scalar each frame, read from a table such as might have been read from an egg file. More...

#include <animChannelScalarTable.h>

Inheritance diagram for AnimChannelScalarTable:

List of all members.


Public Types
typedef TYPENAME ACScalarSwitchType::ValueType	ValueType
Public Member Functions
	AnimChannelScalarTable (AnimGroup *parent, const string &name)
virtual bool	has_changed (int last_frame, int this_frame)
	Returns true if the value has changed since the last call to has_changed().
virtual void	get_value (int frame, float &value)
	Gets the value of the channel at the indicated frame.
void	set_table (const CPTA_float &table)
	Assigns the data table.
bool	has_table () const
	Returns true if the data table has been assigned.
void	clear_table ()
	Empties the data table.
virtual void	write (ostream &out, int indent_level) const
	Writes a brief description of the table and all of its descendants.
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 ()
virtual void	get_value (int frame, ValueType &value)=0
virtual void	get_value_no_scale (int frame, ValueType &value)
virtual void	get_scale (int frame, float scale[3])
virtual TypeHandle	get_value_type () const
	Returns the TypeHandle associated with the ValueType we are concerned with.
virtual void	output (ostream &out) const
	Writes a one-line description of the channel.
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.
void	sort_descendants ()
	Sorts the children nodes at each level of the hierarchy into alphabetical order.
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 AnimChannelScalarTable object.
TypedWritable *	make_AnimChannelScalarTable (const FactoryParams &params)
	Factory method to generate a AnimChannelScalarTable 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
	AnimChannelScalarTable (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
CPTA_float	_table
int	_last_frame
Children	_children
AnimBundle *	_root
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

An animation channel that issues a scalar each frame, read from a table such as might have been read from an egg file.

Definition at line 43 of file animChannelScalarTable.h.

Member Typedef Documentation

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

Definition at line 78 of file animGroup.h.

typedef TYPENAME ACScalarSwitchType::ValueType AnimChannel< ACScalarSwitchType >::ValueType [inherited]

Definition at line 50 of file animChannel.h.

Constructor & Destructor Documentation

AnimChannelScalarTable::AnimChannelScalarTable ( AnimGroup * parent,

const string & name

)

Definition at line 44 of file animChannelScalarTable.cxx.

AnimChannelScalarTable::AnimChannelScalarTable ( void ) [protected]

Definition at line 56 of file animChannelScalarTable.cxx.
References _table, and ConstPointerToArray< float >::size().

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.

void AnimChannelScalarTable::clear_table ( ) [inline]

Empties the data table.

Definition at line 46 of file animChannelScalarTable.I.

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 AnimChannelScalarTable::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 AnimChannelBase.
Definition at line 277 of file animChannelScalarTable.cxx.
References PointerToArray< float >::push_back().

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 AnimChannelScalarTable::force_init_type ( void ) [inline, virtual]

Reimplemented from AnimChannel< ACScalarSwitchType >.
Definition at line 73 of file animChannelScalarTable.h.

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 AnimChannelScalarTable::get_class_type ( void ) [inline, static]

Reimplemented from AnimChannel< ACScalarSwitchType >.
Definition at line 74 of file animChannelScalarTable.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(), 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 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 void AnimChannel< ACScalarSwitchType >::get_scale ( int frame,

float scale[3]

) [virtual, inherited]

Returns the x, y, and z scale components associated with the current frame.
As above, this only makes sense for a matrix-type channel.

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

Reimplemented from AnimChannel< ACScalarSwitchType >.
Definition at line 70 of file animChannelScalarTable.h.
Referenced by set_table().

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.

virtual void AnimChannel< ACScalarSwitchType >::get_value ( int frame,

ValueType & value

) [pure virtual, inherited]

void AnimChannelScalarTable::get_value ( int frame,

float & value

) [virtual]

Gets the value of the channel at the indicated frame.

Definition at line 94 of file animChannelScalarTable.cxx.
References AnimGroup::_root, and num_frames.

virtual void AnimChannel< ACScalarSwitchType >::get_value_no_scale ( int frame,

ValueType & value

) [virtual, inherited]

Returns the value associated with the current frame, with no scale components.
This only makes sense for a matrix-type channel, although for fiddly technical reasons the function exists for all channels.

virtual TypeHandle AnimChannel< ACScalarSwitchType >::get_value_type ( ) const [virtual, inherited]

Returns the TypeHandle associated with the ValueType we return.
This is provided to allow a bit of run-time checking that joints and channels are matching properly in type.
Implements AnimChannelBase.

bool AnimChannelScalarTable::has_changed ( int last_frame,

int this_frame

) [virtual]

Returns true if the value has changed since the last call to has_changed().
last_frame is the frame number of the last call; this_frame is the current frame number.
Reimplemented from AnimChannelBase.
Definition at line 74 of file animChannelScalarTable.cxx.
References _table, ConstPointerToArray< float >::empty(), and ConstPointerToArray< float >::size().

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

bool AnimChannelScalarTable::has_table ( ) const [inline]

Returns true if the data table has been assigned.

Definition at line 32 of file animChannelScalarTable.I.
References _table, INLINE, and NULL.

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

Reimplemented from AnimChannel< ACScalarSwitchType >.
Definition at line 77 of file animChannelScalarTable.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 * AnimChannelScalarTable::make_AnimChannelScalarTable ( const FactoryParams & params ) [static]

Factory method to generate a AnimChannelScalarTable object.

Definition at line 351 of file animChannelScalarTable.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 AnimChannelBase::output ( ostream & out ) const [virtual, inherited]

Writes a one-line description of the channel.

Reimplemented from AnimGroup.
Reimplemented in AnimChannelFixed< SwitchType >.
Definition at line 60 of file animChannelBase.cxx.
References AnimChannelBase::_last_frame, 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 AnimChannelScalarTable::register_with_read_factory ( void ) [static]

Factory method to generate a AnimChannelScalarTable object.

Reimplemented from AnimGroup.
Definition at line 371 of file animChannelScalarTable.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 AnimChannelScalarTable::set_table ( const CPTA_float & table )

Assigns the data table.

Definition at line 112 of file animChannelScalarTable.cxx.
References AnimGroup::_children, _table, Namable::get_name(), get_type(), indent(), ConstPointerToArray< float >::size(), and AnimGroup::write_descendants().

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 AnimChannelScalarTable::write ( ostream & out,

int indent_level

) const [virtual]

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

Reimplemented from AnimGroup.
Definition at line 135 of file animChannelScalarTable.cxx.
References compress_channels.

void AnimChannelScalarTable::write_datagram ( BamWriter * manager,

Datagram & me

) [virtual]

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

Reimplemented from AnimChannelBase.
Definition at line 159 of file animChannelScalarTable.cxx.
References _table, and cfloor().

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

int AnimChannelBase::_last_frame [protected, inherited]

Definition at line 65 of file animChannelBase.h.
Referenced by AnimChannelBase::AnimChannelBase(), AnimChannelBase::output(), and AnimChannelBase::write_datagram().

AnimBundle* AnimGroup::_root [protected, inherited]

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

CPTA_float AnimChannelScalarTable::_table [protected]

Definition at line 58 of file animChannelScalarTable.h.
Referenced by AnimChannelScalarTable(), has_changed(), has_table(), set_table(), and write_datagram().

TypeHandle AnimChannelScalarTable::_type_handle [static, private]

Reimplemented from AnimChannel< ACScalarSwitchType >.
Definition at line 34 of file animChannelScalarTable.cxx.