VisualPresetGroup¶

This class is a base class for visual preset groups.

See also

class samson.DataModel.Visualization.VisualPresetGroup(*args, **kwargs)¶

Bases: pybind11_builtins.pybind11_object

This class is a base class for visual preset group.

Overloaded function.

__init__(self: samson.DataModel.Visualization.VisualPresetGroup, name: str, visualPresets: List[samson.DataModel.Visualization.VisualPreset] = None) -> None

Constructs a visual preset group with the given name and provided visual preset

__init__(self: samson.DataModel.Visualization.VisualPresetGroup, visualPresetGroup: samson.DataModel.Visualization.VisualPresetGroup) -> None

Constructs a visual preset group based on the provided visual preset group

addVisualPreset(self: samson.DataModel.Visualization.VisualPresetGroup, visualizationPreset: samson.DataModel.Visualization.VisualPreset) → bool¶: Adds the visual preset visualizationPreset to this group

apply(self: samson.DataModel.Visualization.VisualPresetGroup, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer, preferredFolder: samson.DataModel.Document.Folder) → None¶: Applies the visual preset group to nodes in nodeIndexer and adds the visual models (if any) to preferredFolder

canAddVisualPreset(self: samson.DataModel.Visualization.VisualPresetGroup) → bool¶: Returns whether a visual preset can be added to the group

clone(self: samson.DataModel.Visualization.VisualPresetGroup) → samson.DataModel.Visualization.VisualPresetGroup¶: Returns a copy of the visual preset group

deleteVisualPreset(self: samson.DataModel.Visualization.VisualPresetGroup, index: int) → None¶: Deletes the visual preset with index index from the visual preset group

static getDefaultVisualPresetGroups() → List[samson.DataModel.Visualization.VisualPresetGroup]¶: Returns a vector of the default visual preset groups