biorbd::muscles::PathModifiers Class Reference

Holder of all the path modifiers of a muscle. More...

#include <PathModifiers.h>

Public Member Functions
	PathModifiers ()
	Construct path changers. More...
biorbd::muscles::PathModifiers	DeepCopy () const
	Deep copy of path changers. More...
void	DeepCopy (const biorbd::muscles::PathModifiers &other)
	Deep copy of path changers from another path changers. More...
void	addPathChanger (biorbd::utils::Vector3d &object)
	Add a wrapping or a via point to the set of path modifiers. More...
unsigned int	nbWraps () const
	Return the total number of wrapping objects in the set. More...
unsigned int	nbVia () const
	Return the total number of via points in the set. More...
unsigned int	nbObjects () const
	Return the total number of path modifier objects in the set. More...
biorbd::utils::Vector3d &	object (unsigned int idx)
	Return the object at a specific index in the set. More...
const biorbd::utils::Vector3d &	object (unsigned int idx) const
	Return the object at a specific index in the set. More...

Protected Attributes
std::shared_ptr< std::vector< biorbd::utils::Vector3d > >	m_obj
	set of objects
std::shared_ptr< unsigned int >	m_nbWraps
	Number of wrapping object in the set.
std::shared_ptr< unsigned int >	m_nbVia
	Number of via points in the set.
std::shared_ptr< unsigned int >	m_totalObjects
	Number of total objects in the set.

Detailed Description

Holder of all the path modifiers of a muscle.

Definition at line 17 of file PathModifiers.h.

Constructor & Destructor Documentation

PathModifiers()

biorbd::muscles::PathModifiers::PathModifiers

(

)

Construct path changers.

Definition at line 10 of file PathModifiers.cpp.

Member Function Documentation

addPathChanger()

void biorbd::muscles::PathModifiers::addPathChanger

(

biorbd::utils::Vector3d &

object

)

Add a wrapping or a via point to the set of path modifiers.

Parameters

object

The wrapping or via point to add

Definition at line 37 of file PathModifiers.cpp.

DeepCopy() [1/2]

biorbd::muscles::PathModifiers biorbd::muscles::PathModifiers::DeepCopy

(

)

const

Deep copy of path changers.

Returns

A deep copy of path changers

Definition at line 19 of file PathModifiers.cpp.

DeepCopy() [2/2]

void biorbd::muscles::PathModifiers::DeepCopy

(

const biorbd::muscles::PathModifiers &

other

)

Deep copy of path changers from another path changers.

Parameters

other

THe path changers to copy

Definition at line 26 of file PathModifiers.cpp.

nbObjects()

unsigned int biorbd::muscles::PathModifiers::nbObjects

(

)

const

Return the total number of path modifier objects in the set.

Returns

The total number of path modifier objects

Definition at line 70 of file PathModifiers.cpp.

nbVia()

unsigned int biorbd::muscles::PathModifiers::nbVia

(

)

const

Return the total number of via points in the set.

Returns

The total number of via points

Definition at line 65 of file PathModifiers.cpp.

nbWraps()

unsigned int biorbd::muscles::PathModifiers::nbWraps

(

)

const

Return the total number of wrapping objects in the set.

Returns

The total number of wrapping objects

Definition at line 61 of file PathModifiers.cpp.

object() [1/2]

biorbd::utils::Vector3d & biorbd::muscles::PathModifiers::object

(

unsigned int

idx

)

Return the object at a specific index in the set.

Parameters

idx	Index of the object

Returns

The object at a specific index

Definition at line 75 of file PathModifiers.cpp.

object() [2/2]

const biorbd::utils::Vector3d & biorbd::muscles::PathModifiers::object

(

unsigned int

idx

)

const

Return the object at a specific index in the set.

Parameters

idx	Index of the object

Returns

The object at a specific index

Definition at line 82 of file PathModifiers.cpp.

---

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

• PathModifiers.h
• PathModifiers.cpp