Class SBDVisualPresetStep#

The SBDVisualPresetStep class is a base class for visual preset steps.More...

#include <SBDVisualPresetStep.hpp>

Public Types#

Type	Name
enum	StructureVisibility Available structure visibility types.

Public Functions#

Type	Name
	SBDVisualPresetStep () Constructs an empty visual preset step.
	SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::vector< SBUUID > & actions) Builds a visual preset step with the given selection filter and actions.
	SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::string & visualModelClassName=std::string(), const SBUUID & visualModelExtensionUUID=SBUUID(), const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selection filter, visual model, and actions.
	SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::string & visualModelClassName, const SBUUID & visualModelExtensionUUID, const std::string & colorSchemeClassName, const SBUUID & colorSchemeExtensionUUID, const SBColor & color, const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.
	SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::string & visualModelClassName, const SBUUID & visualModelExtensionUUID, const std::string & colorSchemeClassName, const SBUUID & colorSchemeExtensionUUID, const SBPalette * colorPalette=nullptr, const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.
	SBDVisualPresetStep (const std::string & selectorClassName, const SBUUID & selectorExtensionUUID, const std::vector< SBUUID > & actions) Builds a visual preset step with the given selector and actions.
	SBDVisualPresetStep (const std::string & selectorClassName, const SBUUID & selectorExtensionUUID, const std::string & visualModelClassName=std::string(), const SBUUID & visualModelExtensionUUID=SBUUID(), const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selector, visual model, and actions.
	SBDVisualPresetStep (const std::string & selectorClassName, const SBUUID & selectorExtensionUUID, const std::string & visualModelClassName, const SBUUID & visualModelExtensionUUID, const std::string & colorSchemeClassName, const SBUUID & colorSchemeExtensionUUID, const SBColor & color, const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selector, visual model, color scheme, and actions.
	SBDVisualPresetStep (const std::string & selectorClassName, const SBUUID & selectorExtensionUUID, const std::string & visualModelClassName, const SBUUID & visualModelExtensionUUID, const std::string & colorSchemeClassName, const SBUUID & colorSchemeExtensionUUID, const SBPalette * colorPalette=nullptr, const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selector, visual model, color scheme, and actions.
	SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::string & visualModelPublicName, const std::string & colorSchemePublicName, const SBColor & color, const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.
	SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::string & visualModelPublicName, const std::string & colorSchemePublicName, const SBPalette * colorPalette=nullptr, const std::vector< SBUUID > & actions=std::vector< SBUUID >()) Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.
	SBDVisualPresetStep (const SBDVisualPresetStep & other) Copy constructor.
	SBDVisualPresetStep (SBDVisualPresetStep && other) noexcept Move constructor.
bool	addActionUUID (const SBCContainerUUID & actionUUID) Adds an UUID of an action to the action UUIDs vector. Returns whether `actionUUID` has been added to the list.
void	apply (SBNodeIndexer & nodeIndexer, SBFolder * preferredFolder=nullptr) Applies the visual preset step to nodes in `nodeIndexer` and adds the visual models (if any) to`preferredFolder` .
void	clearColor () Clears the color.
void	clearColorScheme () Clears the color scheme.
void	clearSelectionFilter () Clears the selection filter.
void	clearSelector () Clears the selector.
void	clearVisualModel () Clears the visual model.
virtual SBDVisualPresetStep *	clone () const Clones the visual preset step.
const std::vector< SBUUID > &	getActionUUIDs () const Returns a vector of UUIDs of actions that should be applied to the "selected" nodes.
const SBColor &	getColor () const Returns the color.
const std::string &	getColorSchemeClassName () const Returns the color scheme's class name.
const SBUUID &	getColorSchemeExtensionUUID () const Returns the color scheme's extension UUID.
SBProxy *	getColorSchemeProxy () const Returns a proxy to the color scheme.
SBPalette *	getDefaultPaletteForCurrentColorScheme () const Returns the default color palette of the color scheme.
SBPalette *	getPalette () const Returns the color palette.
const std::string &	getSelectionFilterName () const Returns the selection filter name.
const std::string &	getSelectionFilterString () const Returns the selection filter string.
const std::string &	getSelectorClassName () const Returns the selector's class name.
const SBUUID &	getSelectorExtensionUUID () const Returns the selector's extension UUID.
SBProxy *	getSelectorProxy () const Returns a proxy to the selector.
const std::string &	getVisualModelClassName () const Returns the visual model's class name.
const SBUUID &	getVisualModelExtensionUUID () const Returns the visual model's extension UUID.
SBProxy *	getVisualModelProxy () const Returns a proxy to the visual model.
bool	hasColor () const Returns `true` if the visual preset step has a color.
bool	hasColorScheme () const Returns `true` if the visual preset step has a color scheme.
bool	hasDefaultPalette () const Returns `true` if the color scheme has a default color palette.
bool	hasSelector () const Returns `true` if the visual preset step has a selector.
bool	hasVisualModel () const Returns `true` if the visual preset step has a visual model.
bool	operator!= (const SBDVisualPresetStep & other) const Comparison operator.
SBDVisualPresetStep &	operator= (const SBDVisualPresetStep & other) Copy assignment.
SBDVisualPresetStep &	operator= (SBDVisualPresetStep && other) Move assignment.
bool	operator== (const SBDVisualPresetStep & other) const Comparison operator.
void	removeActionUUID (const SBCContainerUUID & actionUUID) Removes an UUID of an action from the action UUIDs vector.
void	resetPalette () Sets the color palette to the default color palette for this color scheme.
void	setActionUUIDs (const std::vector< SBCContainerUUID > & actionUUIDs) Sets UUIDs of actions that should be applied to the "selected" nodes.
void	setColor (const SBColor & color) Sets the color.
void	setColorSchemeClassName (const std::string & className) Sets the color scheme's class name.
void	setColorSchemeExtensionUUID (const SBUUID & elementUUID) Sets color scheme's extension UUID.
void	setColorSchemeProxy (const SBProxy * proxy) Sets the color scheme by proxy.
void	setPalette (SBPalette * palette) Sets the color palette to `palette` , it takes ownership of the`palette` .
void	setSelectionFilter (const std::string & selectionFilterString, const std::string & selectionFilterName) Sets the selection filter to `selectionFilterString` and its name to`selectionFilterName` .
void	setSelectorProxy (const SBProxy * proxy) Sets the selector by proxy.
void	setVisualModelProxy (const SBProxy * proxy) Sets the visual model by proxy.
virtual std::string	toPythonCode () const Returns the string representation of the object that can be used to reconstruct it in Python.
virtual	~SBDVisualPresetStep () Destructor.

Public Static Functions#

Type	Name
SBNodeColorScheme *	createColorScheme (const std::string & colorSchemeClassName, const SBNodeIndexer & nodeIndexer, const SBPalette * palette=nullptr) Creates a color scheme `colorSchemeClassName` for nodes in`nodeIndexer` colorized with color palette`palette` .
SBProxy *	getColorSchemeProxy (const std::string & publicName) Returns a proxy that corresponds to a color scheme with the public name `publicName` .
SBDPalette *	getDefaultPalette (const std::string & colorSchemeClassName) Returns a clone of the default color palette for color scheme `colorSchemeClassName` .
SBProxy *	getVisualModelProxy (const std::string & publicName) Returns a proxy that corresponds to a visual model with the public name `publicName` .
bool	isPerAttributeColorScheme (const std::string & colorSchemeClassName) Returns `true` if the color scheme`colorSchemeClassName` is a per-attribute color scheme.

Protected Attributes#

Type	Name
SBDVisualPresetStepData *	dataPointer A pointer to the private data.

Detailed Description#

Short name: SBVisualPresetStep

Public Types Documentation#

enum StructureVisibility#

Available structure visibility types.

enum SBDVisualPresetStep::StructureVisibility {
    Hide = 0,
    Show = 1,
    DoNotModify = 2
};

Public Functions Documentation#

function SBDVisualPresetStep [1/13]#

Constructs an empty visual preset step.

SBDVisualPresetStep::SBDVisualPresetStep ()

Initializes a new instance of SBDVisualPresetStep with default settings.

function SBDVisualPresetStep [2/13]#

Builds a visual preset step with the given selection filter and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName,
    const std::vector< SBUUID > & actions
)

Constructs a visual preset step with a selection filter and actions.

Creates a step that selects nodes using the provided filter string and name, and registers the specified actions.

Parameters:

selectionFilterString The filter string defining the node selection criteria.
selectionFilterName The human‑readable name of the selection filter.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [3/13]#

Builds a visual preset step with the given selection filter, visual model, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName,
    const std::string & visualModelClassName=std::string(),
    const SBUUID & visualModelExtensionUUID=SBUUID (),
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step with a selection filter, visual model, and actions.

Creates a step that selects nodes using the filter string and name, visualizes them with the specified visual model, and registers the given actions.

Parameters:

selectionFilterString The filter string defining the node selection criteria.
selectionFilterName The name of the selection filter.
visualModelClassName The class name of the visual model.
visualModelExtensionUUID The extension UUID of the visual model.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [4/13]#

Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName,
    const std::string & visualModelClassName,
    const SBUUID & visualModelExtensionUUID,
    const std::string & colorSchemeClassName,
    const SBUUID & colorSchemeExtensionUUID,
    const SBColor & color,
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step with a selection filter, visual model, color scheme, and constant color.

Creates a step that selects nodes using the given filter, visualizes them with the specified visual model, colors them using the provided color scheme and constant color, and registers the actions.

Parameters:

selectionFilterString The filter string defining the node selection criteria.
selectionFilterName The name of the selection filter.
visualModelClassName The class name of the visual model.
visualModelExtensionUUID The extension UUID of the visual model.
colorSchemeClassName The class name of the color scheme.
colorSchemeExtensionUUID The extension UUID of the color scheme.
color The constant color to be used for the color scheme.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [5/13]#

Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName,
    const std::string & visualModelClassName,
    const SBUUID & visualModelExtensionUUID,
    const std::string & colorSchemeClassName,
    const SBUUID & colorSchemeExtensionUUID,
    const SBPalette * colorPalette=nullptr,
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step with a selection filter, visual model, color scheme, and a custom palette.

Creates a step that selects nodes using the filter, visualizes them with the specified visual model, applies the given color scheme initialized with the provided palette (or the default if nullptr), and registers the actions.

Parameters:

selectionFilterString The filter string defining the node selection criteria.
selectionFilterName The name of the selection filter.
visualModelClassName The class name of the visual model.
visualModelExtensionUUID The extension UUID of the visual model.
colorSchemeClassName The class name of the color scheme.
colorSchemeExtensionUUID The extension UUID of the color scheme.
colorPalette Pointer to a color palette to use; if nullptr, the default palette is used.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [6/13]#

Builds a visual preset step with the given selector and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectorClassName,
    const SBUUID & selectorExtensionUUID,
    const std::vector< SBUUID > & actions
)

Constructs a visual preset step with a selector and actions.

Creates a step that uses the specified selector identified by its class name and extension UUID, and associates the given actions to be applied to the selected nodes.

Parameters:

selectorClassName The class name of the selector.
selectorExtensionUUID The extension UUID of the selector.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [7/13]#

Builds a visual preset step with the given selector, visual model, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectorClassName,
    const SBUUID & selectorExtensionUUID,
    const std::string & visualModelClassName=std::string(),
    const SBUUID & visualModelExtensionUUID=SBUUID (),
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step with a selector, visual model, and actions.

Creates a step that uses the specified selector and visual model, and registers the given actions.

Parameters:

selectorClassName The class name of the selector.
selectorExtensionUUID The extension UUID of the selector.
visualModelClassName The class name of the visual model.
visualModelExtensionUUID The extension UUID of the visual model.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [8/13]#

Builds a visual preset step with the given selector, visual model, color scheme, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectorClassName,
    const SBUUID & selectorExtensionUUID,
    const std::string & visualModelClassName,
    const SBUUID & visualModelExtensionUUID,
    const std::string & colorSchemeClassName,
    const SBUUID & colorSchemeExtensionUUID,
    const SBColor & color,
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step with selector, visual model, color scheme, and constant color.

Creates a step that selects nodes using the specified selector, visualizes them with the given visual model, colors them using the specified color scheme and constant color, and registers the provided actions.

Parameters:

selectorClassName The class name of the selector.
selectorExtensionUUID The extension UUID of the selector.
visualModelClassName The class name of the visual model.
visualModelExtensionUUID The extension UUID of the visual model.
colorSchemeClassName The class name of the color scheme.
colorSchemeExtensionUUID The extension UUID of the color scheme.
color The constant color to be used for the color scheme.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [9/13]#

Builds a visual preset step with the given selector, visual model, color scheme, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectorClassName,
    const SBUUID & selectorExtensionUUID,
    const std::string & visualModelClassName,
    const SBUUID & visualModelExtensionUUID,
    const std::string & colorSchemeClassName,
    const SBUUID & colorSchemeExtensionUUID,
    const SBPalette * colorPalette=nullptr,
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step with selector, visual model, color scheme, and a custom palette.

Creates a step that uses the given selector and visual model, applies the specified color scheme initialized with the provided palette (or the default palette if nullptr), and registers the given actions.

Parameters:

selectorClassName The class name of the selector.
selectorExtensionUUID The extension UUID of the selector.
visualModelClassName The class name of the visual model.
visualModelExtensionUUID The extension UUID of the visual model.
colorSchemeClassName The class name of the color scheme.
colorSchemeExtensionUUID The extension UUID of the color scheme.
colorPalette Pointer to a color palette to use; if nullptr, the default palette is used.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [10/13]#

Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName,
    const std::string & visualModelPublicName,
    const std::string & colorSchemePublicName,
    const SBColor & color,
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step using public names for visual model and color scheme, with a constant color.

Creates a step that selects nodes using the given filter, resolves the visual model and color scheme by their public names, applies the constant color, and registers the actions.

Parameters:

selectionFilterString The filter string defining the node selection criteria.
selectionFilterName The name of the selection filter.
visualModelPublicName The public name of the visual model to use.
colorSchemePublicName The public name of the color scheme to use.
color The constant color to be used for the color scheme.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [11/13]#

Builds a visual preset step with the given selection filter, visual model, color scheme, and actions.

SBDVisualPresetStep::SBDVisualPresetStep (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName,
    const std::string & visualModelPublicName,
    const std::string & colorSchemePublicName,
    const SBPalette * colorPalette=nullptr,
    const std::vector< SBUUID > & actions=std::vector< SBUUID >()
)

Constructs a visual preset step using public names for visual model and color scheme, with a custom palette.

Creates a step that selects nodes using the filter, resolves the visual model and color scheme by their public names, and applies the provided palette (or the default if nullptr) to the color scheme.

Parameters:

selectionFilterString The filter string defining the node selection criteria.
selectionFilterName The name of the selection filter.
visualModelPublicName The public name of the visual model to use.
colorSchemePublicName The public name of the color scheme to use.
colorPalette Pointer to a color palette to use; if nullptr, the default palette is used.
actions A vector of UUIDs of actions to be applied.

function SBDVisualPresetStep [12/13]#

Copy constructor.

SBDVisualPresetStep::SBDVisualPresetStep (
    const SBDVisualPresetStep & other
)

Copy constructs a visual preset step from another instance.

Creates a new visual preset step that is a deep copy of the provided other step, including its selection filter, selector, visual model, color scheme, palette, color, and actions.

Parameters:

other The visual preset step to copy from.

function SBDVisualPresetStep [13/13]#

Move constructor.

SBDVisualPresetStep::SBDVisualPresetStep (
    SBDVisualPresetStep && other
) noexcept

Move constructs a visual preset step from another instance.

Transfers ownership of the internal data from other to this instance, leaving other in a valid but unspecified state.

Parameters:

other The visual preset step to move from.

function addActionUUID#

Adds an UUID of an action to the action UUIDs vector. Returns whether actionUUID has been added to the list.

bool SBDVisualPresetStep::addActionUUID (
    const SBCContainerUUID & actionUUID
)

Adds an UUID of an action to the action UUIDs vector.

Returns whether actionUUID has been added to the list. If this UUID is already present in this visual preset step then it does nothing.

Parameters:

actionUUID The UUID of the action to add.

Returns:

true if the UUID was added; false otherwise.

function apply#

Applies the visual preset step to nodes in nodeIndexer and adds the visual models (if any) topreferredFolder .

void SBDVisualPresetStep::apply (
    SBNodeIndexer & nodeIndexer,
    SBFolder * preferredFolder=nullptr
)

Applies the visual preset step to the given node indexer and optionally to a folder.

Parameters:

nodeIndexer Reference to a node indexer containing the nodes to which the step may be applied.
preferredFolder Optional folder where visual models and other generated objects will be placed; if null, the active document is used.

function clearColor#

Clears the color.

void SBDVisualPresetStep::clearColor ()

Clears any constant color and resets related color scheme settings.

function clearColorScheme#

Clears the color scheme.

void SBDVisualPresetStep::clearColorScheme ()

Clears the color scheme information, resetting class name, extension UUID, and the color flag.

function clearSelectionFilter#

Clears the selection filter.

void SBDVisualPresetStep::clearSelectionFilter ()

Clears the selection filter for this visual preset step.

function clearSelector#

Clears the selector.

void SBDVisualPresetStep::clearSelector ()

Clears the selector information, resetting its class name and extension UUID.

function clearVisualModel#

Clears the visual model.

void SBDVisualPresetStep::clearVisualModel ()

Clears the visual model information, resetting its class name and extension UUID.

function clone#

Clones the visual preset step.

virtual SBDVisualPresetStep * SBDVisualPresetStep::clone () const

Creates a deep copy of this visual preset step.

Returns:

A pointer to a newly allocated SBDVisualPresetStep instance that is a copy of this object.

function getActionUUIDs#

Returns a vector of UUIDs of actions that should be applied to the "selected" nodes.

const std::vector< SBUUID > & SBDVisualPresetStep::getActionUUIDs () const

Returns the list of action UUIDs associated with this visual preset step.

Returns:

Const reference to a vector of SBUUID objects representing the action UUIDs.

function getColor#

Returns the color.

const SBColor & SBDVisualPresetStep::getColor () const

Retrieves the constant color currently set for this visual preset step.

Returns:

Reference to the SBColor object representing the current color.

function getColorSchemeClassName#

Returns the color scheme's class name.

const std::string & SBDVisualPresetStep::getColorSchemeClassName () const

Returns the class name of the color scheme.

Returns:

The color scheme's class name as a constant reference.

function getColorSchemeExtensionUUID#

Returns the color scheme's extension UUID.

const SBUUID & SBDVisualPresetStep::getColorSchemeExtensionUUID () const

Returns the extension UUID of the color scheme.

Returns:

The color scheme's extension UUID.

function getColorSchemeProxy [1/2]#

Returns a proxy to the color scheme.

SBProxy * SBDVisualPresetStep::getColorSchemeProxy () const

Retrieves a proxy for the color scheme, if a color scheme is defined.

Returns:

Pointer to the color scheme proxy, or nullptr if no color scheme is set.

function getDefaultPaletteForCurrentColorScheme#

Returns the default color palette of the color scheme.

SBPalette * SBDVisualPresetStep::getDefaultPaletteForCurrentColorScheme () const

Retrieves the default palette for the color scheme currently set in this visual preset step.

Returns:

Pointer to the default palette, or nullptr if none is available.

function getPalette#

Returns the color palette.

SBPalette * SBDVisualPresetStep::getPalette () const

Retrieves the current color palette associated with the color scheme.

Returns:

Pointer to the SBPalette, or nullptr if no palette is set.

function getSelectionFilterName#

Returns the selection filter name.

const std::string & SBDVisualPresetStep::getSelectionFilterName () const

Returns the selection filter name of the visual preset step.

Returns:

A constant reference to the selection filter name.

function getSelectionFilterString#

Returns the selection filter string.

const std::string & SBDVisualPresetStep::getSelectionFilterString () const

Returns the selection filter string of the visual preset step.

Returns:

A constant reference to the selection filter string.

function getSelectorClassName#

Returns the selector's class name.

const std::string & SBDVisualPresetStep::getSelectorClassName () const

Returns the class name of the selector.

Returns:

The selector's class name as a constant reference.

function getSelectorExtensionUUID#

Returns the selector's extension UUID.

const SBUUID & SBDVisualPresetStep::getSelectorExtensionUUID () const

Returns the extension UUID of the selector.

Returns:

The selector's extension UUID.

function getSelectorProxy#

Returns a proxy to the selector.

SBProxy * SBDVisualPresetStep::getSelectorProxy () const

Retrieves a proxy for the selector, if a selector is defined.

Returns:

Pointer to the selector proxy, or nullptr if no selector is set.

function getVisualModelClassName#

Returns the visual model's class name.

const std::string & SBDVisualPresetStep::getVisualModelClassName () const

Returns the class name of the visual model.

Returns:

The visual model's class name as a constant reference.

function getVisualModelExtensionUUID#

Returns the visual model's extension UUID.

const SBUUID & SBDVisualPresetStep::getVisualModelExtensionUUID () const

Returns the extension UUID of the visual model.

Returns:

The visual model's extension UUID.

function getVisualModelProxy [1/2]#

Returns a proxy to the visual model.

SBProxy * SBDVisualPresetStep::getVisualModelProxy () const

Retrieves a proxy for the visual model, if a visual model is defined.

Returns:

Pointer to the visual model proxy, or nullptr if no visual model is set.

function hasColor#

Returns true if the visual preset step has a color.

bool SBDVisualPresetStep::hasColor () const

Checks whether a constant color has been set for this visual preset step.

Returns:

true if a constant color is set, false otherwise.

function hasColorScheme#

Returns true if the visual preset step has a color scheme.

bool SBDVisualPresetStep::hasColorScheme () const

Checks whether a color scheme is defined for this visual preset step.

Returns:

true if a color scheme exists, false otherwise.

function hasDefaultPalette#

Returns true if the color scheme has a default color palette.

bool SBDVisualPresetStep::hasDefaultPalette () const

Determines whether the current color scheme has an associated default palette.

Returns:

true if a default palette is available for the current color scheme, false otherwise.

function hasSelector#

Returns true if the visual preset step has a selector.

bool SBDVisualPresetStep::hasSelector () const

Checks whether a selector is defined for this visual preset step.

Returns:

true if a selector exists, false otherwise.

function hasVisualModel#

Returns true if the visual preset step has a visual model.

bool SBDVisualPresetStep::hasVisualModel () const

Checks whether a visual model is defined for this visual preset step.

Returns:

true if a visual model exists, false otherwise.

function operator!=#

Comparison operator.

bool SBDVisualPresetStep::operator!= (
    const SBDVisualPresetStep & other
) const

Inequality comparison operator.

Determines whether this visual preset step is not equal to other.

Parameters:

other The visual preset step to compare against.

Returns:

true if the two steps are not equal; false otherwise.

function operator=#

Copy assignment.

SBDVisualPresetStep & SBDVisualPresetStep::operator= (
    const SBDVisualPresetStep & other
)

Copy assignment operator.

Copies the contents of other into this visual preset step. If other has no data, an error message is printed and the object remains unchanged.

Parameters:

other The source visual preset step to copy from.

Returns:

Reference to this visual preset step after assignment.

function operator=#

Move assignment.

SBDVisualPresetStep & SBDVisualPresetStep::operator= (
    SBDVisualPresetStep && other
)

Move assignment operator.

Moves the contents of other into this visual preset step, transferring ownership of the internal data. After the operation, other will have no data.

Parameters:

other The source visual preset step to move from.

Returns:

Reference to this visual preset step after assignment.

function operator==#

Comparison operator.

bool SBDVisualPresetStep::operator== (
    const SBDVisualPresetStep & other
) const

Equality comparison operator.

Determines whether this visual preset step is equal to other by comparing all of its properties and action UUIDs.

Parameters:

other The visual preset step to compare against.

Returns:

true if the two steps are equal; false otherwise.

function removeActionUUID#

Removes an UUID of an action from the action UUIDs vector.

void SBDVisualPresetStep::removeActionUUID (
    const SBCContainerUUID & actionUUID
)

Removes an action UUID from the action list.

Removes the specified actionUUID from the internal list of action UUIDs if it exists. If the UUID is not present, the function has no effect.

Parameters:

actionUUID The UUID of the action to remove.

function resetPalette#

Sets the color palette to the default color palette for this color scheme.

void SBDVisualPresetStep::resetPalette ()

Resets the color palette to the default palette for the current color scheme.

function setActionUUIDs#

Sets UUIDs of actions that should be applied to the "selected" nodes.

void SBDVisualPresetStep::setActionUUIDs (
    const std::vector< SBCContainerUUID > & actionUUIDs
)

Replaces the current list of action UUIDs with the provided list.

Parameters:

actionUUIDs Vector of action UUIDs to set.

function setColor#

Sets the color.

void SBDVisualPresetStep::setColor (
    const SBColor & color
)

Sets a constant color for this visual preset step and updates the color scheme if necessary.

Parameters:

color The color to set.

function setColorSchemeClassName#

Sets the color scheme's class name.

void SBDVisualPresetStep::setColorSchemeClassName (
    const std::string & className
)

Sets the class name of the color scheme.

Parameters:

className The new class name for the color scheme.

function setColorSchemeExtensionUUID#

Sets color scheme's extension UUID.

void SBDVisualPresetStep::setColorSchemeExtensionUUID (
    const SBUUID & elementUUID
)

Sets the extension UUID of the color scheme.

Parameters:

elementUUID The new extension UUID for the color scheme.

function setColorSchemeProxy#

Sets the color scheme by proxy.

void SBDVisualPresetStep::setColorSchemeProxy (
    const SBProxy * proxy
)

Sets the color scheme based on the provided proxy.

If no palette is set, the default palette is used. For constant color schemes, ensures a color is set.

Parameters:

proxy Pointer to an SBProxy representing a color scheme; may be nullptr.

function setPalette#

Sets the color palette to palette , it takes ownership of thepalette .

void SBDVisualPresetStep::setPalette (
    SBPalette * palette
)

Sets the color palette for the color scheme, taking ownership of the provided palette.

Parameters:

palette Pointer to the new SBPalette; the existing palette is deleted.

function setSelectionFilter#

Sets the selection filter to selectionFilterString and its name toselectionFilterName .

void SBDVisualPresetStep::setSelectionFilter (
    const std::string & selectionFilterString,
    const std::string & selectionFilterName
)

Sets the selection filter for this visual preset step.

Parameters:

selectionFilterString The selection filter expression string.
selectionFilterName The human readable name for the selection filter.

function setSelectorProxy#

Sets the selector by proxy.

void SBDVisualPresetStep::setSelectorProxy (
    const SBProxy * proxy
)

Sets the selector based on the provided proxy.

The current selector and selection filter are cleared before setting.

Parameters:

proxy Pointer to an SBProxy representing a selector; may be nullptr.

function setVisualModelProxy#

Sets the visual model by proxy.

void SBDVisualPresetStep::setVisualModelProxy (
    const SBProxy * proxy
)

Sets the visual model based on the provided proxy.

The current visual model is cleared before setting.

Parameters:

proxy Pointer to an SBProxy representing a visual model; may be nullptr.

function toPythonCode#

Returns the string representation of the object that can be used to reconstruct it in Python.

virtual std::string SBDVisualPresetStep::toPythonCode () const

Generates a Python code representation of the visual preset step.

Constructs a string containing a Python constructor call that can be used to recreate this visual preset step, including its selection filter, visual model, color scheme, colors, palette, and actions.

Returns:

A string with the Python code representation of this object.

function ~SBDVisualPresetStep#

Destructor.

virtual SBDVisualPresetStep::~SBDVisualPresetStep ()

Destroys the visual preset step, releasing any owned resources.

Public Static Functions Documentation#

function createColorScheme#

Creates a color scheme colorSchemeClassName for nodes innodeIndexer colorized with color palettepalette .

static SBNodeColorScheme * SBDVisualPresetStep::createColorScheme (
    const std::string & colorSchemeClassName,
    const SBNodeIndexer & nodeIndexer,
    const SBPalette * palette=nullptr
)

Creates a node color scheme instance for a given per-attribute color scheme.

Parameters:

colorSchemeClassName Name of the color scheme class to create.
nodeIndexer Indexer that provides the nodes to be colored.
palette Optional color palette to initialize the scheme. May be nullptr.

Returns:

Pointer to a newly allocated SBNodeColorScheme instance, or nullptr if the class name is not recognized.

function getColorSchemeProxy [2/2]#

Returns a proxy that corresponds to a color scheme with the public name publicName .

static SBProxy * SBDVisualPresetStep::getColorSchemeProxy (
    const std::string & publicName
)

Retrieves a color scheme proxy by public name.

Returns a pointer to the color scheme proxy whose public name matches publicName. If publicName is empty or no matching proxy is found, returns nullptr.

Parameters:

publicName The public name of the color scheme to locate.

Returns:

Pointer to the matching SBProxy object, or nullptr if not found.

function getDefaultPalette#

Returns a clone of the default color palette for color scheme colorSchemeClassName .

static SBDPalette * SBDVisualPresetStep::getDefaultPalette (
    const std::string & colorSchemeClassName
)

Retrieves the default color palette for a per-attribute color scheme.

Parameters:

colorSchemeClassName Name of the color scheme class.

Returns:

Pointer to a newly allocated SBDPalette containing the default palette, or nullptr if the class name is not recognized.

function getVisualModelProxy [2/2]#

Returns a proxy that corresponds to a visual model with the public name publicName .

static SBProxy * SBDVisualPresetStep::getVisualModelProxy (
    const std::string & publicName
)

Retrieves a visual model proxy by public name.

Returns a pointer to the visual model proxy whose public name matches publicName. If publicName is empty or no matching proxy is found, returns nullptr.

Parameters:

publicName The public name of the visual model to locate.

Returns:

Pointer to the matching SBProxy object, or nullptr if not found.

function isPerAttributeColorScheme#

Returns true if the color schemecolorSchemeClassName is a per-attribute color scheme.

static bool SBDVisualPresetStep::isPerAttributeColorScheme (
    const std::string & colorSchemeClassName
)

Determines whether the given color scheme class name corresponds to a per-attribute color scheme.

Parameters:

colorSchemeClassName The name of the color scheme class to check.

Returns:

true if the class name represents a per-attribute color scheme, false otherwise.

Protected Attributes Documentation#

variable dataPointer#

A pointer to the private data.

SBDVisualPresetStepData* SBDVisualPresetStep::dataPointer;