Panda3D
Public Types | Public Member Functions | Static Public Member Functions | List of all members
AnimChannel< SwitchType > Class Template Referenceabstract

This template class is the parent class for all kinds of AnimChannels that return different values. More...

#include "animChannel.h"

Inheritance diagram for AnimChannel< SwitchType >:
AnimChannelBase AnimGroup TypedWritableReferenceCount Namable TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase AnimChannelFixed< SwitchType > AnimChannelScalarDynamic AnimChannelScalarTable

Public Types

typedef SwitchType::ValueType ValueType
 

Public Member Functions

 AnimChannel (AnimGroup *parent, const std::string &name)
 This is the normal constructor, which automatically places the AnimChannel in the previously-created hierarchy. More...
 
virtual TypeHandle force_init_type ()
 
virtual void get_hpr (int frame, LVecBase3 &hpr)
 Returns the h, p, and r components associated with the current frame. More...
 
virtual void get_pos (int frame, LVecBase3 &pos)
 Returns the x, y, and z translation components associated with the current frame. More...
 
virtual void get_quat (int frame, LQuaternion &quat)
 Returns the rotation component associated with the current frame, expressed as a quaternion. More...
 
virtual void get_scale (int frame, LVecBase3 &scale)
 Returns the x, y, and z scale components associated with the current frame. More...
 
virtual void get_shear (int frame, LVecBase3 &shear)
 Returns the a, b, and c shear components associated with the current frame. More...
 
virtual TypeHandle get_type () const
 
virtual void get_value (int frame, ValueType &value)=0
 
virtual void get_value_no_scale_shear (int frame, ValueType &value)
 Returns the value associated with the current frame, with no scale or share components. More...
 
virtual TypeHandle get_value_type () const
 Returns the TypeHandle associated with the ValueType we return. More...
 
- Public Member Functions inherited from AnimChannelBase
 AnimChannelBase (AnimGroup *parent, const std::string &name)
 This is the normal constructor, which automatically places the AnimChannel in the previously-created hierarchy. More...
 
virtual bool has_changed (int last_frame, double last_frac, int this_frame, double this_frac)
 Returns true if the value has changed since the last call to has_changed(). More...
 
virtual void write_datagram (BamWriter *manager, Datagram &me)
 Function to write the important information in the particular object to a Datagram. 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 void output (std::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 (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 Public Member Functions inherited from AnimChannelBase
static TypeHandle get_class_type ()
 
static void init_type ()
 
- 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 ()
 

Additional Inherited Members

- 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
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

template<class SwitchType>
class AnimChannel< SwitchType >

This template class is the parent class for all kinds of AnimChannels that return different values.

Definition at line 28 of file animChannel.h.

Constructor & Destructor Documentation

◆ AnimChannel()

template<class SwitchType >
AnimChannel< SwitchType >::AnimChannel ( AnimGroup parent,
const std::string &  name 
)
inline

This is the normal constructor, which automatically places the AnimChannel in the previously-created hierarchy.

Definition at line 51 of file animChannel.I.

Member Function Documentation

◆ get_hpr()

template<class SwitchType >
void AnimChannel< SwitchType >::get_hpr ( int  frame,
LVecBase3 &  hpr 
)
virtual

Returns the h, p, and r components associated with the current frame.

As above, this only makes sense for a matrix-type channel.

Reimplemented in AnimChannelMatrixDynamic, AnimChannelMatrixXfmTable, and AnimChannelMatrixFixed.

Definition at line 90 of file animChannel.I.

◆ get_pos()

template<class SwitchType >
void AnimChannel< SwitchType >::get_pos ( int  frame,
LVecBase3 &  pos 
)
virtual

Returns the x, y, and z translation components associated with the current frame.

As above, this only makes sense for a matrix-type channel.

Reimplemented in AnimChannelMatrixDynamic, AnimChannelMatrixXfmTable, and AnimChannelMatrixFixed.

Definition at line 111 of file animChannel.I.

◆ get_quat()

template<class SwitchType >
void AnimChannel< SwitchType >::get_quat ( int  frame,
LQuaternion &  quat 
)
virtual

Returns the rotation component associated with the current frame, expressed as a quaternion.

As above, this only makes sense for a matrix-type channel.

Reimplemented in AnimChannelMatrixDynamic, AnimChannelMatrixXfmTable, and AnimChannelMatrixFixed.

Definition at line 101 of file animChannel.I.

◆ get_scale()

template<class SwitchType >
void AnimChannel< SwitchType >::get_scale ( int  frame,
LVecBase3 &  scale 
)
virtual

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 AnimChannelMatrixDynamic, AnimChannelMatrixXfmTable, and AnimChannelMatrixFixed.

Definition at line 80 of file animChannel.I.

◆ get_shear()

template<class SwitchType >
void AnimChannel< SwitchType >::get_shear ( int  frame,
LVecBase3 &  shear 
)
virtual

Returns the a, b, and c shear components associated with the current frame.

As above, this only makes sense for a matrix-type channel.

Reimplemented in AnimChannelMatrixDynamic, AnimChannelMatrixXfmTable, and AnimChannelMatrixFixed.

Definition at line 121 of file animChannel.I.

◆ get_value_no_scale_shear()

template<class SwitchType >
void AnimChannel< SwitchType >::get_value_no_scale_shear ( int  frame,
ValueType &  value 
)
virtual

Returns the value associated with the current frame, with no scale or share components.

This only makes sense for a matrix-type channel, although for fiddly technical reasons the function exists for all channels.

Definition at line 70 of file animChannel.I.

◆ get_value_type()

template<class SwitchType >
TypeHandle AnimChannel< SwitchType >::get_value_type ( ) const
virtual

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 133 of file animChannel.I.


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