Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::internal_forces::PathModifiers Class Reference

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

#include <PathModifiers.h>

Public Member Functions

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

Protected Attributes

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

Detailed Description

Holder of all the path modifiers of a muscle.

Definition at line 18 of file PathModifiers.h.

Constructor & Destructor Documentation

◆ PathModifiers()

internal_forces::PathModifiers::PathModifiers ( )

Construct path changers.

Definition at line 12 of file PathModifiers.cpp.

Member Function Documentation

◆ addPathChanger()

void internal_forces::PathModifiers::addPathChanger ( utils::Vector3d & object)

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

Parameters
objectThe wrapping or via point to add

Definition at line 38 of file PathModifiers.cpp.

◆ DeepCopy() [1/2]

internal_forces::PathModifiers internal_forces::PathModifiers::DeepCopy ( ) const

Deep copy of path changers.

Returns
A deep copy of path changers

Definition at line 18 of file PathModifiers.cpp.

◆ DeepCopy() [2/2]

void internal_forces::PathModifiers::DeepCopy ( const PathModifiers & other)

Deep copy of path changers from another path changers.

Parameters
otherTHe path changers to copy

Definition at line 25 of file PathModifiers.cpp.

◆ nbObjects()

size_t internal_forces::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 71 of file PathModifiers.cpp.

◆ nbVia()

size_t internal_forces::PathModifiers::nbVia ( ) const

Return the total number of via points in the set.

Returns
The total number of via points

Definition at line 69 of file PathModifiers.cpp.

◆ nbWraps()

size_t internal_forces::PathModifiers::nbWraps ( ) const

Return the total number of wrapping objects in the set.

Returns
The total number of wrapping objects

Definition at line 67 of file PathModifiers.cpp.

◆ object() [1/2]

utils::Vector3d & internal_forces::PathModifiers::object ( size_t idx)

Return the object at a specific index in the set.

Parameters
idxIndex of the object
Returns
The object at a specific index

Definition at line 75 of file PathModifiers.cpp.

◆ object() [2/2]

const utils::Vector3d & internal_forces::PathModifiers::object ( size_t idx) const

Return the object at a specific index in the set.

Parameters
idxIndex of the object
Returns
The object at a specific index

Definition at line 81 of file PathModifiers.cpp.

Member Data Documentation

◆ m_nbVia

std::shared_ptr<size_t> BIORBD_NAMESPACE::internal_forces::PathModifiers::m_nbVia
protected

Number of via points in the set.

Definition at line 80 of file PathModifiers.h.

◆ m_nbWraps

std::shared_ptr<size_t> BIORBD_NAMESPACE::internal_forces::PathModifiers::m_nbWraps
protected

Number of wrapping object in the set.

Definition at line 79 of file PathModifiers.h.

◆ m_obj

std::shared_ptr<std::vector<std::shared_ptr<utils::Vector3d> > > BIORBD_NAMESPACE::internal_forces::PathModifiers::m_obj
protected

set of objects

Definition at line 78 of file PathModifiers.h.

◆ m_totalObjects

std::shared_ptr<size_t> BIORBD_NAMESPACE::internal_forces::PathModifiers::m_totalObjects
protected

Number of total objects in the set.

Definition at line 82 of file PathModifiers.h.


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