Parameters controlling what data gets included in a scene recording. More...

#include <mochi_structs.h>

Static Public Member Functions
static RecordingParams	All (bool enabled=true)
	Return RecordingParams with all boolean options set to the given value.

Public Attributes
bool	recordActorLocalToGlobalMap = false
	Include the local-to-global map (if any) when recording actor creation events.
bool	recordActorMassMatrix = false
	Include the mass matrix (if any) when recording actor creation events.
bool	recordActorMeshes = true
	Include the meshes (if any) when recording actor creation events.
bool	recordContactPoints = false
	Record results from QueryType::ContactPoints for each dynamic actor every step.
bool	recordDynamicActorState = true
	Record the state of dynamic actors every step.
bool	recordNodeContactForces = false
	Record results for QueryType::NodeContactForces for each soft actor every step.
bool	recordSdfDistances = false
	Record SDF distances for QueryType::SdfDistances for each dynamic actor every step.
bool	recordStaticActorState = false
	Record the state of static actors every step.
bool	recordTargetState = true
	Record articulated pose controller targets and tracking parameters every step.

Detailed Description

Parameters controlling what data gets included in a scene recording.

Warning: The recording system may undergo a substantial refactor to expand its capabilities. Its API and recorded file format may change in future releases.

See also: Scene::StartRecording, Scene::StopRecording

Definition at line 527 of file mochi_structs.h.

Member Function Documentation

◆ All()

RecordingParams superdex::RecordingParams::All ( bool enabled = true )

inlinestatic

Return RecordingParams with all boolean options set to the given value.

Parameters

[in] enabled True to enable all options (maximum data), false to disable (minimum data).

Returns: The initialized RecordingParams.

Definition at line 558 of file mochi_structs.h.

Member Data Documentation

◆ recordActorLocalToGlobalMap

bool superdex::RecordingParams::recordActorLocalToGlobalMap = false

Include the local-to-global map (if any) when recording actor creation events.

Definition at line 534 of file mochi_structs.h.

◆ recordActorMassMatrix

bool superdex::RecordingParams::recordActorMassMatrix = false

Include the mass matrix (if any) when recording actor creation events.

Definition at line 536 of file mochi_structs.h.

◆ recordActorMeshes

bool superdex::RecordingParams::recordActorMeshes = true

Include the meshes (if any) when recording actor creation events.

Definition at line 532 of file mochi_structs.h.

◆ recordContactPoints

bool superdex::RecordingParams::recordContactPoints = false

Record results from QueryType::ContactPoints for each dynamic actor every step.

Definition at line 548 of file mochi_structs.h.

◆ recordDynamicActorState

bool superdex::RecordingParams::recordDynamicActorState = true

Record the state of dynamic actors every step.

This includes position, rotation, and velocity. For soft actors, it includes the node displacements and velocities.

Definition at line 544 of file mochi_structs.h.

◆ recordNodeContactForces

bool superdex::RecordingParams::recordNodeContactForces = false

Record results for QueryType::NodeContactForces for each soft actor every step.

Definition at line 550 of file mochi_structs.h.

◆ recordSdfDistances

bool superdex::RecordingParams::recordSdfDistances = false

Record SDF distances for QueryType::SdfDistances for each dynamic actor every step.

Definition at line 552 of file mochi_structs.h.

◆ recordStaticActorState

bool superdex::RecordingParams::recordStaticActorState = false

Record the state of static actors every step.

This includes position and rotation.

Definition at line 546 of file mochi_structs.h.

◆ recordTargetState

bool superdex::RecordingParams::recordTargetState = true

Record articulated pose controller targets and tracking parameters every step.

Definition at line 542 of file mochi_structs.h.

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

Static Public Member Functions

Public Attributes