Panda3D
|
This is the base class for PartRoot and MovingPart. More...
#include "partGroup.h"
Public Types | |
enum | HierarchyMatchFlags { HMF_ok_part_extra = 0x01 , HMF_ok_anim_extra = 0x02 , HMF_ok_wrong_root_name = 0x04 } |
Public Member Functions | |
PartGroup (PartGroup *parent, const std::string &name) | |
Creates the PartGroup, and adds it to the indicated parent. | |
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 LVecBase3 &pos, const LVecBase3 &hpr, const LVecBase3 &scale) |
Freezes this particular joint so that it will always hold the specified transform. | |
virtual bool | apply_freeze_scalar (PN_stdfloat value) |
Freezes this particular joint so that it will always hold the specified transform. | |
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(). | |
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. | |
PartGroup * | copy_subgraph () const |
Allocates and returns a new copy of this node and of all of its children. | |
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. | |
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 LMatrix4 &mat, const LMatrix4 &inv_mat) |
Called by PartBundle::xform(), this indicates the indicated transform is being applied to the root joint. | |
PartGroup * | find_child (const std::string &name) const |
Returns the first descendant found with the indicated name, or NULL if no such descendant exists. | |
virtual TypeHandle | force_init_type () |
PartGroup * | get_child (int n) const |
PartGroup * | get_child_named (const std::string &name) const |
Returns the first child found with the indicated name, or NULL if no such child exists. | |
virtual AnimChannelBase * | get_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. | |
int | get_num_children () const |
virtual TypeHandle | get_type () const |
virtual TypeHandle | get_value_type () const |
Returns the TypeHandle associated with the ValueType we are concerned with. | |
virtual bool | is_character_joint () const |
Returns true if this part is a CharacterJoint, false otherwise. | |
virtual PartGroup * | make_copy () const |
Allocates and returns a new copy of the node. | |
void | sort_descendants () |
Sorts the children nodes at each level of the hierarchy into alphabetical order. | |
virtual void | write (std::ostream &out, int indent_level) const |
Writes a brief description of the group 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 (std::ostream &out, int indent_level) const |
Writes a brief description of the group, showing its current value, and that of all of its descendants. | |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
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. | |
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. | |
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. | |
UpdateSeq | get_bam_modified () const |
Returns the current bam_modified counter. | |
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= (const TypedWritable ©) |
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. | |
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. | |
![]() | |
TypedObject (const TypedObject ©)=default | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
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. | |
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. | |
TypedObject & | operator= (const TypedObject ©)=default |
![]() | |
void | operator delete (void *, void *) |
void | operator delete (void *ptr) |
void | operator delete[] (void *, void *) |
void | operator delete[] (void *ptr) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
![]() | |
int | get_ref_count () const |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
void | ref () const |
Explicitly increments the reference count. | |
bool | ref_if_nonzero () const |
Atomically increases the reference count of this object if it is not zero. | |
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. | |
bool | unref_if_one () const |
Atomically decreases the reference count of this object if it is one. | |
WeakReferenceList * | weak_ref () |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref () |
Removes the indicated PointerToVoid as a weak reference to this object. | |
![]() | |
Namable (const std::string &initial_name="") | |
void | clear_name () |
Resets the Namable's name to empty. | |
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. | |
void | output (std::ostream &out) const |
Outputs the Namable. | |
void | set_name (const std::string &name) |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
static TypedWritable * | make_PartGroup (const FactoryParams ¶ms) |
Factory method to generate a PartGroup object. | |
static void | register_with_read_factory () |
Factory method to generate a PartGroup object. | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data |
![]() | |
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. | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
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. | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes | |
get_child | |
Returns the nth child of the group. | |
get_num_children | |
Returns the number of child nodes of the group. | |
![]() | |
static BamReader * | reader = nullptr) |
![]() | |
get_type | |
![]() | |
get_ref_count | |
Returns the current reference count. | |
![]() | |
get_name | |
set_name | |
Friends | |
class | Character |
class | CharacterJointBundle |
class | PartBundle |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = nullptr |
This is the base class for PartRoot and MovingPart.
It defines a hierarchy of MovingParts.
Definition at line 43 of file partGroup.h.
enum PartGroup::HierarchyMatchFlags |
Definition at line 48 of file partGroup.h.
|
explicit |
Creates the PartGroup, and adds it to the indicated parent.
The only way to delete it subsequently is to delete the entire hierarchy.
Definition at line 36 of file partGroup.cxx.
|
virtual |
Definition at line 49 of file partGroup.cxx.
|
virtual |
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 normally only called internally by PartBundle::control_joint(), but you may also call it directly.
Reimplemented in MovingPartMatrix, and MovingPartScalar.
Definition at line 224 of file partGroup.cxx.
Referenced by PartBundle::control_joint().
bool PartGroup::apply_freeze | ( | const TransformState * | transform | ) |
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 184 of file partGroup.cxx.
References apply_freeze_matrix(), apply_freeze_scalar(), TransformState::get_hpr, TransformState::get_pos, and TransformState::get_scale.
Referenced by PartBundle::freeze_joint().
|
virtual |
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 MovingPartMatrix.
Definition at line 197 of file partGroup.cxx.
Referenced by apply_freeze(), and PartBundle::freeze_joint().
|
virtual |
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 210 of file partGroup.cxx.
Referenced by apply_freeze(), and PartBundle::freeze_joint().
bool PartGroup::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.
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 293 of file partGroup.cxx.
References check_hierarchy(), Thread::consider_yield(), AnimGroup::get_child, get_child, AnimGroup::get_child_named(), get_child_named(), AnimGroup::get_num_children, get_num_children, AnimGroup::get_value_type(), and get_value_type().
Referenced by check_hierarchy(), and PartBundle::do_bind_anim().
|
virtual |
Undoes the effect of a previous call to apply_freeze() or apply_control().
Returns true if the joint was modified, false otherwise.
This is normally only called internally by PartBundle::release_joint(), but you may also call it directly.
Reimplemented in MovingPartBase.
Definition at line 236 of file partGroup.cxx.
Referenced by PartBundle::release_joint().
|
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 TypedWritable.
Reimplemented in PartBundle, CharacterJoint, and MovingPartBase.
Definition at line 665 of file partGroup.cxx.
References TypedWritable::complete_pointers().
Referenced by PartBundle::complete_pointers(), and MovingPartBase::complete_pointers().
PartGroup * PartGroup::copy_subgraph | ( | ) | const |
Allocates and returns a new copy of this node and of all of its children.
Definition at line 74 of file partGroup.cxx.
References copy_subgraph(), and make_copy().
Referenced by copy_subgraph(), PT(), and PartBundleNode::xform().
|
virtual |
Should be called whenever the ChannelBlend values have changed, this recursively updates the _effective_channel member in each part.
Definition at line 502 of file partGroup.cxx.
Referenced by PartBundle::clear_control_effects(), PartBundle::control_removed(), and PartBundle::do_bind_anim().
|
virtual |
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 in MovingPartBase.
Definition at line 469 of file partGroup.cxx.
Referenced by PartBundle::finalize(), PartBundle::force_update(), and PartBundle::update().
|
virtual |
Called by PartBundle::xform(), this indicates the indicated transform is being applied to the root joint.
Reimplemented in CharacterJoint.
Definition at line 489 of file partGroup.cxx.
Referenced by CharacterJoint::do_xform(), and PartBundle::xform().
PartGroup * PartGroup::find_child | ( | const std::string & | name | ) | const |
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 135 of file partGroup.cxx.
References find_child().
Referenced by PartBundle::control_joint(), find_child(), Character::find_joint(), Character::find_slider(), PartBundle::freeze_joint(), PartBundle::freeze_joint(), PartBundle::freeze_joint(), and PartBundle::release_joint().
|
inlinevirtual |
Reimplemented from TypedWritableReferenceCount.
Definition at line 134 of file partGroup.h.
PartGroup * PartGroup::get_child_named | ( | const std::string & | name | ) | const |
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 117 of file partGroup.cxx.
Referenced by check_hierarchy().
|
inlinestatic |
Definition at line 135 of file partGroup.h.
|
virtual |
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 in MovingPartBase.
Definition at line 246 of file partGroup.cxx.
|
inlinevirtual |
Reimplemented from TypedWritableReferenceCount.
Definition at line 131 of file partGroup.h.
|
virtual |
Returns the TypeHandle associated with the ValueType we are concerned with.
This is provided to allow a bit of run-time checking that joints and channels are matching properly in type.
Reimplemented in MovingPart< SwitchType >, MovingPart< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and MovingPartBase.
Definition at line 280 of file partGroup.cxx.
Referenced by check_hierarchy().
|
inlinestatic |
Definition at line 140 of file partGroup.h.
|
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 in CharacterJoint.
Definition at line 57 of file partGroup.cxx.
Referenced by Character::find_joint(), CharacterMaker::part_to_node(), and CharacterJoint::update_internals().
|
virtual |
Allocates and returns a new copy of the node.
Children are not copied, but see copy_subgraph().
Reimplemented in PartBundle, CharacterJoint, and CharacterSlider.
Definition at line 66 of file partGroup.cxx.
Referenced by copy_subgraph().
|
static |
Factory method to generate a PartGroup object.
Definition at line 680 of file partGroup.cxx.
References parse_params().
Referenced by register_with_read_factory().
|
static |
Factory method to generate a PartGroup object.
Definition at line 694 of file partGroup.cxx.
References BamReader::get_factory(), make_PartGroup(), and Factory< Type >::register_factory().
void PartGroup::sort_descendants | ( | ) |
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 166 of file partGroup.cxx.
|
virtual |
Writes a brief description of the group and all of its descendants.
Reimplemented in MovingPartBase, and PartBundle.
Definition at line 255 of file partGroup.cxx.
References indent().
Function to write the important information in the particular object to a Datagram.
Reimplemented from TypedWritable.
Reimplemented in MovingPartBase, PartBundle, MovingPart< SwitchType >, MovingPart< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and CharacterJoint.
Definition at line 628 of file partGroup.cxx.
References Datagram::add_string(), Datagram::add_uint16(), and BamWriter::write_pointer().
Referenced by MovingPartBase::write_datagram(), and PartBundle::write_datagram().
|
virtual |
Writes a brief description of the group, showing its current value, and that of all of its descendants.
Reimplemented in MovingPartBase.
Definition at line 267 of file partGroup.cxx.
References indent().
Referenced by Character::write_part_values().
|
friend |
Definition at line 149 of file partGroup.h.
|
friend |
Definition at line 150 of file partGroup.h.
|
friend |
Definition at line 151 of file partGroup.h.
PartGroup * PartGroup::get_child |
Returns the nth child of the group.
Definition at line 72 of file partGroup.h.
Referenced by check_hierarchy().
int PartGroup::get_num_children |
Returns the number of child nodes of the group.
Definition at line 72 of file partGroup.h.
Referenced by check_hierarchy().