visman::components::visman_core::ComponentInterface

Overview

interface ComponentInterface extends Observable, VISManEventTopicListener

Main visman core component interface. Acts as entry point into the model.

Operation Index

setLayerVisibility: Sets the updated layer visibilty and sets it in arviz godot (unique layer name).
setHeadlight: Sets the headlight value of the active preset and pushes it to arviz godot.
getProject: Returns the root project associated with this component.
getActivePreset: Returns the currently active preset.
setActivePresetByName: Activates a preset by its name.
setActivePreset: Activates the given preset instance.
getCurrentLayerTree: Returns the current visibility state of all layers as a hierarchy.
enableChanges: Enables modifications to the model state.
disableChanges: Disables modifications to the model state.
isChangeable: Returns whether the model is currently in a changeable state.
updateCameraTransform
getHeadlightEnabled: Returns whether the headlight is enabled.
getHeadlightValue: Returns the current headlight value.
fireEvent: Reacts to an event by its name.
getImageProviderNames: Returns available image providers that can be used as viewport sources.
commitViewportRuntimeOverridesToActivePreset: Commits the buffered position and size of a viewport into the currently active preset.
removePresetViewportsFromGodot

Operations

void setLayerVisibility(string layerName, bool visible) throws ModificationLockException

Sets the updated layer visibilty and sets it in arviz godot (unique layer name).

void setHeadlight(bool enabled, float value) throws InvalidValue

Sets the headlight value of the active preset and pushes it to arviz godot.

Parameters

value: Headlight intensity in range 0, 100.

Exceptions

InvalidValue: If no active preset exists or the value is out of range.

Project* getProject()

Returns the root project associated with this component.

Return Value

The project instance managed by this core component.

Preset* getActivePreset()

Returns the currently active preset.

Return Value

The preset that is currently active.

void setActivePresetByName(string name) throws ModificationLockException

Activates a preset by its name.

Parameters

name: Name of the preset to activate.

Exceptions

ModificationLockException: If the core is currently locked and preset switching is not allowed.

void setActivePreset(Preset* preset) throws ModificationLockException

Activates the given preset instance.

Parameters

preset: The preset instance to activate.

Exceptions

ModificationLockException: If the core is currently locked and preset switching is not allowed.

LayerNode getCurrentLayerTree()

Returns the current visibility state of all layers as a hierarchy.

Return Value

The root node of the current layer hierarchy.

void enableChanges()

Enables modifications to the model state.

void disableChanges()

Disables modifications to the model state.

bool isChangeable()

Returns whether the model is currently in a changeable state.

Return Value

True if modifications are currently allowed, false otherwise.

void updateCameraTransform()

bool getHeadlightEnabled()

Returns whether the headlight is enabled.

float getHeadlightValue()

Returns the current headlight value.

void fireEvent(string eventName)

Reacts to an event by its name. If an event with the given name exists in the active preset, the corresponding transition logic will be executed.

Parameters

name: Name of the event to trigger.

StringSeq getImageProviderNames()

Returns available image providers that can be used as viewport sources.

Return Value

List of image provider identifiers.

void commitViewportRuntimeOverridesToActivePreset()

Commits the buffered position and size of a viewport into the currently active preset.

void removePresetViewportsFromGodot(string presetName)