CellModules
MecaCell::Orientable Class Reference

#include <orientable.h>

Inheritance diagram for MecaCell::Orientable:
MecaCell::OrientedParticle MecaCell::ContactSurfaceBody< VolCell > MecaCell::ContactSurfaceBody< Derived > MecaCell::GhostCenter< MecaCell::OrientedParticle > MecaCell::ContactSurfaceBody< Cell > MecaCell::GhostCenter< H > MecaCell::SpringBody< Cell >

Public Member Functions

 Orientable ()
 
Vec getAngularVelocity () const
 
Vec getTorque () const
 
Basis< VecgetOrientation () const
 
Rotation< VecgetOrientationRotation () const
 
void setAngularVelocity (const Vec &v)
 
void setTorque (const Vec &t)
 
void setOrientationRotation (const Rotation< Vec > &r)
 
void receiveTorque (const Vec &t)
 
void updateCurrentOrientation ()
 
void resetTorque ()
 
void resetAngularVelocity ()
 

Protected Attributes

Vec angularVelocity = Vec::zero()
 
Vec torque = Vec::zero()
 
Basis< Vecorientation
 
Rotation< VecorientationRotation
 

Detailed Description

Definition at line 5 of file orientable.h.

Constructor & Destructor Documentation

◆ Orientable()

MecaCell::Orientable::Orientable ( )
inline

Definition at line 16 of file orientable.h.

Member Function Documentation

◆ getAngularVelocity()

Vec MecaCell::Orientable::getAngularVelocity ( ) const
inline

Definition at line 21 of file orientable.h.

◆ getOrientation()

Basis< Vec > MecaCell::Orientable::getOrientation ( ) const
inline

Definition at line 23 of file orientable.h.

◆ getOrientationRotation()

Rotation< Vec > MecaCell::Orientable::getOrientationRotation ( ) const
inline

Definition at line 24 of file orientable.h.

◆ getTorque()

Vec MecaCell::Orientable::getTorque ( ) const
inline

Definition at line 22 of file orientable.h.

◆ receiveTorque()

void MecaCell::Orientable::receiveTorque ( const Vec t)
inline

Definition at line 32 of file orientable.h.

◆ resetAngularVelocity()

void MecaCell::Orientable::resetAngularVelocity ( )
inline

Definition at line 35 of file orientable.h.

◆ resetTorque()

void MecaCell::Orientable::resetTorque ( )
inline

Definition at line 34 of file orientable.h.

◆ setAngularVelocity()

void MecaCell::Orientable::setAngularVelocity ( const Vec v)
inline

Definition at line 25 of file orientable.h.

◆ setOrientationRotation()

void MecaCell::Orientable::setOrientationRotation ( const Rotation< Vec > &  r)
inline

Definition at line 27 of file orientable.h.

◆ setTorque()

void MecaCell::Orientable::setTorque ( const Vec t)
inline

Definition at line 26 of file orientable.h.

◆ updateCurrentOrientation()

void MecaCell::Orientable::updateCurrentOrientation ( )
inline

Definition at line 33 of file orientable.h.

Member Data Documentation

◆ angularVelocity

Vec MecaCell::Orientable::angularVelocity = Vec::zero()
protected

Definition at line 7 of file orientable.h.

◆ orientation

Basis<Vec> MecaCell::Orientable::orientation
protected

Definition at line 9 of file orientable.h.

◆ orientationRotation

Rotation<Vec> MecaCell::Orientable::orientationRotation
protected

Definition at line 10 of file orientable.h.

◆ torque

Vec MecaCell::Orientable::torque = Vec::zero()
protected

Definition at line 8 of file orientable.h.


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