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 std::string &name)
	Creates the PartGroup, and adds it to the indicated parent. More...

virtual bool	apply_control (PandaNode *node)
	Specifies a node to influence this particular joint so that it will always hold the node's transform. More...

bool	apply_freeze (const TransformState *transform)
	Freezes this particular joint so that it will always hold the specified transform. More...

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

virtual bool	apply_freeze_scalar (PN_stdfloat value)
	Freezes this particular joint so that it will always hold the specified transform. More...

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

virtual bool	clear_forced_channel ()
	Undoes the effect of a previous call to apply_freeze() or apply_control(). More...

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

PartGroup *	copy_subgraph () const
	Allocates and returns a new copy of this node and of all of its children. More...

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

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

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

PartGroup *	find_child (const std::string &name) const
	Returns the first descendant found with the indicated name, or NULL if no such descendant exists. More...

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

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

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

virtual bool	is_character_joint () const
	Returns true if this part is a CharacterJoint, false otherwise. More...

virtual PartGroup *	make_copy () const
	Allocates and returns a new copy of the node. 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...

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

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

Public Member Functions inherited from TypedWritableReferenceCount
	TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)

virtual ReferenceCount *	as_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

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

const TypedObject *	as_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...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_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...

WeakReferenceList *	weak_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 TypedWritable *	make_PartGroup (const FactoryParams &params)
	Factory method to generate a PartGroup object. More...

static void	register_with_read_factory ()
	Factory method to generate a PartGroup 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 ()

Public Attributes
	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 BamReader *	reader = 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

Friends
class	Character

class	CharacterJointBundle

class	PartBundle

Additional Inherited Members
Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

This is the base class for PartRoot and MovingPart.

It defines a hierarchy of MovingParts.

Definition at line 43 of file partGroup.h.

Constructor & Destructor Documentation

◆ PartGroup()

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

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

Member Function Documentation

◆ apply_control()

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

Referenced by PartBundle::control_joint().

◆ apply_freeze()

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

◆ apply_freeze_matrix()

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

Referenced by apply_freeze().

◆ apply_freeze_scalar()

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

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

◆ check_hierarchy()

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

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

◆ clear_forced_channel()

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

Referenced by PartBundle::release_joint().

◆ complete_pointers()

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

◆ copy_subgraph()

PartGroup * PartGroup::copy_subgraph ( ) const

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

Definition at line 75 of file partGroup.cxx.

References copy_subgraph(), and make_copy().

Referenced by copy_subgraph().

◆ determine_effective_channels()

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.

Definition at line 503 of file partGroup.cxx.

◆ do_update()

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

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

◆ do_xform()

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

◆ find_child()

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

References find_child().

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

◆ get_child_named()

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

Referenced by check_hierarchy().

◆ get_forced_channel()

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

◆ get_value_type()

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

Referenced by check_hierarchy().

◆ is_character_joint()

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

Referenced by CharacterMaker::part_to_node().

◆ make_copy()

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, and CharacterSlider.

Definition at line 67 of file partGroup.cxx.

Referenced by copy_subgraph().

◆ make_PartGroup()

TypedWritable * PartGroup::make_PartGroup ( const FactoryParams & params )

static

Factory method to generate a PartGroup object.

Definition at line 681 of file partGroup.cxx.

References parse_params().

Referenced by register_with_read_factory().

◆ register_with_read_factory()

void PartGroup::register_with_read_factory ( )

static

Factory method to generate a PartGroup object.

Definition at line 695 of file partGroup.cxx.

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

◆ sort_descendants()

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

◆ write()

void PartGroup::write	(	std::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 256 of file partGroup.cxx.

References indent().

◆ write_datagram()

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

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

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

◆ write_with_value()

void PartGroup::write_with_value	(	std::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 268 of file partGroup.cxx.

References indent().

Member Data Documentation

◆ get_child

PartGroup * PartGroup::get_child

Returns the nth child of the group.

Definition at line 72 of file partGroup.h.

◆ get_num_children

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

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

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PartGroup()

Member Function Documentation

◆ apply_control()

◆ apply_freeze()

◆ apply_freeze_matrix()

◆ apply_freeze_scalar()

◆ check_hierarchy()

◆ clear_forced_channel()

◆ complete_pointers()

◆ copy_subgraph()

◆ determine_effective_channels()

◆ do_update()

◆ do_xform()

◆ find_child()

◆ get_child_named()

◆ get_forced_channel()

◆ get_value_type()

◆ is_character_joint()

◆ make_copy()

◆ make_PartGroup()

◆ register_with_read_factory()

◆ sort_descendants()

◆ write()

◆ write_datagram()

◆ write_with_value()

Member Data Documentation

◆ get_child

◆ get_num_children