dart::dynamics::Chain::Criteria Struct Reference

#include <Chain.hpp>

Public Member Functions
	Criteria (BodyNode *_start, BodyNode *_target, bool _includeBoth=false)
	Constructor for Chain::Criteria. More...
std::vector< BodyNode * >	satisfy () const
	Return a vector of BodyNodes that form a chain. More...
Linkage::Criteria	convert () const
	Convert this Criteria into Linkage::Criteria. More...
	operator Linkage::Criteria () const
	Operator for implicit conversion to a Linkage::Criteria. More...

Public Attributes
WeakBodyNodePtr	mStart
	mStart will be the first BodyNode in the chain More...
WeakBodyNodePtr	mTarget
	mTarget will be the final BodyNode in the chain, unless there is a branching or a FreeJoint along the way More...
bool	mIncludeBoth
	Set this to true if both the start and the target BodyNode should be included. More...

Constructor & Destructor Documentation

Criteria()

dart::dynamics::Chain::Criteria::Criteria	(	BodyNode *	_start,
		BodyNode *	_target,
		bool	_includeBoth = false
	)

Constructor for Chain::Criteria.

Member Function Documentation

convert()

Linkage::Criteria dart::dynamics::Chain::Criteria::convert

(

)

const

Convert this Criteria into Linkage::Criteria.

operator Linkage::Criteria()

dart::dynamics::Chain::Criteria::operator Linkage::Criteria

(

)

const

Operator for implicit conversion to a Linkage::Criteria.

satisfy()

std::vector< BodyNode * > dart::dynamics::Chain::Criteria::satisfy

(

)

const

Return a vector of BodyNodes that form a chain.

Member Data Documentation

mIncludeBoth

bool dart::dynamics::Chain::Criteria::mIncludeBoth

Set this to true if both the start and the target BodyNode should be included.

Otherwise, whichever is upstream of the other will be left out of the chain.

mStart

WeakBodyNodePtr dart::dynamics::Chain::Criteria::mStart

mStart will be the first BodyNode in the chain

mTarget

WeakBodyNodePtr dart::dynamics::Chain::Criteria::mTarget

mTarget will be the final BodyNode in the chain, unless there is a branching or a FreeJoint along the way