Via point of a muscle. More...

#include <ViaPoint.h>

Inheritance diagram for biorbd::muscles::ViaPoint:

Public Member Functions
	ViaPoint ()
	Contruct ViaPoint.

	ViaPoint (const biorbd::utils::Scalar &x, const biorbd::utils::Scalar &y, const biorbd::utils::Scalar &z)
	Construct ViaPoint. More...

	ViaPoint (const biorbd::utils::Scalar &x, const biorbd::utils::Scalar &y, const biorbd::utils::Scalar &z, const biorbd::utils::String &name, const biorbd::utils::String &parentName)
	Construct ViaPoint. More...

	ViaPoint (const biorbd::utils::Vector3d &other)
	Construct ViaPoint from a vector. More...

	ViaPoint (const biorbd::muscles::ViaPoint &other)
	Construct ViaPoint from another ViaPoint. More...

biorbd::muscles::ViaPoint	DeepCopy () const
	Deep copy of a ViaPoint. More...

void	DeepCopy (const biorbd::muscles::ViaPoint &other)
	Deep copy of a ViaPoint into another ViaPoint. More...

template<typename OtherDerived >
biorbd::muscles::ViaPoint &	operator= (const biorbd::utils::Vector3d &other)
	To be able to use operator "=" when assigning a ViaPoint to a 3D node. More...

Public Member Functions inherited from biorbd::utils::Vector3d
	Vector3d ()
	Construct 3D vector. More...

	Vector3d (const biorbd::utils::Scalar &x, const biorbd::utils::Scalar &y, const biorbd::utils::Scalar &z)
	Construct 3D vector. More...

	Vector3d (const biorbd::utils::Scalar &x, const biorbd::utils::Scalar &y, const biorbd::utils::Scalar &z, const biorbd::utils::String &name, const biorbd::utils::String &parentName)
	Construct a 3D vector. More...

	Vector3d (const biorbd::utils::Vector3d vec, const biorbd::utils::String &name, const biorbd::utils::String &parentName)
	Construct a 3D vector. More...

	Vector3d (const RigidBodyDynamics::Math::Vector3d &other)
	Construct a 3D vector from a Casadi 3D vector (drop the trailling 1) More...

	Vector3d (const RigidBodyDynamics::Math::VectorNd &other)
	Construct a 3D vector from a Casadi ND vector (drop the trailling 1) More...

	Vector3d (const RigidBodyDynamics::Math::Vector4d &other)
	Construct a 3D vector from an eigen 4D vector (drop the trailling 1) More...

biorbd::utils::Vector3d	DeepCopy () const
	Deep copy of a 3D vector. More...

void	DeepCopy (const biorbd::utils::Vector3d &other)
	Deep copy of a 3D vector into another 3D vector. More...

biorbd::utils::Vector3d	applyRT (const RotoTrans &rt) const
	Apply a RotoTrans to the 3D vector. More...

void	applyRT (const RotoTrans &rt)
	Apply a RotoTrans to the 3D vector. More...

Public Member Functions inherited from biorbd::utils::Node
	Node ()
	Construct Node.

	Node (const biorbd::utils::Node &other)
	Construct Node from another node. More...

	Node (const biorbd::utils::String &name)
	Construct Node. More...

	Node (const biorbd::utils::String &name, const biorbd::utils::String &parentName)
	Construct Node. More...

virtual	~Node ()
	Destroy class properly.

void	DeepCopy (const biorbd::utils::Node &other)
	Deep copy of the node in another node. More...

void	setName (const biorbd::utils::String &name)
	Set the name of the node. More...

const biorbd::utils::String &	name () const
	Return the name of the node.

const biorbd::utils::String &	parent () const
	Return the parent name of the node.

void	setParent (const biorbd::utils::String &name)
	Set the parent name of the node. More...

biorbd::utils::NODE_TYPE	typeOfNode () const
	Return the type of node.

Additional Inherited Members
Protected Member Functions inherited from biorbd::utils::Vector3d
void	setType ()
	Set the type Vector3d.

Protected Attributes inherited from biorbd::utils::Node
std::shared_ptr< biorbd::utils::String >	m_name
	The name of the node.

std::shared_ptr< biorbd::utils::String >	m_parentName
	The parent name of the node.

std::shared_ptr< biorbd::utils::NODE_TYPE >	m_typeOfNode
	The type of the node.

Detailed Description

Via point of a muscle.

Definition at line 16 of file ViaPoint.h.

Constructor & Destructor Documentation

◆ ViaPoint() [1/4]

biorbd::muscles::ViaPoint::ViaPoint	(	const biorbd::utils::Scalar &	x,
		const biorbd::utils::Scalar &	y,
		const biorbd::utils::Scalar &	z
	)

Construct ViaPoint.

Parameters

x	X-Component of the ViaPoint
y	Y-Component of the ViaPoint
z	Z-Component of the ViaPoint

Definition at line 12 of file ViaPoint.cpp.

◆ ViaPoint() [2/4]

biorbd::muscles::ViaPoint::ViaPoint	(	const biorbd::utils::Scalar &	x,
		const biorbd::utils::Scalar &	y,
		const biorbd::utils::Scalar &	z,
		const biorbd::utils::String &	name,
		const biorbd::utils::String &	parentName
	)

Construct ViaPoint.

Parameters

x	X-Component of the ViaPoint
y	Y-Component of the ViaPoint
z	Z-Component of the ViaPoint
name	The name of the via point
parentName	The name of the parent segment

Definition at line 21 of file ViaPoint.cpp.

◆ ViaPoint() [3/4]

biorbd::muscles::ViaPoint::ViaPoint ( const biorbd::utils::Vector3d & other )

Construct ViaPoint from a vector.

Parameters

other The vector

Definition at line 32 of file ViaPoint.cpp.

◆ ViaPoint() [4/4]

biorbd::muscles::ViaPoint::ViaPoint ( const biorbd::muscles::ViaPoint & other )

Construct ViaPoint from another ViaPoint.

Parameters

other The other ViaPoint

Definition at line 39 of file ViaPoint.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

biorbd::muscles::ViaPoint biorbd::muscles::ViaPoint::DeepCopy ( ) const

Deep copy of a ViaPoint.

Returns: A deep copy of a ViaPoint

Definition at line 45 of file ViaPoint.cpp.

◆ DeepCopy() [2/2]

void biorbd::muscles::ViaPoint::DeepCopy ( const biorbd::muscles::ViaPoint & other )

Deep copy of a ViaPoint into another ViaPoint.

Parameters

other The ViaPoint to copy

Definition at line 52 of file ViaPoint.cpp.

◆ operator=()

template<typename OtherDerived >

biorbd::muscles::ViaPoint& biorbd::muscles::ViaPoint::operator= ( const biorbd::utils::Vector3d & other )

inline

To be able to use operator "=" when assigning a ViaPoint to a 3D node.

Parameters

other The 3D node to assign to ViaPoint

Definition at line 80 of file ViaPoint.h.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ViaPoint() [1/4]

◆ ViaPoint() [2/4]

◆ ViaPoint() [3/4]

◆ ViaPoint() [4/4]

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ operator=()