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

Sphere object that makes the muscle to wrap around. More...

#include <WrappingSphere.h>

Inheritance diagram for BIORBD_NAMESPACE::internal_forces::WrappingSphere:
BIORBD_NAMESPACE::internal_forces::WrappingObject BIORBD_NAMESPACE::utils::Vector3d BIORBD_NAMESPACE::utils::Node

Public Member Functions

 WrappingSphere ()
 Construct a wrapping sphere.
 WrappingSphere (const utils::Scalar &x, const utils::Scalar &y, const utils::Scalar &z, const utils::Scalar &diameter)
 Construct a wrapping sphere.
 WrappingSphere (const utils::Scalar &x, const utils::Scalar &y, const utils::Scalar &z, const utils::Scalar &diameter, const utils::String &name, const utils::String &parentName)
 Construct a wrapping sphere.
 WrappingSphere (const utils::Vector3d &v, const utils::Scalar &diameter)
 Construct a wrapping sphere.
WrappingSphere DeepCopy () const
 Deep copy of the wrapping sphere.
void DeepCopy (const WrappingSphere &other)
 Deep copy of the wrapping sphere in another wrapping sphere.
virtual void wrapPoints (const utils::RotoTrans &, const utils::Vector3d &, const utils::Vector3d &, utils::Vector3d &, utils::Vector3d &, utils::Scalar *=nullptr)
 Not yet implemented.
virtual void wrapPoints (rigidbody::Joints &, const rigidbody::GeneralizedCoordinates &, const utils::Vector3d &, const utils::Vector3d &, utils::Vector3d &, utils::Vector3d &, utils::Scalar *=nullptr)
 Not yet implemented.
virtual void wrapPoints (utils::Vector3d &, utils::Vector3d &, utils::Scalar *=nullptr)
 Not yet implemented.
const utils::RotoTrans & RT (rigidbody::Joints &model, const rigidbody::GeneralizedCoordinates &Q, bool updateKin=true)
 Return the RotoTrans matrix of the sphere.
void setDiameter (const utils::Scalar &val)
 Set the diameter of the wrappping sphere.
const utils::Scalar & diameter () const
 Return the diameter of the wrapping sphere.
Public Member Functions inherited from BIORBD_NAMESPACE::internal_forces::WrappingObject
 WrappingObject ()
 Construct a wrapping object.
 WrappingObject (const utils::Scalar &x, const utils::Scalar &y, const utils::Scalar &z)
 Construct a wrapping object.
 WrappingObject (const utils::Scalar &x, const utils::Scalar &y, const utils::Scalar &z, const utils::String &name, const utils::String &parentName)
 Construct a wrapping object.
 WrappingObject (const utils::Vector3d &other)
 Construct a wrapping object.
 WrappingObject (const utils::Vector3d &other, const utils::String &name, const utils::String &parentName)
 Construct a wrapping object.
void DeepCopy (const WrappingObject &other)
 Deep copy of the wrapping ibject in another wrapping object.
const utils::RotoTrans & RT () const
 Return the RotoTrans matrix of the wrapping object.
WrappingObject & operator= (const utils::Vector3d &other)
 To be able to use the equal "=" operator to define wrapping object.
Public Member Functions inherited from BIORBD_NAMESPACE::utils::Vector3d
 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 Attributes

std::shared_ptr< utils::Scalar > m_dia
 Diameter of the wrapping sphere.
Protected Attributes inherited from BIORBD_NAMESPACE::internal_forces::WrappingObject
std::shared_ptr< utils::RotoTrans > m_RT
 RotoTrans matrix of the wrapping object.
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.

Additional Inherited Members

Protected Member Functions inherited from BIORBD_NAMESPACE::utils::Vector3d
void setType ()
 Set the type Vector3d.

Detailed Description

Sphere object that makes the muscle to wrap around.

Definition at line 13 of file WrappingSphere.h.

Constructor & Destructor Documentation

◆ WrappingSphere() [1/4]

internal_forces::WrappingSphere::WrappingSphere ( )

Construct a wrapping sphere.

Definition at line 9 of file WrappingSphere.cpp.

◆ WrappingSphere() [2/4]

internal_forces::WrappingSphere::WrappingSphere ( const utils::Scalar & x,
const utils::Scalar & y,
const utils::Scalar & z,
const utils::Scalar & diameter )

Construct a wrapping sphere.

Parameters
xX-Component of the sphere
yY-Component of the sphere
zZ-Component of the sphere
diameterDiameter of the sphere

Definition at line 15 of file WrappingSphere.cpp.

◆ WrappingSphere() [3/4]

internal_forces::WrappingSphere::WrappingSphere ( const utils::Scalar & x,
const utils::Scalar & y,
const utils::Scalar & z,
const utils::Scalar & diameter,
const utils::String & name,
const utils::String & parentName )

Construct a wrapping sphere.

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

Definition at line 27 of file WrappingSphere.cpp.

◆ WrappingSphere() [4/4]

internal_forces::WrappingSphere::WrappingSphere ( const utils::Vector3d & v,
const utils::Scalar & diameter )

Construct a wrapping sphere.

Parameters
vPosition of the center of the sphere
diameterDiameter of the sphere

Definition at line 39 of file WrappingSphere.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

internal_forces::WrappingSphere internal_forces::WrappingSphere::DeepCopy ( ) const

Deep copy of the wrapping sphere.

Returns
A deep copy of the wrapping sphere

Definition at line 47 of file WrappingSphere.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of the wrapping sphere in another wrapping sphere.

Parameters
otherThe wrapping sphere to copy

Definition at line 54 of file WrappingSphere.cpp.

◆ diameter()

const utils::Scalar & internal_forces::WrappingSphere::diameter ( ) const

Return the diameter of the wrapping sphere.

Returns
The diameter of the wrapping sphere

Definition at line 71 of file WrappingSphere.cpp.

◆ RT()

const utils::RotoTrans & internal_forces::WrappingSphere::RT ( rigidbody::Joints & model,
const rigidbody::GeneralizedCoordinates & Q,
bool updateKin = true )
virtual

Return the RotoTrans matrix of the sphere.

Parameters
modelThe joint model
QThe generalized coordinates
updateKinIf the kinematics should be computed
Returns
The RotoTrans matrix of the sphere

Implements BIORBD_NAMESPACE::internal_forces::WrappingObject.

Definition at line 60 of file WrappingSphere.cpp.

◆ setDiameter()

void internal_forces::WrappingSphere::setDiameter ( const utils::Scalar & val)

Set the diameter of the wrappping sphere.

Parameters
valValue of the diameter

Definition at line 67 of file WrappingSphere.cpp.

◆ wrapPoints() [1/3]

virtual void BIORBD_NAMESPACE::internal_forces::WrappingSphere::wrapPoints ( const utils::RotoTrans & ,
const utils::Vector3d & ,
const utils::Vector3d & ,
utils::Vector3d & ,
utils::Vector3d & ,
utils::Scalar * = nullptr )
inlinevirtual

Not yet implemented.

Implements BIORBD_NAMESPACE::internal_forces::WrappingObject.

Definition at line 72 of file WrappingSphere.h.

◆ wrapPoints() [2/3]

virtual void BIORBD_NAMESPACE::internal_forces::WrappingSphere::wrapPoints ( rigidbody::Joints & ,
const rigidbody::GeneralizedCoordinates & ,
const utils::Vector3d & ,
const utils::Vector3d & ,
utils::Vector3d & ,
utils::Vector3d & ,
utils::Scalar * = nullptr )
inlinevirtual

Not yet implemented.

Implements BIORBD_NAMESPACE::internal_forces::WrappingObject.

Definition at line 83 of file WrappingSphere.h.

◆ wrapPoints() [3/3]

virtual void BIORBD_NAMESPACE::internal_forces::WrappingSphere::wrapPoints ( utils::Vector3d & ,
utils::Vector3d & ,
utils::Scalar * = nullptr )
inlinevirtual

Not yet implemented.

Implements BIORBD_NAMESPACE::internal_forces::WrappingObject.

Definition at line 96 of file WrappingSphere.h.

Member Data Documentation

◆ m_dia

std::shared_ptr<utils::Scalar> BIORBD_NAMESPACE::internal_forces::WrappingSphere::m_dia
protected

Diameter of the wrapping sphere.

Definition at line 123 of file WrappingSphere.h.


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