Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends

CharacterJoint Class Reference

This represents one joint of the character's animation, containing an animating transform matrix. More...

#include "characterJoint.h"

Inheritance diagram for CharacterJoint:
MovingPartMatrix MovingPart< ACMatrixSwitchType > MovingPartBase PartGroup TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

List of all members.

Public Types

typedef AnimChannel
< ACMatrixSwitchType
ChannelType
enum  HierarchyMatchFlags { HMF_ok_part_extra = 0x01, HMF_ok_anim_extra = 0x02, HMF_ok_wrong_root_name = 0x04 }
typedef
ACMatrixSwitchType::ValueType 
ValueType

Public Member Functions

 CharacterJoint (Character *character, PartBundle *root, PartGroup *parent, const string &name, const LMatrix4f &default_value)
bool add_local_transform (PandaNode *node)
 Adds the indicated node to the list of nodes that will be updated each frame with the joint's local transform from its parent.
bool add_net_transform (PandaNode *node)
 Adds the indicated node to the list of nodes that will be updated each frame with the joint's net transform from the root.
virtual bool apply_control (PandaNode *node)
 Specifies a node to influence this particular joint so that it will always hold the node's transform.
bool apply_freeze (const TransformState *transform)
 Freezes this particular joint so that it will always hold the specified transform.
virtual bool apply_freeze_matrix (const LVecBase3f &pos, const LVecBase3f &hpr, const LVecBase3f &scale)
 Freezes this particular joint so that it will always hold the specified transform.
virtual bool apply_freeze_scalar (float value)
 Freezes this particular joint so that it will always hold the specified transform.
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
bool check_hierarchy (const AnimGroup *anim, const PartGroup *parent, int hierarchy_match_flags=0) const
 Walks the part hierarchy in tandem with the indicated anim hierarchy, and returns true if the hierarchies match, false otherwise.
virtual bool clear_forced_channel ()
 Undoes the effect of a previous call to apply_freeze() or apply_control().
void clear_local_transforms ()
 Removes all nodes from the list of nodes that will be updated each frame with the joint's local transform from its parent.
void clear_name ()
 Resets the Namable's name to empty.
void clear_net_transforms ()
 Removes all nodes from the list of nodes that will be updated each frame with the joint's net transform from the root.
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Takes in a vector of pointers to TypedWritable objects that correspond to all the requests for pointers that this object made to BamReader.
PartGroupcopy_subgraph () const
 Allocates and returns a new copy of this node and of all of its children.
virtual bool do_update (PartBundle *root, const CycleData *root_cdata, PartGroup *parent, bool parent_changed, bool anim_changed, Thread *current_thread)
 Recursively update this particular part and all of its descendents for the current frame.
virtual void do_xform (const LMatrix4f &mat, const LMatrix4f &inv_mat)
 Called by PartBundle::xform(), this indicates the indicated transform is being applied to the root joint.
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.
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.
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.
PartGroupfind_child (const string &name) const
 Returns the first descendant found with the indicated name, or NULL if no such descendant exists.
virtual TypeHandle force_init_type ()
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter.
int get_best_parent_from_Set (const std::set< int > &) const
virtual void get_blend_value (const PartBundle *root)
 Attempts to blend the various matrix values indicated, and sets the _value member to the resulting matrix.
AnimChannelBaseget_bound (int n) const
 Returns the nth bound channel on this PartGroup.
Characterget_character () const
 Returns the Character that owns this joint.
PartGroupget_child (int n) const
 Returns the nth child of the group.
PartGroupget_child_named (const string &name) const
 Returns the first child found with the indicated name, or NULL if no such child exists.
ValueType get_default_value () const
virtual AnimChannelBaseget_forced_channel () const
 Returns the AnimChannelBase that has been forced to this joint by a previous call to apply_freeze() or apply_control(), or NULL if no such channel has been applied.
NodePathCollection get_local_transforms ()
 Returns a list of the local transforms set for this node.
int get_max_bound () const
 Returns the number of channels that might be bound to this PartGroup.
const string & get_name () const
void get_net_transform (LMatrix4f &transform) const
 Copies the joint's current net transform (composed from the root of the character joint hierarchy) into the indicated matrix.
NodePathCollection get_net_transforms ()
 Returns a list of the net transforms set for this node.
int get_num_children () const
 Returns the number of child nodes of the group.
int get_ref_count () const
 Returns the current reference count.
void get_transform (LMatrix4f &transform) const
 Copies the joint's current transform into the indicated matrix.
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
ValueType get_value () const
virtual TypeHandle get_value_type () const
 Returns the TypeHandle associated with the ValueType we are concerned with.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_local_transform (PandaNode *node) const
 Returns true if the node is on the list of nodes that will be updated each frame with the joint's local transform from its parent, false otherwise.
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty.
bool has_net_transform (PandaNode *node) const
 Returns true if the node is on the list of nodes that will be updated each frame with the joint's net transform from the root, false otherwise.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
virtual bool is_character_joint () const
 Returns true if this part is a CharacterJoint, false otherwise.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
virtual PartGroupmake_copy () const
 Allocates and returns a new copy of the node.
virtual AnimChannelBasemake_default_channel () const
 Creates and returns a new AnimChannel that is not part of any hierarchy, but that returns the default value associated with this part.
 MAKE_SEQ (get_children, get_num_children, get_child)
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
void operator delete (void *ptr)
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *, void *)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void output (ostream &out) const
 Outputs the Namable.
virtual void output_value (ostream &out) const
 PT (PandaNode) _geom_node
void ref () const
 Explicitly increments the reference count.
bool remove_local_transform (PandaNode *node)
 Removes the indicated node from the list of nodes that will be updated each frame with the joint's local transform from its parent.
bool remove_net_transform (PandaNode *node)
 Removes the indicated node from the list of nodes that will be updated each frame with the joint's net transform from the root.
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.
void set_name (const string &name)
void sort_descendants ()
 Sorts the children nodes at each level of the hierarchy into alphabetical order.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
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.
virtual bool update_internals (PartBundle *root, PartGroup *parent, bool self_changed, bool parent_changed, Thread *current_thread)
 This is called by do_update() whenever the part or some ancestor has changed values.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.
virtual void write (ostream &out, int indent_level) const
 Writes a brief description of the channel 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 void write_with_value (ostream &out, int indent_level) const
 Writes a brief description of the channel and all of its descendants, along with their values.

Static Public Member Functions

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.
static TypeHandle get_class_type ()
static void init_type ()
static TypedWritablemake_CharacterJoint (const FactoryParams &params)
 Factory method to generate a CharacterJoint object.
static TypedWritablemake_MovingPartMatrix (const FactoryParams &params)
 Factory method to generate a MovingPartMatrix object.
static TypedWritablemake_PartGroup (const FactoryParams &params)
 Factory method to generate a PartGroup object.
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
static void register_with_read_factory ()
 Factory method to generate a CharacterJoint object.

Public Attributes

ValueType _default_value
LMatrix4f _initial_net_transform_inverse
LMatrix4f _net_transform
ValueType _value
static BamReaderreader = NULL)

Static Public Attributes

static TypedWritable *const Null = (TypedWritable*)0L

Protected Types

typedef pvector< PT(AnimChannelBase) > Channels
typedef pvector< PT(PartGroup) > Children

Protected Member Functions

 CharacterJoint ()
 For internal use only.
 CharacterJoint (const CharacterJoint &copy)
virtual void bind_hierarchy (AnimGroup *anim, int channel_index, int &joint_index, bool is_included, BitArray &bound_joints, const PartSubset &subset)
 Binds the indicated anim hierarchy to the part hierarchy, at the given channel index number.
virtual void determine_effective_channels (const CycleData *root_cdata)
 Should be called whenever the ChannelBlend values have changed, this recursively updates the _effective_channel member in each part.
bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
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.
virtual void find_bound_joints (int &joint_index, bool is_included, BitArray &bound_joints, const PartSubset &subset)
 Similar to bind_hierarchy, but does not actually perform any binding.
virtual void pick_channel_index (plist< int > &holes, int &next) const
 Walks the part hierarchy, looking for a suitable channel index number to use.
 PT (AnimChannelBase) _effective_channel
void write_descendants (ostream &out, int indent_level) const
 Writes a brief description of all of the group's descendants.
void write_descendants_with_value (ostream &out, int indent_level) const
 Writes a brief description of all of the group's descendants and their values.

Protected Attributes

Channels _channels
Children _children
AnimControl_effective_control
int _num_effective_channels

Friends

class Character
class CharacterJointBundle
class JointVertexTransform

Detailed Description

This represents one joint of the character's animation, containing an animating transform matrix.

Definition at line 33 of file characterJoint.h.


Constructor & Destructor Documentation

CharacterJoint::CharacterJoint ( ) [protected]

For internal use only.

Definition at line 32 of file characterJoint.cxx.

Referenced by make_CharacterJoint(), and make_copy().


Member Function Documentation

bool CharacterJoint::add_local_transform ( PandaNode node)

Adds the indicated node to the list of nodes that will be updated each frame with the joint's local transform from its parent.

Returns true if the node is successfully added, false if it had already been added.

The Character pointer should be the Character object that owns this joint; this will be used to create a CharacterJointEffect for this node. If it is NULL, no such effect will be created.

A CharacterJointEffect for this joint's Character will automatically be added to the specified node.

Definition at line 325 of file characterJoint.cxx.

References Thread::get_current_thread(), PandaNode::set_effect(), and PandaNode::set_transform().

bool CharacterJoint::add_net_transform ( PandaNode node)

Adds the indicated node to the list of nodes that will be updated each frame with the joint's net transform from the root.

Returns true if the node is successfully added, false if it had already been added.

A CharacterJointEffect for this joint's Character will automatically be added to the specified node.

Definition at line 215 of file characterJoint.cxx.

References Thread::get_current_thread(), PandaNode::set_effect(), and PandaNode::set_transform().

bool MovingPartMatrix::apply_control ( PandaNode node) [virtual, inherited]

Specifies a node to influence this particular joint so that it will always hold the node's transform.

Returns true if this is a joint that can be so controlled, false otherwise. This is called internally by PartBundle::control_joint().

Reimplemented from PartGroup.

Definition at line 402 of file movingPartMatrix.cxx.

References AnimChannelMatrixDynamic::set_value_node().

bool PartGroup::apply_freeze ( const TransformState transform) [inherited]

Freezes this particular joint so that it will always hold the specified transform.

Returns true if this is a joint that can be so frozen, false otherwise.

This is normally only called internally by PartBundle::freeze_joint(), but you may also call it directly.

Definition at line 185 of file partGroup.cxx.

References PartGroup::apply_freeze_matrix(), PartGroup::apply_freeze_scalar(), TransformState::get_hpr(), TransformState::get_pos(), and TransformState::get_scale().

Referenced by PartBundle::freeze_joint().

bool MovingPartMatrix::apply_freeze_matrix ( const LVecBase3f pos,
const LVecBase3f hpr,
const LVecBase3f scale 
) [virtual, inherited]

Freezes this particular joint so that it will always hold the specified transform.

Returns true if this is a joint that can be so frozen, false otherwise. This is called internally by PartBundle::freeze_joint().

Reimplemented from PartGroup.

Definition at line 387 of file movingPartMatrix.cxx.

bool PartGroup::apply_freeze_scalar ( float  value) [virtual, inherited]

Freezes this particular joint so that it will always hold the specified transform.

Returns true if this is a joint that can be so frozen, false otherwise.

This is normally only called internally by PartBundle::freeze_joint(), but you may also call it directly.

Reimplemented in MovingPartScalar.

Definition at line 217 of file partGroup.cxx.

Referenced by PartGroup::apply_freeze(), and PartBundle::freeze_joint().

ReferenceCount * TypedWritableReferenceCount::as_reference_count ( ) [virtual, inherited]

Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

Reimplemented from TypedWritable.

Definition at line 26 of file typedWritableReferenceCount.cxx.

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

void MovingPartBase::bind_hierarchy ( AnimGroup anim,
int  channel_index,
int &  joint_index,
bool  is_included,
BitArray bound_joints,
const PartSubset subset 
) [protected, virtual, inherited]

Binds the indicated anim hierarchy to the part hierarchy, at the given channel index number.

Reimplemented from PartGroup.

Definition at line 260 of file movingPartBase.cxx.

References BitArray::clear_bit(), PartSubset::matches_exclude(), PartSubset::matches_include(), and BitArray::set_bit().

bool PartGroup::check_hierarchy ( const AnimGroup anim,
const PartGroup parent,
int  hierarchy_match_flags = 0 
) const [inherited]

Walks the part hierarchy in tandem with the indicated anim hierarchy, and returns true if the hierarchies match, false otherwise.

If hierarchy_match_flags is 0, only an exact match is accepted; otherwise, it may contain a union of PartGroup::HierarchyMatchFlags values indicating conditions that will be tolerated (but warnings will still be issued).

Definition at line 323 of file partGroup.cxx.

References PartGroup::check_hierarchy(), Thread::consider_yield(), AnimGroup::get_child(), PartGroup::get_child(), PartGroup::get_child_named(), AnimGroup::get_child_named(), PartGroup::get_num_children(), AnimGroup::get_num_children(), AnimGroup::get_value_type(), and PartGroup::get_value_type().

Referenced by PartGroup::check_hierarchy(), and PartBundle::do_bind_anim().

bool MovingPartBase::clear_forced_channel ( ) [virtual, inherited]

Undoes the effect of a previous call to apply_freeze() or apply_control().

Returns true if the joint was modified, false otherwise.

Reimplemented from PartGroup.

Definition at line 59 of file movingPartBase.cxx.

void CharacterJoint::clear_local_transforms ( )

Removes all nodes from the list of nodes that will be updated each frame with the joint's local transform from its parent.

Definition at line 377 of file characterJoint.cxx.

References ordered_vector< Key, Compare >::begin(), ordered_vector< Key, Compare >::clear(), PandaNode::clear_effect(), ordered_vector< Key, Compare >::end(), get_character(), and PandaNode::get_effect().

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

Resets the Namable's name to empty.

Reimplemented in AsyncTask.

Definition at line 64 of file namable.I.

void CharacterJoint::clear_net_transforms ( )

Removes all nodes from the list of nodes that will be updated each frame with the joint's net transform from the root.

Definition at line 267 of file characterJoint.cxx.

References ordered_vector< Key, Compare >::begin(), ordered_vector< Key, Compare >::clear(), PandaNode::clear_effect(), ordered_vector< Key, Compare >::end(), get_character(), and PandaNode::get_effect().

int CharacterJoint::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
) [virtual]

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

Reimplemented from MovingPartBase.

Definition at line 575 of file characterJoint.cxx.

References BamReader::get_file_minor_ver().

PartGroup * PartGroup::copy_subgraph ( ) const [inherited]

Allocates and returns a new copy of this node and of all of its children.

Definition at line 86 of file partGroup.cxx.

References PartGroup::copy_subgraph(), and PartGroup::make_copy().

Referenced by Character::Character(), PartGroup::copy_subgraph(), and PartBundleNode::xform().

bool TypedWritable::decode_raw_from_bam_stream ( TypedWritable *&  ptr,
ReferenceCount *&  ref_ptr,
const string &  data,
BamReader reader = NULL 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.

Returns true on success, false on on error.

This variant sets the TypedWritable and ReferenceCount pointers separately; both are pointers to the same object. The reference count is not incremented; it is the caller's responsibility to manage the reference count.

Note that this method cannot be used to retrieve objects that do not inherit from ReferenceCount, because these objects cannot persist beyond the lifetime of the BamReader that reads them. To retrieve these objects from a bam stream, you must construct a BamReader directly.

If you happen to know that the particular object in question inherits from TypedWritableReferenceCount or PandaNode, consider calling the variant of decode_from_bam_stream() defined for those methods, which presents a simpler interface.

Definition at line 353 of file typedWritable.cxx.

References BamReader::init(), DatagramInputFile::open(), DatagramInputFile::read_header(), BamReader::read_object(), ReferenceCount::ref(), BamReader::resolve(), BamReader::set_source(), and ReferenceCount::unref().

void MovingPartBase::determine_effective_channels ( const CycleData root_cdata) [protected, virtual, inherited]

Should be called whenever the ChannelBlend values have changed, this recursively updates the _effective_channel member in each part.

Reimplemented from PartGroup.

Definition at line 337 of file movingPartBase.cxx.

References AnimControl::get_channel_index().

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

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

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

bool MovingPartBase::do_update ( PartBundle root,
const CycleData root_cdata,
PartGroup parent,
bool  parent_changed,
bool  anim_changed,
Thread current_thread 
) [virtual, inherited]

Recursively update this particular part and all of its descendents for the current frame.

This is not really public and is not intended to be called directly; it is called from the top of the tree by PartBundle::update().

The return value is true if any part has changed, false otherwise.

Reimplemented from PartGroup.

Definition at line 132 of file movingPartBase.cxx.

References AnimControl::channel_has_changed(), AnimControl::get_channel_index(), and MovingPartBase::update_internals().

void CharacterJoint::do_xform ( const LMatrix4f mat,
const LMatrix4f inv_mat 
) [virtual]

Called by PartBundle::xform(), this indicates the indicated transform is being applied to the root joint.

Reimplemented from PartGroup.

Definition at line 194 of file characterJoint.cxx.

string TypedWritable::encode_to_bam_stream ( ) const [inline, inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.

Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 86 of file typedWritable.I.

bool TypedWritable::encode_to_bam_stream ( string &  data,
BamWriter writer = NULL 
) const [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 283 of file typedWritable.cxx.

References BamWriter::init(), DatagramOutputFile::open(), BamWriter::set_target(), DatagramOutputFile::write_header(), and BamWriter::write_object().

void CharacterJoint::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual]

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 MovingPart< ACMatrixSwitchType >.

Definition at line 546 of file characterJoint.cxx.

References BamReader::get_file_minor_ver(), DatagramIterator::get_uint16(), LMatrix4f::read_datagram(), and BamReader::read_pointer().

Referenced by make_CharacterJoint().

void TypedWritable::finalize ( BamReader manager) [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, Geom, GeomPrimitive, GeomVertexArrayData, GeomVertexArrayFormat, GeomVertexData, InternalName, GeomNode, LightAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderState, PaletteGroup, and Palettizer.

Definition at line 145 of file typedWritable.cxx.

Referenced by BamReader::finalize_now().

void MovingPartBase::find_bound_joints ( int &  joint_index,
bool  is_included,
BitArray bound_joints,
const PartSubset subset 
) [protected, virtual, inherited]

Similar to bind_hierarchy, but does not actually perform any binding.

All it does is compute the BitArray bount_joints according to the specified subset. This is useful in preparation for asynchronous binding--in this case, we may need to know bound_joints immediately, without having to wait for the animation itself to load and bind.

Reimplemented from PartGroup.

Definition at line 315 of file movingPartBase.cxx.

References PartSubset::matches_exclude(), PartSubset::matches_include(), and BitArray::set_bit_to().

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

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 PartGroup; see also get_child_named().

Definition at line 157 of file partGroup.cxx.

References PartGroup::find_child().

Referenced by PartBundle::control_joint(), PartGroup::find_child(), Character::find_joint(), Character::find_slider(), PartBundle::freeze_joint(), and PartBundle::release_joint().

UpdateSeq TypedWritable::get_bam_modified ( ) const [inline, inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

Definition at line 66 of file typedWritable.I.

Referenced by BamWriter::consider_update(), and BamWriter::write_pointer().

void MovingPartMatrix::get_blend_value ( const PartBundle root) [virtual, inherited]
AnimChannelBase * MovingPartBase::get_bound ( int  n) const [inline, inherited]

Returns the nth bound channel on this PartGroup.

n can be determined by iterating from 0 to one less than get_max_bound(); or n might be AnimControl::get_channel_index().

This will return NULL if there is no channel bound on the indicated index. It is an error to call this if n is less than zero or greater than or equal to get_max_bound().

Definition at line 62 of file movingPartBase.I.

Character * CharacterJoint::get_character ( ) const

Returns the Character that owns this joint.

Definition at line 446 of file characterJoint.cxx.

Referenced by clear_local_transforms(), clear_net_transforms(), remove_local_transform(), and remove_net_transform().

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

Returns the nth child of the group.

Definition at line 121 of file partGroup.cxx.

Referenced by PartGroup::bind_hierarchy(), PartGroup::check_hierarchy(), and PartGroup::find_bound_joints().

PartGroup * PartGroup::get_child_named ( const string &  name) const [inherited]

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 PartGroup; it does not recursively search the entire graph. See also find_child().

Definition at line 136 of file partGroup.cxx.

Referenced by PartGroup::check_hierarchy().

AnimChannelBase * MovingPartBase::get_forced_channel ( ) const [virtual, inherited]

Returns the AnimChannelBase that has been forced to this joint by a previous call to apply_freeze() or apply_control(), or NULL if no such channel has been applied.

Reimplemented from PartGroup.

Definition at line 76 of file movingPartBase.cxx.

NodePathCollection CharacterJoint::get_local_transforms ( )

Returns a list of the local transforms set for this node.

Note that this returns a list of NodePaths, even though the local transforms are actually a list of PandaNodes.

Definition at line 403 of file characterJoint.cxx.

References NodePathCollection::add_path(), NodePath::any_path(), ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().

int MovingPartBase::get_max_bound ( ) const [inline, inherited]

Returns the number of channels that might be bound to this PartGroup.

This might not be the actual number of channels, since there might be holes in the list; it is one more than the index number of the highest bound channel. Thus, it is called get_max_bound() instead of get_num_bound().

Definition at line 44 of file movingPartBase.I.

void CharacterJoint::get_net_transform ( LMatrix4f transform) const

Copies the joint's current net transform (composed from the root of the character joint hierarchy) into the indicated matrix.

Definition at line 436 of file characterJoint.cxx.

NodePathCollection CharacterJoint::get_net_transforms ( )

Returns a list of the net transforms set for this node.

Note that this returns a list of NodePaths, even though the net transforms are actually a list of PandaNodes.

Definition at line 293 of file characterJoint.cxx.

References NodePathCollection::add_path(), NodePath::any_path(), ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().

int PartGroup::get_num_children ( ) const [inherited]

Returns the number of child nodes of the group.

Definition at line 110 of file partGroup.cxx.

Referenced by PartGroup::bind_hierarchy(), PartGroup::check_hierarchy(), and PartGroup::find_bound_joints().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
void CharacterJoint::get_transform ( LMatrix4f transform) const

Copies the joint's current transform into the indicated matrix.

Definition at line 424 of file characterJoint.cxx.

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 52 of file typedObject.I.

References TypeHandle::get_index().

virtual TypeHandle MovingPart< ACMatrixSwitchType >::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.

Implements MovingPartBase.

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool CharacterJoint::has_local_transform ( PandaNode node) const

Returns true if the node is on the list of nodes that will be updated each frame with the joint's local transform from its parent, false otherwise.

Definition at line 365 of file characterJoint.cxx.

References ordered_vector< Key, Compare >::count().

bool Namable::has_name ( ) const [inline, inherited]
bool CharacterJoint::has_net_transform ( PandaNode node) const

Returns true if the node is on the list of nodes that will be updated each frame with the joint's net transform from the root, false otherwise.

Definition at line 255 of file characterJoint.cxx.

References ordered_vector< Key, Compare >::count().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

bool CharacterJoint::is_character_joint ( ) const [virtual]

Returns true if this part is a CharacterJoint, false otherwise.

This is a tiny optimization over is_of_type(CharacterType::get_class_type()).

Reimplemented from PartGroup.

Definition at line 94 of file characterJoint.cxx.

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
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 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

TypedWritable * CharacterJoint::make_CharacterJoint ( const FactoryParams params) [static]

Factory method to generate a CharacterJoint object.

Definition at line 604 of file characterJoint.cxx.

References CharacterJoint(), and fillin().

Referenced by register_with_read_factory().

PartGroup * CharacterJoint::make_copy ( ) const [virtual]

Allocates and returns a new copy of the node.

Children are not copied, but see copy_subgraph().

Reimplemented from PartGroup.

Definition at line 105 of file characterJoint.cxx.

References CharacterJoint().

AnimChannelBase * MovingPartMatrix::make_default_channel ( ) const [virtual, inherited]

Creates and returns a new AnimChannel that is not part of any hierarchy, but that returns the default value associated with this part.

Reimplemented from MovingPart< ACMatrixSwitchType >.

Definition at line 50 of file movingPartMatrix.cxx.

TypedWritable * MovingPartMatrix::make_MovingPartMatrix ( const FactoryParams params) [static, inherited]

Factory method to generate a MovingPartMatrix object.

Definition at line 415 of file movingPartMatrix.cxx.

References MovingPart< SwitchType >::fillin().

Referenced by MovingPartMatrix::register_with_read_factory().

TypedWritable * PartGroup::make_PartGroup ( const FactoryParams params) [static, inherited]

Factory method to generate a PartGroup object.

Definition at line 773 of file partGroup.cxx.

References PartGroup::fillin(), and PartGroup::PartGroup().

Referenced by PartGroup::register_with_read_factory().

void TypedWritable::mark_bam_modified ( ) [inline, inherited]
void Namable::output ( ostream &  out) const [inline, inherited]
void MovingPartBase::pick_channel_index ( plist< int > &  holes,
int &  next 
) const [protected, virtual, inherited]

Walks the part hierarchy, looking for a suitable channel index number to use.

Available index numbers are the elements of the holes set, as well as next to infinity.

Reimplemented from PartGroup.

Definition at line 217 of file movingPartBase.cxx.

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

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void CharacterJoint::register_with_read_factory ( ) [static]

Factory method to generate a CharacterJoint object.

Reimplemented from MovingPartMatrix.

Definition at line 620 of file characterJoint.cxx.

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

bool CharacterJoint::remove_local_transform ( PandaNode node)

Removes the indicated node from the list of nodes that will be updated each frame with the joint's local transform from its parent.

Returns true if the node is successfully removed, false if it was not on the list.

If the node has a CharacterJointEffect that matches this joint's Character, it will be cleared.

Definition at line 347 of file characterJoint.cxx.

References PandaNode::clear_effect(), get_character(), and PandaNode::get_effect().

bool CharacterJoint::remove_net_transform ( PandaNode node)

Removes the indicated node from the list of nodes that will be updated each frame with the joint's net transform from the root.

Returns true if the node is successfully removed, false if it was not on the list.

If the node has a CharacterJointEffect that matches this joint's Character, it will be cleared.

Definition at line 237 of file characterJoint.cxx.

References PandaNode::clear_effect(), get_character(), and PandaNode::get_effect().

bool TypedWritable::require_fully_complete ( ) const [virtual, inherited]

Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).

Reimplemented in GeomVertexData, ClipPlaneAttrib, and RenderEffects.

Definition at line 118 of file typedWritable.cxx.

void PartGroup::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 300 of file partGroup.cxx.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

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

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, 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.) 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 true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void TypedWritable::update_bam_nested ( BamWriter manager) [virtual, inherited]

Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

Reimplemented in CFDoCullCommand, and PandaNode.

Definition at line 77 of file typedWritable.cxx.

bool CharacterJoint::update_internals ( PartBundle root,
PartGroup parent,
bool  self_changed,
bool  parent_changed,
Thread current_thread 
) [virtual]

This is called by do_update() whenever the part or some ancestor has changed values.

It is a hook for derived classes to update whatever cache they may have that depends on these.

The return value is true if the part has changed as a result of the update, or false otherwise.

In the case of a CharacterJoint, of course, it means to recompute the joint angles and associated transforms for this particular joint.

Reimplemented from MovingPartBase.

Definition at line 125 of file characterJoint.cxx.

References ordered_vector< Key, Compare >::begin(), ordered_vector< Key, Compare >::empty(), ordered_vector< Key, Compare >::end(), PartBundle::get_root_xform(), PartGroup::is_character_joint(), and PandaNode::set_transform().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().

void MovingPartBase::write ( ostream &  out,
int  indent_level 
) const [virtual, inherited]

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

Reimplemented from PartGroup.

Definition at line 87 of file movingPartBase.cxx.

References MovingPartBase::get_value_type(), and PartGroup::write_descendants().

void CharacterJoint::write_datagram ( BamWriter manager,
Datagram me 
) [virtual]
void PartGroup::write_descendants ( ostream &  out,
int  indent_level 
) const [protected, inherited]

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

Definition at line 585 of file partGroup.cxx.

Referenced by MovingPartBase::write(), PartBundle::write(), and PartGroup::write().

void PartGroup::write_descendants_with_value ( ostream &  out,
int  indent_level 
) const [protected, inherited]

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

Definition at line 600 of file partGroup.cxx.

Referenced by PartGroup::write_with_value(), and MovingPartBase::write_with_value().

void MovingPartBase::write_with_value ( ostream &  out,
int  indent_level 
) const [virtual, inherited]

Writes a brief description of the channel and all of its descendants, along with their values.

Reimplemented from PartGroup.

Definition at line 105 of file movingPartBase.cxx.

References MovingPartBase::get_value_type(), and PartGroup::write_descendants_with_value().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations