visman::components::visman_core::Preset

Overview

interface Preset extends NamedEntity

A preset defines a complete visualization configuration. It contains viewport layout, layer settings, events, camera configuration and additional scene-related properties.

Operation Index

viewports: Returns the list of viewports belonging to this preset.
getLayerList: Returns the layer list associated with this preset.
getTag: Returns the layer tag assigned to this preset.
setTag: Assigns or clears the layer tag for this preset.
events: Returns the list of events defined for this preset.
getHeadlight: Returns the headlight intensity used for rendering.
getHeadlightEnabled: Returns whether the headlight is enabled for this preset.
setHeadlight: Sets the headlight intensity used for rendering.
getCameraTransform: Returns the camera transform used by this preset.
setCameraTransform: Sets the camera transform for this preset.
importCameraFromGodot: Imports the camera transform from an external Godot scene.
getFocusObject: Returns the focus object for this preset.
setFocusObject: Sets or clears the focus object for this preset.

Operations

ViewportList* viewports()

Returns the list of viewports belonging to this preset.

Return Value

Container managing all viewports of this preset.

LayerList* getLayerList()

Returns the layer list associated with this preset.

Return Value

The LayerList for this preset, or null if none is set.

LayerTag* getTag()

Returns the layer tag assigned to this preset.

Return Value

The assigned LayerTag, or null if no tag is set.

void setTag(LayerTag* tag)

Assigns or clears the layer tag for this preset.

Parameters

tag: The LayerTag to assign, or null to remove the tag.

EventList* events()

Returns the list of events defined for this preset. Events describe transitions to other presets.

Return Value

Container managing all events of this preset.

float getHeadlight()

Returns the headlight intensity used for rendering.

Return Value

Current headlight intensity value.

bool getHeadlightEnabled()

Returns whether the headlight is enabled for this preset.

Return Value

True if enabled, false otherwise.

void setHeadlight(bool enabled, float val) throws InvalidValue

Sets the headlight intensity used for rendering.

Parameters

val: New headlight intensity value.

Exceptions

InvalidValue: If the provided value is outside the valid range.

CameraTransform getCameraTransform()

Returns the camera transform used by this preset.

Return Value

The current CameraTransform.

void setCameraTransform(CameraTransform cam)

Sets the camera transform for this preset.

Parameters

cam: The new CameraTransform to apply.

void importCameraFromGodot()

Imports the camera transform from an external Godot scene.

ArmarxObject* getFocusObject()

Returns the focus object for this preset.

Return Value

The ArmarxObject in focus, or null if none is set.

void setFocusObject(ArmarxObject* obj)

Sets or clears the focus object for this preset.

Parameters

obj: The object to focus, or null to clear the focus.