Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | Public Attributes | List of all members
mars::interfaces::JointData Class Reference

JointData is a class to exchange joint information between the simulation modules. More...

#include <JointData.h>

Public Member Functions

 JointData (const std::string &name="", JointType type=JOINT_TYPE_UNDEFINED, unsigned long node_id1=0, unsigned long node_id2=0)
 default constructor will leave the joint struct initialized with 0 values More...
 
void init (const std::string &name="", JointType type=JOINT_TYPE_UNDEFINED, unsigned long node_id1=0, unsigned long node_id2=0)
 initialize joint struct with zero values. More...
 
bool fromConfigMap (configmaps::ConfigMap *config, std::string filenamePrefix, LoadCenter *loadCenter=0)
 
void toConfigMap (configmaps::ConfigMap *config, bool skipFilenamePrefix=false)
 
void getFilesToSave (std::vector< std::string > *fileList)
 

Public Attributes

configmaps::ConfigMap config
 
std::string name
 
unsigned long index
 
JointType type
 
unsigned long nodeIndex1
 
unsigned long nodeIndex2
 
utils::Vector anchor
 
int anchorPos
 
utils::Vector axis1
 
utils::Vector axis2
 
sReal spring_constant
 
sReal damping_constant
 
sReal lowStopAxis1
 
sReal highStopAxis1
 
sReal damping_const_constraint_axis1
 
sReal spring_const_constraint_axis1
 
sReal lowStopAxis2
 
sReal highStopAxis2
 
sReal damping_const_constraint_axis2
 
sReal spring_const_constraint_axis2
 
sReal angle1_offset
 
sReal angle2_offset
 
bool invertAxis
 

Detailed Description

JointData is a class to exchange joint information between the simulation modules.

Definition at line 40 of file JointData.h.

Constructor & Destructor Documentation

◆ JointData()

mars::interfaces::JointData::JointData ( const std::string &  name = "",
JointType  type = JOINT_TYPE_UNDEFINED,
unsigned long  node_id1 = 0,
unsigned long  node_id2 = 0 
)
explicit

default constructor will leave the joint struct initialized with 0 values

Definition at line 54 of file JointData.cpp.

Member Function Documentation

◆ fromConfigMap()

bool mars::interfaces::JointData::fromConfigMap ( configmaps::ConfigMap *  config,
std::string  filenamePrefix,
LoadCenter *  loadCenter = 0 
)

Definition at line 88 of file JointData.cpp.

◆ getFilesToSave()

void mars::interfaces::JointData::getFilesToSave ( std::vector< std::string > *  fileList)

Definition at line 219 of file JointData.cpp.

◆ init()

void mars::interfaces::JointData::init ( const std::string &  name = "",
JointType  type = JOINT_TYPE_UNDEFINED,
unsigned long  node_id1 = 0,
unsigned long  node_id2 = 0 
)

initialize joint struct with zero values.

mainly kept for compatibility with ZERO_JOINT_STRUCT macro

Definition at line 60 of file JointData.cpp.

◆ toConfigMap()

void mars::interfaces::JointData::toConfigMap ( configmaps::ConfigMap *  config,
bool  skipFilenamePrefix = false 
)

Definition at line 165 of file JointData.cpp.

Member Data Documentation

◆ anchor

utils::Vector mars::interfaces::JointData::anchor

Definition at line 73 of file JointData.h.

◆ anchorPos

int mars::interfaces::JointData::anchorPos

Definition at line 74 of file JointData.h.

◆ angle1_offset

sReal mars::interfaces::JointData::angle1_offset

Definition at line 90 of file JointData.h.

◆ angle2_offset

sReal mars::interfaces::JointData::angle2_offset

Definition at line 91 of file JointData.h.

◆ axis1

utils::Vector mars::interfaces::JointData::axis1

Definition at line 75 of file JointData.h.

◆ axis2

utils::Vector mars::interfaces::JointData::axis2

Definition at line 78 of file JointData.h.

◆ config

configmaps::ConfigMap mars::interfaces::JointData::config

Definition at line 67 of file JointData.h.

◆ damping_const_constraint_axis1

sReal mars::interfaces::JointData::damping_const_constraint_axis1

Definition at line 84 of file JointData.h.

◆ damping_const_constraint_axis2

sReal mars::interfaces::JointData::damping_const_constraint_axis2

Definition at line 88 of file JointData.h.

◆ damping_constant

sReal mars::interfaces::JointData::damping_constant

Definition at line 81 of file JointData.h.

◆ highStopAxis1

sReal mars::interfaces::JointData::highStopAxis1

Definition at line 83 of file JointData.h.

◆ highStopAxis2

sReal mars::interfaces::JointData::highStopAxis2

Definition at line 87 of file JointData.h.

◆ index

unsigned long mars::interfaces::JointData::index

Definition at line 69 of file JointData.h.

◆ invertAxis

bool mars::interfaces::JointData::invertAxis

Definition at line 92 of file JointData.h.

◆ lowStopAxis1

sReal mars::interfaces::JointData::lowStopAxis1

Definition at line 82 of file JointData.h.

◆ lowStopAxis2

sReal mars::interfaces::JointData::lowStopAxis2

Definition at line 86 of file JointData.h.

◆ name

std::string mars::interfaces::JointData::name

Definition at line 68 of file JointData.h.

◆ nodeIndex1

unsigned long mars::interfaces::JointData::nodeIndex1

Definition at line 71 of file JointData.h.

◆ nodeIndex2

unsigned long mars::interfaces::JointData::nodeIndex2

Definition at line 72 of file JointData.h.

◆ spring_const_constraint_axis1

sReal mars::interfaces::JointData::spring_const_constraint_axis1

Definition at line 85 of file JointData.h.

◆ spring_const_constraint_axis2

sReal mars::interfaces::JointData::spring_const_constraint_axis2

Definition at line 89 of file JointData.h.

◆ spring_constant

sReal mars::interfaces::JointData::spring_constant

Definition at line 80 of file JointData.h.

◆ type

JointType mars::interfaces::JointData::type

Definition at line 70 of file JointData.h.

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