This is the base class for PartRoot and MovingPart. More...

#include "partGroup.h"

Inheritance diagram for PartGroup:

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 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 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
	Returns the nth child of the group.
PartGroup *	get_child_named (const 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
	Returns the number of child nodes of the group.
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.
	MAKE_SEQ (get_children, get_num_children, get_child)
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 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 group, showing its current value, and that of all of its descendants.
Static Public Member Functions
static TypeHandle	get_class_type ()
static void	init_type ()
static TypedWritable *	make_PartGroup (const FactoryParams &params)
	Factory method to generate a PartGroup object.
static void	register_with_read_factory ()
	Factory method to generate a PartGroup object.
Protected Types
typedef pvector< PT(PartGroup) >	Children
Protected Member Functions
	PartGroup (const string &name="")
	This constructor is only intended for interal use and for derived classes.
	PartGroup (const PartGroup &copy)
	This constructor is only intended for interal use and for derived classes.
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.
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.
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
Children	_children
Friends
class	Character
class	CharacterJointBundle
class	PartBundle

Detailed Description

This is the base class for PartRoot and MovingPart.

It defines a hierarchy of MovingParts.

Definition at line 45 of file partGroup.h.

Constructor & Destructor Documentation

PartGroup::PartGroup ( const string & name = "" ) [inline, protected]

This constructor is only intended for interal use and for derived classes.

You should normally use the non-default constructor, below.

Definition at line 24 of file partGroup.I.

Referenced by make_copy(), and make_PartGroup().

PartGroup::PartGroup ( const PartGroup & copy ) [inline, protected]

This constructor is only intended for interal use and for derived classes.

You should normally use the make_copy() interface to make copies..

Definition at line 38 of file partGroup.I.

PartGroup::PartGroup	(	PartGroup *	parent,
		const string &	name
	)

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 38 of file partGroup.cxx.

Member Function Documentation

bool PartGroup::apply_control ( PandaNode * node ) [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 262 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 212 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().

bool PartGroup::apply_freeze_matrix	(	const LVecBase3 &	pos,
		const LVecBase3 &	hpr,
		const LVecBase3 &	scale
	)		`[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 228 of file partGroup.cxx.

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

bool PartGroup::apply_freeze_scalar ( PN_stdfloat value ) [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 244 of file partGroup.cxx.

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

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

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

Reimplemented in MovingPartBase.

Definition at line 632 of file partGroup.cxx.

References bind_hierarchy(), Thread::consider_yield(), AnimGroup::get_child(), get_child(), AnimGroup::get_num_children(), get_num_children(), PartSubset::matches_exclude(), and PartSubset::matches_include().

Referenced by bind_hierarchy(), and PartBundle::do_bind_anim().

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

bool PartGroup::clear_forced_channel ( ) [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 278 of file partGroup.cxx.

Referenced by PartBundle::release_joint().

int PartGroup::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 TypedWritable.

Reimplemented in PartBundle, MovingPartBase, and CharacterJoint.

Definition at line 756 of file partGroup.cxx.

PartGroup * PartGroup::copy_subgraph ( ) const

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

Definition at line 86 of file partGroup.cxx.

References copy_subgraph(), and make_copy().

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

void PartGroup::determine_effective_channels ( const CycleData * root_cdata ) [virtual]

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

Reimplemented in MovingPartBase.

Definition at line 570 of file partGroup.cxx.

Referenced by PartBundle::clear_control_effects(), and PartBundle::do_bind_anim().

bool PartGroup::do_update	(	PartBundle *	root,
		const CycleData *	root_cdata,
		PartGroup *	parent,
		bool	parent_changed,
		bool	anim_changed,
		Thread *	current_thread
	)		`[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 531 of file partGroup.cxx.

Referenced by PartBundle::finalize(), PartBundle::force_update(), and PartBundle::update().

void PartGroup::do_xform	(	const LMatrix4 &	mat,
		const LMatrix4 &	inv_mat
	)		`[virtual]`

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

Reimplemented in CharacterJoint.

Definition at line 554 of file partGroup.cxx.

Referenced by PartBundle::xform().

void PartGroup::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 TypedWritable.

Reimplemented in PartBundle, MovingPartBase, CharacterJoint, MovingPart< SwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 730 of file partGroup.cxx.

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

Referenced by make_PartGroup().

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

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 in MovingPartBase.

Definition at line 691 of file partGroup.cxx.

References find_bound_joints(), get_child(), get_num_children(), PartSubset::matches_exclude(), and PartSubset::matches_include().

Referenced by find_bound_joints().

PartGroup * PartGroup::find_child ( const 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 157 of file partGroup.cxx.

References find_child().

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

PartGroup * PartGroup::get_child ( int n ) const

Returns the nth child of the group.

Definition at line 121 of file partGroup.cxx.

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

PartGroup * PartGroup::get_child_named ( const 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 136 of file partGroup.cxx.

Referenced by check_hierarchy().

AnimChannelBase * PartGroup::get_forced_channel ( ) const [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 291 of file partGroup.cxx.

int PartGroup::get_num_children ( ) const

Returns the number of child nodes of the group.

Definition at line 110 of file partGroup.cxx.

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

TypeHandle PartGroup::get_value_type ( ) const [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 MovingPartBase, MovingPart< SwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 333 of file partGroup.cxx.

References TypeHandle::none().

Referenced by check_hierarchy().

bool PartGroup::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 in CharacterJoint.

Definition at line 64 of file partGroup.cxx.

Referenced by CharacterJoint::update_internals().

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

Allocates and returns a new copy of the node.

Children are not copied, but see copy_subgraph().

Reimplemented in PartBundle, CharacterJoint, CharacterJointBundle, and CharacterSlider.

Definition at line 75 of file partGroup.cxx.

References PartGroup().

Referenced by copy_subgraph().

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

Factory method to generate a PartGroup object.

Definition at line 773 of file partGroup.cxx.

References fillin(), and PartGroup().

Referenced by register_with_read_factory().

void PartGroup::pick_channel_index	(	plist< int > &	holes,
		int &	next
	)		const `[protected, virtual]`

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 in MovingPartBase.

Definition at line 617 of file partGroup.cxx.

Referenced by PartBundle::do_bind_anim().

void PartGroup::register_with_read_factory ( ) [static]

Factory method to generate a PartGroup object.

Reimplemented in PartBundle, CharacterJoint, MovingPartMatrix, CharacterJointBundle, CharacterSlider, and MovingPartScalar.

Definition at line 789 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 191 of file partGroup.cxx.

void PartGroup::write	(	ostream &	out,
		int	indent_level
	)		const `[virtual]`

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

Reimplemented in PartBundle, and MovingPartBase.

Definition at line 303 of file partGroup.cxx.

References write_descendants().

void PartGroup::write_datagram	(	BamWriter *	manager,
		Datagram &	me
	)		`[virtual]`

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

Reimplemented from TypedWritable.

Reimplemented in PartBundle, MovingPartBase, CharacterJoint, MovingPart< SwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 713 of file partGroup.cxx.

References Datagram::add_string(), Datagram::add_uint16(), and BamWriter::write_pointer().

void PartGroup::write_descendants	(	ostream &	out,
		int	indent_level
	)		const `[protected]`

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

Definition at line 585 of file partGroup.cxx.

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

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

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

Definition at line 600 of file partGroup.cxx.

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

void PartGroup::write_with_value	(	ostream &	out,
		int	indent_level
	)		const `[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 317 of file partGroup.cxx.

References write_descendants_with_value().

Referenced by Character::write_part_values().

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

panda/src/chan/partGroup.h
panda/src/chan/partGroup.cxx
panda/src/chan/partGroup.I

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation