biorbd::utils::Vector3d Class Reference

Wrapper around Eigen Vector3d and attach it to a parent. More...

#include <Vector3d.h>

Inheritance diagram for biorbd::utils::Vector3d:

Public Member Functions
	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.

Protected Member Functions
void	setType ()
	Set the type Vector3d.

Additional Inherited Members
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

Wrapper around Eigen Vector3d and attach it to a parent.

Definition at line 22 of file Vector3d.h.

Constructor & Destructor Documentation

Vector3d() [1/7]

biorbd::utils::Vector3d::Vector3d

(

)

Construct 3D vector.

Definition at line 7 of file Vector3d.cpp.

Vector3d() [2/7]

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

Construct 3D vector.

Parameters

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

Definition at line 14 of file Vector3d.cpp.

Vector3d() [3/7]

biorbd::utils::Vector3d::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.

Parameters

x	X-Component of the vector
y	Y-Component of the vector
z	Z-Component of the vector
name	Name of the vector
parentName	Name of the parent segment

Definition at line 24 of file Vector3d.cpp.

Vector3d() [4/7]

biorbd::utils::Vector3d::Vector3d	(	const biorbd::utils::Vector3d	vec,
		const biorbd::utils::String &	name,
		const biorbd::utils::String &	parentName
	)

Construct a 3D vector.

Parameters

vec	The vector to copy
name	Name of the vector
parentName	Name of the parent segment

Definition at line 36 of file Vector3d.cpp.

Vector3d() [5/7]

biorbd::utils::Vector3d::Vector3d

(

const RigidBodyDynamics::Math::Vector3d &

other

)

Construct a 3D vector from a Casadi 3D vector (drop the trailling 1)

Parameters

other

The Casadi 3D vector

Definition at line 46 of file Vector3d.cpp.

Vector3d() [6/7]

biorbd::utils::Vector3d::Vector3d

(

const RigidBodyDynamics::Math::VectorNd &

other

)

Construct a 3D vector from a Casadi ND vector (drop the trailling 1)

Parameters

other

The Casadi ND vector

Definition at line 54 of file Vector3d.cpp.

Vector3d() [7/7]

biorbd::utils::Vector3d::Vector3d

(

const RigidBodyDynamics::Math::Vector4d &

other

)

Construct a 3D vector from an eigen 4D vector (drop the trailling 1)

Parameters

other

The Eigen 4D vector

Definition at line 62 of file Vector3d.cpp.

Member Function Documentation

applyRT() [1/2]

void biorbd::utils::Vector3d::applyRT

(

const RotoTrans &

rt

)

Apply a RotoTrans to the 3D vector.

Parameters

rt	RotoTrans to apply

Definition at line 103 of file Vector3d.cpp.

applyRT() [2/2]

biorbd::utils::Vector3d biorbd::utils::Vector3d::applyRT

(

const RotoTrans &

rt

)

const

Apply a RotoTrans to the 3D vector.

Parameters

rt	RotoTrans to apply

Returns

The transformed vector

Definition at line 95 of file Vector3d.cpp.

DeepCopy() [1/2]

biorbd::utils::Vector3d biorbd::utils::Vector3d::DeepCopy

(

)

const

Deep copy of a 3D vector.

Returns

A deep copy of a 3D vector

Definition at line 82 of file Vector3d.cpp.

DeepCopy() [2/2]

void biorbd::utils::Vector3d::DeepCopy

(

const biorbd::utils::Vector3d &

other

)

Deep copy of a 3D vector into another 3D vector.

Parameters

other

The 3D vector to copy

Definition at line 89 of file Vector3d.cpp.

---

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

• Vector3d.h
• Vector3d.cpp