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

AnimChannelFixed< SwitchType > Class Template Reference

This template class is a special kind of AnimChannel that always returns just one fixed value. More...

#include <animChannelFixed.h>

Inheritance diagram for AnimChannelFixed< SwitchType >:

AnimChannel< SwitchType > AnimChannelBase AnimGroup TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject List of all members.

Public Types

typedef TYPENAME AnimChannel<
SwitchType >::ValueType 		ValueType

Public Member Functions

 AnimChannelFixed (AnimGroup *parent, const string &name, const ValueType &value)
 This is the flavor of AnimChannelFixed that puts it in a hierarchy.

 AnimChannelFixed (const string &name, const ValueType &value)
 This flavor creates an AnimChannelFixed that is not in a hierarchy.

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, ValueType &value)
virtual void output (ostream &out) const
 Writes a one-line description of the channel.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
virtual void get_value_no_scale (int frame, ValueType &value)
 Returns the value associated with the current frame, with no scale components.

virtual void get_scale (int frame, float scale[3])
 Returns the x, y, and z scale components associated with the current frame.

virtual TypeHandle get_value_type () const
 Returns the TypeHandle associated with the ValueType we return.

virtual void write_datagram (BamWriter *manager, Datagram &me)
 Function to write the important information in the particular object to a Datagram.

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

TypeHandle get_class_type ()
void init_type ()
void register_with_read_factory (void)
 Factory method to generate a AnimGroup object.

TypedWritable * make_AnimGroup (const FactoryParams &params)
 Factory method to generate a AnimGroup object.


Public Attributes

ValueType _value

Static Public Attributes

TypedWritable *const Null = (TypedWritable*)0L

Protected Types

typedef pvector< PointerTo<
AnimGroup > > 		Children

Protected Member Functions

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

int _last_frame
Children _children
AnimBundle * _root

Static Private Attributes

TypeHandle _type_handle

Detailed Description

template<class SwitchType>
class AnimChannelFixed< SwitchType >

This template class is a special kind of AnimChannel that always returns just one fixed value.

It is a special channel, in that it need not be assigned within a hierarchy. It may stand alone, so that it may be created on-the-fly for parts that need default anims to bind against.

Definition at line 48 of file animChannelFixed.h.

Member Typedef Documentation

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

Definition at line 78 of file animGroup.h.

template<class SwitchType>
typedef TYPENAME AnimChannel<SwitchType>::ValueType AnimChannelFixed< SwitchType >::ValueType
 

Reimplemented from AnimChannel< SwitchType >.

Definition at line 50 of file animChannelFixed.h.

Constructor & Destructor Documentation

template<class SwitchType>
AnimChannelFixed< SwitchType >::AnimChannelFixed (  AnimGroup *  parent,
const string &  name,
const ValueType &  value
)  [inline]
 

This is the flavor of AnimChannelFixed that puts it in a hierarchy.

Definition at line 37 of file animChannelFixed.I.

References INLINE.

template<class SwitchType>
AnimChannelFixed< SwitchType >::AnimChannelFixed (  const string &  name,
const ValueType &  value
)  [inline]
 

This flavor creates an AnimChannelFixed that is not in a hierarchy.

Definition at line 56 of file animChannelFixed.I.

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 AnimChannelBase::fillin (  DatagramIterator &  scan,
BamReader *  manager
)  [protected, inherited]
 

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.

Reimplemented in AnimChannelMatrixXfmTable, and AnimChannelScalarTable.

Definition at line 96 of file animChannelBase.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().

template<class SwitchType>
virtual TypeHandle AnimChannelFixed< SwitchType >::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from AnimChannel< SwitchType >.

Definition at line 66 of file animChannelFixed.h.

References AnimChannelFixed< SwitchType >::_type_handle.

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.

template<class SwitchType>
TypeHandle AnimChannelFixed< SwitchType >::get_class_type (  void   )  [inline, static]
 

Reimplemented from AnimChannel< SwitchType >.

Definition at line 67 of file animChannelFixed.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 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().

template<class SwitchType>
void AnimChannel< SwitchType >::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.

Reimplemented in AnimChannelMatrixXfmTable.

Definition at line 134 of file animChannel.I.

template<class SwitchType>
virtual TypeHandle AnimChannelFixed< SwitchType >::get_type (  void   )  const [inline, virtual]
 

Reimplemented from AnimChannel< SwitchType >.

Definition at line 63 of file animChannelFixed.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.

template<class SwitchType>
void AnimChannelFixed< SwitchType >::get_value (  int  frame,
ValueType &  value
)  [virtual]
 

Implements AnimChannel< SwitchType >.

Definition at line 85 of file animChannelFixed.I.

template<class SwitchType>
void AnimChannel< SwitchType >::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.

Definition at line 116 of file animChannel.I.

template<class SwitchType>
TypeHandle AnimChannel< SwitchType >::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.

Definition at line 157 of file animChannel.I.

template<class SwitchType>
bool AnimChannelFixed< SwitchType >::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 71 of file animChannelFixed.I.

References AnimChannelFixed< SwitchType >::_value.

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

template<class SwitchType>
void AnimChannelFixed< SwitchType >::init_type (  void   )  [inline, static]
 

Reimplemented from AnimChannel< SwitchType >.

Definition at line 70 of file animChannelFixed.h.

Referenced by MovingPartScalar::get_type().

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 * AnimGroup::make_AnimGroup (  const FactoryParams &  params  )  [static, inherited]
 

Factory method to generate a AnimGroup object.

Definition at line 309 of file animGroup.cxx.

template<class SwitchType>
void AnimChannelFixed< SwitchType >::output (  ostream &  out  )  const [virtual]
 

Writes a one-line description of the channel.

Reimplemented from AnimChannelBase.

Definition at line 99 of file animChannelFixed.I.

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 AnimGroup::register_with_read_factory (  void   )  [static, inherited]
 

Factory method to generate a AnimGroup object.

Reimplemented in AnimBundle, AnimChannelMatrixXfmTable, and AnimChannelScalarTable.

Definition at line 329 of file animGroup.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 AnimChannelBase::write_datagram (  BamWriter *  manager,
Datagram &  me
)  [virtual, inherited]
 

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

Reimplemented from AnimGroup.

Reimplemented in AnimChannelMatrixXfmTable, and AnimChannelScalarTable.

Definition at line 75 of file animChannelBase.cxx.

References AnimChannelBase::_last_frame, AnimGroup::fillin(), 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().

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 AnimChannelScalarTable::get_value().

template<class SwitchType>
TypeHandle AnimChannelFixed< SwitchType >::_type_handle [static, private]
 

Reimplemented from AnimChannel< SwitchType >.

Definition at line 23 of file animChannelFixed.I.

Referenced by AnimChannelFixed< SwitchType >::force_init_type().

template<class SwitchType>
ValueType AnimChannelFixed< SwitchType >::_value
 

Definition at line 60 of file animChannelFixed.h.

Referenced by AnimChannelFixed< SwitchType >::has_changed().

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:
Generated on Fri May 2 00:47:23 2003 for Panda by doxygen1.3