Privacy
An open-source, flexible 3D physical simulation framework
mars::interfaces::core_objects_exchange Struct Reference

core_objects_exchange is a struct to exchange core objects information between the modules of the simulation. More...

#include <core_objects_exchange.h>

Public Member Functions

 core_objects_exchange ()
 
void setZero ()
 

Public Attributes

std::string name
 The name of the object. More...
 
utils::Vector pos
 The position of the object. More...
 
utils::Quaternion rot
 The orientation of the object. More...
 
utils::Vector visOffsetPos
 The offset position of the visual representation. More...
 
utils::Quaternion visOffsetRot
 The offset orientation of the visual representation. More...
 
unsigned long index
 The unique id of the object. More...
 
unsigned int groupID
 The groupID of the object if the object is a node. More...
 
sReal value
 A value that is used in different ways depending on the type of object. More...
 

Detailed Description

core_objects_exchange is a struct to exchange core objects information between the modules of the simulation.

This object is mostly used to get the main object information without any overhead. For instance to create lists of objects in the GUI.

Definition at line 39 of file core_objects_exchange.h.

Constructor & Destructor Documentation

◆ core_objects_exchange()

mars::interfaces::core_objects_exchange::core_objects_exchange ( )
inline

Definition at line 40 of file core_objects_exchange.h.

Member Function Documentation

◆ setZero()

void mars::interfaces::core_objects_exchange::setZero ( )
inline

Definition at line 44 of file core_objects_exchange.h.

Member Data Documentation

◆ groupID

unsigned int mars::interfaces::core_objects_exchange::groupID

The groupID of the object if the object is a node.

Definition at line 88 of file core_objects_exchange.h.

◆ index

unsigned long mars::interfaces::core_objects_exchange::index

The unique id of the object.

A joint and a node can have the same id, the ids are only unique for the same types of objects.

Definition at line 83 of file core_objects_exchange.h.

◆ name

std::string mars::interfaces::core_objects_exchange::name

The name of the object.

Definition at line 57 of file core_objects_exchange.h.

◆ pos

utils::Vector mars::interfaces::core_objects_exchange::pos

The position of the object.

Definition at line 62 of file core_objects_exchange.h.

◆ rot

utils::Quaternion mars::interfaces::core_objects_exchange::rot

The orientation of the object.

See also
Quaternion

Definition at line 67 of file core_objects_exchange.h.

◆ value

sReal mars::interfaces::core_objects_exchange::value

A value that is used in different ways depending on the type of object.

Definition at line 93 of file core_objects_exchange.h.

◆ visOffsetPos

utils::Vector mars::interfaces::core_objects_exchange::visOffsetPos

The offset position of the visual representation.

Definition at line 72 of file core_objects_exchange.h.

◆ visOffsetRot

utils::Quaternion mars::interfaces::core_objects_exchange::visOffsetRot

The offset orientation of the visual representation.

See also
Quaternion

Definition at line 77 of file core_objects_exchange.h.


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