Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::utils::Vector3d Class Reference

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

#include <Vector3d.h>

Inheritance diagram for BIORBD_NAMESPACE::utils::Vector3d:
BIORBD_NAMESPACE::utils::Node BIORBD_NAMESPACE::internal_forces::ViaPoint BIORBD_NAMESPACE::internal_forces::WrappingObject BIORBD_NAMESPACE::rigidbody::NodeSegment BIORBD_NAMESPACE::internal_forces::WrappingHalfCylinder BIORBD_NAMESPACE::internal_forces::WrappingSphere BIORBD_NAMESPACE::rigidbody::SoftContactNode BIORBD_NAMESPACE::rigidbody::SoftContactSphere

Public Member Functions

 Vector3d ()
 Construct 3D vector.
 Vector3d (const Scalar &x, const Scalar &y, const Scalar &z)
 Construct 3D vector.
 Vector3d (const Scalar &x, const Scalar &y, const Scalar &z, const String &name, const String &parentName)
 Construct a 3D vector.
 Vector3d (const Vector3d vec, const String &name, const String &parentName)
 Construct a 3D vector.
 Vector3d (const RigidBodyDynamics::Math::Vector3d &other)
 Construct a 3D vector from a Casadi 3D vector (drop the trailling 1).
 Vector3d (const RigidBodyDynamics::Math::VectorNd &other)
 Construct a 3D vector from a Casadi ND vector (drop the trailling 1).
 Vector3d (const RigidBodyDynamics::Math::Vector4d &other)
 Construct a 3D vector from an eigen 4D vector (drop the trailling 1).
Vector3d DeepCopy () const
 Deep copy of a 3D vector.
void DeepCopy (const Vector3d &other)
 Deep copy of a 3D vector into another 3D vector.
Vector3d applyRT (const RotoTrans &rt) const
 Apply a RotoTrans to the 3D vector.
void applyRT (const RotoTrans &rt)
 Apply a RotoTrans to the 3D vector.
void setPosition (const Vector3d &v)
 Set a new position.
Public Member Functions inherited from BIORBD_NAMESPACE::utils::Node
 Node ()
 Construct Node.
 Node (const Node &other)
 Construct Node from another node.
 Node (const String &name)
 Construct Node.
 Node (const String &name, const String &parentName)
 Construct Node.
virtual ~Node ()
 Destroy class properly.
void DeepCopy (const Node &other)
 Deep copy of the node in another node.
void setName (const String &name)
 Set the name of the node.
const String & name () const
 Return the name of the node.
const String & parent () const
 Return the parent name of the node.
void setParent (const String &name)
 Set the parent name of the node.
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_NAMESPACE::utils::Node
std::shared_ptr< String > m_name
 The name of the node.
std::shared_ptr< String > m_parentName
 The parent name of the node.
std::shared_ptr< NODE_TYPE > m_typeOfNode
 The type of the node.

Detailed Description

Wrapper around Eigen Vector3d and attach it to a parent.

Definition at line 24 of file Vector3d.h.

Constructor & Destructor Documentation

◆ Vector3d() [1/7]

utils::Vector3d::Vector3d ( )

Construct 3D vector.

Definition at line 9 of file Vector3d.cpp.

◆ Vector3d() [2/7]

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

Construct 3D vector.

Parameters
xX-Component of the vector
yY-Component of the vector
zZ-Component of the vector

Definition at line 16 of file Vector3d.cpp.

◆ Vector3d() [3/7]

utils::Vector3d::Vector3d ( const Scalar & x,
const Scalar & y,
const Scalar & z,
const String & name,
const String & parentName )

Construct a 3D vector.

Parameters
xX-Component of the vector
yY-Component of the vector
zZ-Component of the vector
nameName of the vector
parentNameName of the parent segment

Definition at line 24 of file Vector3d.cpp.

◆ Vector3d() [4/7]

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

Construct a 3D vector.

Parameters
vecThe vector to copy
nameName of the vector
parentNameName of the parent segment

Definition at line 35 of file Vector3d.cpp.

◆ Vector3d() [5/7]

utils::Vector3d::Vector3d ( const RigidBodyDynamics::Math::Vector3d & other)

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

Parameters
otherThe Casadi 3D vector

Definition at line 41 of file Vector3d.cpp.

◆ Vector3d() [6/7]

utils::Vector3d::Vector3d ( const RigidBodyDynamics::Math::VectorNd & other)

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

Parameters
otherThe Casadi ND vector

Definition at line 47 of file Vector3d.cpp.

◆ Vector3d() [7/7]

utils::Vector3d::Vector3d ( const RigidBodyDynamics::Math::Vector4d & other)

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

Parameters
otherThe Eigen 4D vector

Definition at line 53 of file Vector3d.cpp.

Member Function Documentation

◆ applyRT() [1/2]

void utils::Vector3d::applyRT ( const RotoTrans & rt)

Apply a RotoTrans to the 3D vector.

Parameters
rtRotoTrans to apply

Definition at line 86 of file Vector3d.cpp.

◆ applyRT() [2/2]

utils::Vector3d utils::Vector3d::applyRT ( const RotoTrans & rt) const

Apply a RotoTrans to the 3D vector.

Parameters
rtRotoTrans to apply
Returns
The transformed vector

Definition at line 79 of file Vector3d.cpp.

◆ DeepCopy() [1/2]

utils::Vector3d utils::Vector3d::DeepCopy ( ) const

Deep copy of a 3D vector.

Returns
A deep copy of a 3D vector

Definition at line 68 of file Vector3d.cpp.

◆ DeepCopy() [2/2]

void utils::Vector3d::DeepCopy ( const Vector3d & other)

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

Parameters
otherThe 3D vector to copy

Definition at line 74 of file Vector3d.cpp.

◆ setPosition()

void utils::Vector3d::setPosition ( const Vector3d & v)

Set a new position.

Parameters
vThe new position

Definition at line 93 of file Vector3d.cpp.

◆ setType()

void utils::Vector3d::setType ( )
protectedvirtual

Set the type Vector3d.

Implements BIORBD_NAMESPACE::utils::Node.

Definition at line 103 of file Vector3d.cpp.


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