SIM_ConstraintNetwork Namespace Reference

Namespaces
	Names
	Standard attribute names.

Classes
class	ConstraintAccessor
class	AnchorAccessor
class	const_iterator
class	iterator
class	GenericConstraintAccessor
class	GenericAnchorAccessor

Enumerations
enum	ConstraintType { ConstraintType::Position, ConstraintType::Rotation, ConstraintType::All }
	The type of a constraint (linear, angular, or both). More...
enum	AnchorType { AnchorType::Point, AnchorType::Vertex, AnchorType::Agent }
enum	PositionType { PositionType::WorldSpace, PositionType::RelativeOffset, PositionType::GeometryPoint, PositionType::AgentXform }
	How the position of the anchor is interpreted. More...

Functions
SIM_API void	addForceAttributes (GU_Detail &gdp, GA_RWHandleF &force, GA_RWHandleF &distance)
	Creates the 'force' and 'distance' primitive attributes. More...
SIM_API void	addTorqueAttributes (GU_Detail &gdp, GA_RWHandleF &torque, GA_RWHandleF &angle)
	Creates the 'torque' and 'angle' primitive attributes. More...
SIM_API GA_ROHandleS	getConstraintNameAttrib (const GU_Detail &gdp)
	Returns the 'constraint_name' primitive attribute. More...
SIM_API bool	buildConstraintDataCache (const GU_Detail &gdp, const GA_ROHandleS &constraint_name_attrib, const SIM_Data &root_data, ConstraintAccessor &constraint_accessor, UT_BitArray &valid_constraint_data)

Enumeration Type Documentation

enum SIM_ConstraintNetwork::AnchorType

strong

The type of anchor specfied by 'anchor_type' attribute. Defaults to point.

Enumerator
Point
Vertex
Agent

Definition at line 74 of file SIM_ConstraintNetworkIterator.h.

enum SIM_ConstraintNetwork::ConstraintType

strong

The type of a constraint (linear, angular, or both).

Enumerator
Position
Rotation
All

Definition at line 65 of file SIM_ConstraintNetworkIterator.h.

enum SIM_ConstraintNetwork::PositionType

strong

How the position of the anchor is interpreted.

Enumerator
WorldSpace
RelativeOffset
GeometryPoint
AgentXform

Definition at line 82 of file SIM_ConstraintNetworkIterator.h.

Function Documentation

SIM_API void SIM_ConstraintNetwork::addForceAttributes	(	GU_Detail &	gdp,
		GA_RWHandleF &	force,
		GA_RWHandleF &	distance
	)

Creates the 'force' and 'distance' primitive attributes.

SIM_API void SIM_ConstraintNetwork::addTorqueAttributes	(	GU_Detail &	gdp,
		GA_RWHandleF &	torque,
		GA_RWHandleF &	angle
	)

Creates the 'torque' and 'angle' primitive attributes.

SIM_API bool SIM_ConstraintNetwork::buildConstraintDataCache	(	const GU_Detail &	gdp,
		const GA_ROHandleS &	constraint_name_attrib,
		const SIM_Data &	root_data,
		ConstraintAccessor &	constraint_accessor,
		UT_BitArray &	valid_constraint_data
	)

Returns false if there were no valid constraint data types (or nothing matched the accessor's filter). 'valid_constraint_data' indicates which string indices from the constraint_name attribute have valid constraint data.

SIM_API GA_ROHandleS SIM_ConstraintNetwork::getConstraintNameAttrib

(

const GU_Detail &

gdp

)

Returns the 'constraint_name' primitive attribute.