HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_ConstraintNetwork::const_iterator Class Reference

#include <SIM_ConstraintNetworkIterator.h>

Public Member Functions

 const_iterator (const SIM_Data &container, const SIM_Data &data_root, const SIM_Geometry *geo, const SIM_Time &t, ConstraintAccessor &constraint_accessor, AnchorAccessor &anchor_accessor, bool skip_broken=true)
 
 const_iterator (const SIM_Data &container, const SIM_Data &data_root, const SIM_Geometry *geo, const GU_Detail *gdp, const GA_PrimitiveGroup *broken_group, const SIM_Time &t, ConstraintAccessor &constraint_accessor, AnchorAccessor &anchor_accessor, bool skip_broken=true)
 
 UT_NON_COPYABLE (const_iterator)
 
void rewind ()
 
bool atEnd () const
 
void advance ()
 
const GU_DetailgetGdp () const
 The constraint network geometry. More...
 
exint getConstraintIndex () const
 The number of valid constraints that have been seen so far. More...
 
GA_Index getPrimIndex () const
 The primitive index. More...
 
GA_Offset getPrimOffset () const
 The primitive offset. More...
 
bool isBroken () const
 
exint getConstraintDataIndex () const
 Returns the index of the current constraint data type. More...
 
ConstraintType getConstraintType () const
 Returns whether the constraint affects position / rotation / all. More...
 
GA_Offset getPointOffset (bool anchor1) const
 The point offset for this anchor in the constraint network geometry. More...
 
GA_Index getPointNumber (bool anchor1) const
 The point number for this anchor in the constraint network geometry. More...
 
exint getConstraintId () const
 Unique id of the current constraint, if the id attribute exists. More...
 

Detailed Description

Definition at line 152 of file SIM_ConstraintNetworkIterator.h.

Constructor & Destructor Documentation

SIM_ConstraintNetwork::const_iterator::const_iterator ( const SIM_Data container,
const SIM_Data data_root,
const SIM_Geometry geo,
const SIM_Time t,
ConstraintAccessor constraint_accessor,
AnchorAccessor anchor_accessor,
bool  skip_broken = true 
)
Parameters
containerA SIM_Relationship or SIM_Object that contains the constraint network as subdata.
data_rootParent of the SIM_ConRel subdata.
SIM_ConstraintNetwork::const_iterator::const_iterator ( const SIM_Data container,
const SIM_Data data_root,
const SIM_Geometry geo,
const GU_Detail gdp,
const GA_PrimitiveGroup broken_group,
const SIM_Time t,
ConstraintAccessor constraint_accessor,
AnchorAccessor anchor_accessor,
bool  skip_broken = true 
)

Member Function Documentation

void SIM_ConstraintNetwork::const_iterator::advance ( )
inline

Definition at line 62 of file SIM_ConstraintNetworkIteratorImpl.h.

bool SIM_ConstraintNetwork::const_iterator::atEnd ( ) const
inline

Definition at line 56 of file SIM_ConstraintNetworkIteratorImpl.h.

exint SIM_ConstraintNetwork::const_iterator::getConstraintDataIndex ( ) const
inline

Returns the index of the current constraint data type.

Definition at line 111 of file SIM_ConstraintNetworkIteratorImpl.h.

exint SIM_ConstraintNetwork::const_iterator::getConstraintId ( ) const
inline

Unique id of the current constraint, if the id attribute exists.

Definition at line 211 of file SIM_ConstraintNetworkIterator.h.

exint SIM_ConstraintNetwork::const_iterator::getConstraintIndex ( ) const
inline

The number of valid constraints that have been seen so far.

Definition at line 187 of file SIM_ConstraintNetworkIterator.h.

ConstraintType SIM_ConstraintNetwork::const_iterator::getConstraintType ( ) const
inline

Returns whether the constraint affects position / rotation / all.

Definition at line 83 of file SIM_ConstraintNetworkIteratorImpl.h.

const GU_Detail& SIM_ConstraintNetwork::const_iterator::getGdp ( ) const
inline

The constraint network geometry.

Definition at line 185 of file SIM_ConstraintNetworkIterator.h.

GA_Index SIM_ConstraintNetwork::const_iterator::getPointNumber ( bool  anchor1) const
inline

The point number for this anchor in the constraint network geometry.

Definition at line 105 of file SIM_ConstraintNetworkIteratorImpl.h.

SYS_FORCE_INLINE GA_Offset SIM_ConstraintNetwork::const_iterator::getPointOffset ( bool  anchor1) const

The point offset for this anchor in the constraint network geometry.

Definition at line 99 of file SIM_ConstraintNetworkIteratorImpl.h.

GA_Index SIM_ConstraintNetwork::const_iterator::getPrimIndex ( ) const
inline

The primitive index.

Definition at line 71 of file SIM_ConstraintNetworkIteratorImpl.h.

GA_Offset SIM_ConstraintNetwork::const_iterator::getPrimOffset ( ) const
inline

The primitive offset.

Definition at line 191 of file SIM_ConstraintNetworkIterator.h.

bool SIM_ConstraintNetwork::const_iterator::isBroken ( ) const
inline

Returns whether the constraint is broken and should be inactive. Broken constraints are normally skipped by the iterator, unless skip_broken is false.

Definition at line 77 of file SIM_ConstraintNetworkIteratorImpl.h.

void SIM_ConstraintNetwork::const_iterator::rewind ( )
inline

Definition at line 46 of file SIM_ConstraintNetworkIteratorImpl.h.

SIM_ConstraintNetwork::const_iterator::UT_NON_COPYABLE ( const_iterator  )

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