visman::components::visman_core::Project

Overview

interface Project extends Observable

Root project model containing all persistent visualization data. Provides access to presets, layer tags and undo history.

Operation Index

presets: Returns the list of presets belonging to this project.
layerTags: Returns the list of layer tags defined in this project.
globalEvents: Returns the global event to preset mapping belonging to this project.
getDefaultTransition: Returns the default transition used when switching presets if no specific transition is defined.
getTransitionSettings: Returns the saved transition used when switching presets @return The default transition configuration.
setTransitionSettings: Sets the saved transition used when switching presets
setEventBasedBehaviorEnabled: Enables or disables event-based behavior for the project.
isEventBasedBehaviorEnabled: Returns whether event-based behavior is enabled for the project.
save: Saves the current project state to persistent storage.
discardChanges: Discards all unsaved changes and restores the last saved state.
hasUnsavedChanges: Indicates whether the project contains changes that have not yet been saved.
undo: Restores the project state represented by the given undo cookie.
getUndoHistory: Returns the available undo history states.

Operations

PresetList* presets()

Returns the list of presets belonging to this project.

Return Value

Container managing all presets in the project.

LayerTagList* layerTags()

Returns the list of layer tags defined in this project.

Return Value

Container managing all layer tags.

EventList* globalEvents()

Returns the global event to preset mapping belonging to this project.

Return Value

Container managing all event to preset mapping.

Transition getDefaultTransition()

Returns the default transition used when switching presets if no specific transition is defined.

Return Value

The default transition configuration.

Transition getTransitionSettings()

Returns the saved transition used when switching presets

Return Value

The default transition configuration.

void setTransitionSettings(Transition t)

Sets the saved transition used when switching presets

void setEventBasedBehaviorEnabled(bool enabled)

Enables or disables event-based behavior for the project. This state is persistent and saved with the project.

Parameters

enabled: True to enable event-based behavior, false to disable it.

bool isEventBasedBehaviorEnabled()

Returns whether event-based behavior is enabled for the project.

Return Value

True if event-based behavior is enabled, false otherwise.

void save()

Saves the current project state to persistent storage.

void discardChanges()

Discards all unsaved changes and restores the last saved state.

bool hasUnsavedChanges()

Indicates whether the project contains changes that have not yet been saved.

Return Value

True if there are unsaved modifications, false otherwise.

void undo(UndoCookie target) throws InvalidCookie

Restores the project state represented by the given undo cookie.

Parameters

target: Identifier of the undo state to restore.

Exceptions

InvalidCookie: If the provided cookie does not exist in the undo history.

UndoMappingDict getUndoHistory()

Returns the available undo history states.

Return Value

A dictionary mapping human-readable descriptions or IDs to their corresponding undo cookies.