UpdateShape Struct Reference

Define modifications to be done on a basic shape. More...

#include <mbs_saver_struct.h>

Public Attributes
int	on_base
	True (1) if the shape is on the basebody. More...
char *	body_name
	Name of the body with the shape, disregarded if on_base is true. More...
char *	shape_name
	Name of the shape in the shape list. More...
ShapeIds	shape_nature
	Indicate if the shape is a box, cylinder, cone or sphere: More...
double *	size
	The behavior of this field depend of the loaded project format. More...
double *	radius
	DEPRECATED for Json formatted project. More...
double *	height
	DEPRECATED for Json formatted project. More...
double *	position
double *	scale
	DEPRECATED for Json formatted project. More...
double *	rotation
	Rotation (around x, y, z) of the inline, Set to NULL to not update it. More...
double	transparency
	Transparency (1 is invisible, 0 is fully visible) of the inline, Set to negative value to not update it. More...
int	visible
	Flag to show the shape (1) or hide it (0). Set to -1 to not update it. More...
struct UpdateShape *	next
	Pointer to next shape to be updated. More...

Detailed Description

Define modifications to be done on a basic shape.

Member Data Documentation

body_name

char* body_name

Name of the body with the shape, disregarded if on_base is true.

height

double* height

DEPRECATED for Json formatted project.

For XML projects it is the height of the shapes, except for SHAPE_BOX and SHAPE_SPHERE.

Set to NULL to not update it.

Position (x, y, z) of the shape, Set to NULL to not update it.

next

struct UpdateShape* next

Pointer to next shape to be updated.

on_base

int on_base

True (1) if the shape is on the basebody.

position

double* position

radius

double* radius

DEPRECATED for Json formatted project.

For XML projects it is the radius of the shapes, except for SHAPE_BOX.

Set to NULL to not update it.

rotation

double* rotation

Rotation (around x, y, z) of the inline, Set to NULL to not update it.

scale

double* scale

DEPRECATED for Json formatted project.

For XML projects it is the scale applied on the shape dimensions along each axis (x, y, z).

Set to NULL to not update it.

shape_name

char* shape_name

Name of the shape in the shape list.

In case of multiple occurrence, the first is considered.

shape_nature

ShapeIds shape_nature

Indicate if the shape is a box, cylinder, cone or sphere:

• SHAPE_BOX
• SHAPE_CYLINDER
• SHAPE_CONE
• SHAPE_SPHERE

For inline shape (SHAPE_INLINE), use the structure UpdateShape.

size

double* size

The behavior of this field depend of the loaded project format.

For JSON formatted projects, size defines the shape size along each axis. For cone and cylinder, the height is located in the index 1.

For XML formatted projects, size defines the shape size of boxes. The boxes have the shape_nature at SHAPE_BOX.

Set to NULL to not update it.

transparency

double transparency

Transparency (1 is invisible, 0 is fully visible) of the inline, Set to negative value to not update it.

visible

int visible

Flag to show the shape (1) or hide it (0). Set to -1 to not update it.

---

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

• mbs_common/mbs_struct/mbs_saver_struct.h