Public Member Functions
PartSubset Class Reference

This class is used to define a subset of part names to apply to the PartBundle::bind_anim() operation. More...

#include "partSubset.h"

List of all members.

Public Member Functions

 PartSubset (const PartSubset &copy)
void add_exclude_joint (const GlobPattern &name)
 Adds the named joint to the list of joints that will be explicitly exlcluded from the subset.
void add_include_joint (const GlobPattern &name)
 Adds the named joint to the list of joints that will be explicitly included in the subset.
void append (const PartSubset &other)
 Appends the include and exclude list from the other object onto this object's lists.
bool is_include_empty () const
 Returns true if the include list is completely empty, false otherwise.
bool matches_exclude (const string &joint_name) const
 Returns true if the indicated name matches a name on the exclude list, false otherwise.
bool matches_include (const string &joint_name) const
 Returns true if the indicated name matches a name on the include list, false otherwise.
void operator= (const PartSubset &copy)
void output (ostream &out) const

Detailed Description

This class is used to define a subset of part names to apply to the PartBundle::bind_anim() operation.

Only those part names within the subset will be included in the bind.

Definition at line 28 of file partSubset.h.

Member Function Documentation

void PartSubset::add_exclude_joint ( const GlobPattern &  name)

Adds the named joint to the list of joints that will be explicitly exlcluded from the subset.

Any joint at or below a named node will not be included in the subset (unless a lower node is also listed in the include list).

Since the name is a GlobPattern, it may of course include filename globbing characters like * and ?.

Definition at line 79 of file partSubset.cxx.

void PartSubset::add_include_joint ( const GlobPattern &  name)

Adds the named joint to the list of joints that will be explicitly included in the subset.

Any joint at or below a named node will be included in the subset (unless a lower node is also listed in the exclude list).

Since the name is a GlobPattern, it may of course include filename globbing characters like * and ?.

Definition at line 62 of file partSubset.cxx.

void PartSubset::append ( const PartSubset &  other)

Appends the include and exclude list from the other object onto this object's lists.

Definition at line 90 of file partSubset.cxx.

bool PartSubset::is_include_empty ( ) const

Returns true if the include list is completely empty, false otherwise.

If it is empty, it is the same thing as including all joints.

Definition at line 135 of file partSubset.cxx.

Referenced by PartBundle::do_bind_anim().

bool PartSubset::matches_exclude ( const string &  joint_name) const

Returns true if the indicated name matches a name on the exclude list, false otherwise.

Definition at line 165 of file partSubset.cxx.

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

bool PartSubset::matches_include ( const string &  joint_name) const

Returns true if the indicated name matches a name on the include list, false otherwise.

Definition at line 146 of file partSubset.cxx.

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

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