Web Analytics Made Easy - Statcounter
Skip to content

Class SBDVisualPresetStep#

ClassList > SBDVisualPresetStep

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

  • #include <SBDVisualPresetStep.hpp>

Public Types#

Type Name
enum StructureVisibility

Public Functions#

Type Name
SBDVisualPresetStep ()
SBDVisualPresetStep (const std::string & selectionFilterString, const std::string & selectionFilterName, const std::vector< SBUUID > & 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 >())
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 >())
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 >())
SBDVisualPresetStep (const std::string & selectorClassName, const SBUUID & selectorExtensionUUID, const std::vector< SBUUID > & 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 >())
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 >())
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 >())
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 >())
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 >())
SBDVisualPresetStep (const SBDVisualPresetStep & other)
Copy constructor.
SBDVisualPresetStep (SBDVisualPresetStep && other) noexcept
Move constructor.
SB_DECLARE_DATA (SBDVisualPresetStep)
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) topreferredFolder .
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
SBDVisualPresetStep & operator= (const SBDVisualPresetStep & other)
Copy assignment.
SBDVisualPresetStep & operator= (SBDVisualPresetStep && other)
Move assignment.
bool operator== (const SBDVisualPresetStep & other) const
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 thepalette .
void setSelectionFilter (const std::string & selectionFilterString, const std::string & selectionFilterName)
Sets the selection filter to selectionFilterString and its name toselectionFilterName .
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 ()

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 innodeIndexer colorized with color palettepalette .
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

Detailed Description#

Short name: SBVisualPresetStep

Public Types Documentation#

enum StructureVisibility#

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

Public Functions Documentation#

function SBDVisualPresetStep [1/13]#

SBDVisualPresetStep::SBDVisualPresetStep ()

function SBDVisualPresetStep [2/13]#

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

function SBDVisualPresetStep [3/13]#

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 >()
)

function SBDVisualPresetStep [4/13]#

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 >()
)

function SBDVisualPresetStep [5/13]#

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 >()
)

function SBDVisualPresetStep [6/13]#

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

function SBDVisualPresetStep [7/13]#

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 >()
)

function SBDVisualPresetStep [8/13]#

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 >()
)

function SBDVisualPresetStep [9/13]#

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 >()
)

function SBDVisualPresetStep [10/13]#

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 >()
)

function SBDVisualPresetStep [11/13]#

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 >()
)

function SBDVisualPresetStep [12/13]#

Copy constructor. 

SBDVisualPresetStep::SBDVisualPresetStep (
    const SBDVisualPresetStep & other
)

function SBDVisualPresetStep [13/13]#

Move constructor. 

SBDVisualPresetStep::SBDVisualPresetStep (
    SBDVisualPresetStep && other
) noexcept

function SB_DECLARE_DATA#

SBDVisualPresetStep::SB_DECLARE_DATA (
    SBDVisualPresetStep
)

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.

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
)

function clearColor#

Clears the color. 

void SBDVisualPresetStep::clearColor ()

function clearColorScheme#

Clears the color scheme. 

void SBDVisualPresetStep::clearColorScheme ()

function clearSelectionFilter#

Clears the selection filter. 

void SBDVisualPresetStep::clearSelectionFilter ()

function clearSelector#

Clears the selector. 

void SBDVisualPresetStep::clearSelector ()

function clearVisualModel#

Clears the visual model. 

void SBDVisualPresetStep::clearVisualModel ()

function clone#

Clones the visual preset step. 

virtual SBDVisualPresetStep * SBDVisualPresetStep::clone () const

function getActionUUIDs#

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

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

function getColor#

Returns the color. 

const SBColor & SBDVisualPresetStep::getColor () const

function getColorSchemeClassName#

Returns the color scheme's class name. 

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

function getColorSchemeExtensionUUID#

Returns the color scheme's extension UUID. 

const SBUUID & SBDVisualPresetStep::getColorSchemeExtensionUUID () const

function getColorSchemeProxy [1/2]#

Returns a proxy to the color scheme. 

SBProxy * SBDVisualPresetStep::getColorSchemeProxy () const

function getDefaultPaletteForCurrentColorScheme#

Returns the default color palette of the color scheme. 

SBPalette * SBDVisualPresetStep::getDefaultPaletteForCurrentColorScheme () const

function getPalette#

Returns the color palette. 

SBPalette * SBDVisualPresetStep::getPalette () const

function getSelectionFilterName#

Returns the selection filter name. 

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

function getSelectionFilterString#

Returns the selection filter string. 

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

function getSelectorClassName#

Returns the selector's class name. 

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

function getSelectorExtensionUUID#

Returns the selector's extension UUID. 

const SBUUID & SBDVisualPresetStep::getSelectorExtensionUUID () const

function getSelectorProxy#

Returns a proxy to the selector. 

SBProxy * SBDVisualPresetStep::getSelectorProxy () const

function getVisualModelClassName#

Returns the visual model's class name. 

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

function getVisualModelExtensionUUID#

Returns the visual model's extension UUID. 

const SBUUID & SBDVisualPresetStep::getVisualModelExtensionUUID () const

function getVisualModelProxy [1/2]#

Returns a proxy to the visual model. 

SBProxy * SBDVisualPresetStep::getVisualModelProxy () const

function hasColor#

Returns true if the visual preset step has a color. 

bool SBDVisualPresetStep::hasColor () const

function hasColorScheme#

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

bool SBDVisualPresetStep::hasColorScheme () const

function hasDefaultPalette#

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

bool SBDVisualPresetStep::hasDefaultPalette () const

function hasSelector#

Returns true if the visual preset step has a selector. 

bool SBDVisualPresetStep::hasSelector () const

function hasVisualModel#

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

bool SBDVisualPresetStep::hasVisualModel () const

function operator!=#

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

function operator=#

Copy assignment. 

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

function operator=#

Move assignment. 

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

function operator==#

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

function removeActionUUID#

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

void SBDVisualPresetStep::removeActionUUID (
    const SBCContainerUUID & actionUUID
)

function resetPalette#

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

void SBDVisualPresetStep::resetPalette ()

function setActionUUIDs#

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

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

function setColor#

Sets the color. 

void SBDVisualPresetStep::setColor (
    const SBColor & color
)

function setColorSchemeClassName#

Sets the color scheme's class name. 

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

function setColorSchemeExtensionUUID#

Sets color scheme's extension UUID. 

void SBDVisualPresetStep::setColorSchemeExtensionUUID (
    const SBUUID & elementUUID
)

function setColorSchemeProxy#

Sets the color scheme by proxy. 

void SBDVisualPresetStep::setColorSchemeProxy (
    const SBProxy * proxy
)

function setPalette#

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

void SBDVisualPresetStep::setPalette (
    SBPalette * palette
)

function setSelectionFilter#

Sets the selection filter to selectionFilterString and its name toselectionFilterName . 

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

function setSelectorProxy#

Sets the selector by proxy. 

void SBDVisualPresetStep::setSelectorProxy (
    const SBProxy * proxy
)

function setVisualModelProxy#

Sets the visual model by proxy. 

void SBDVisualPresetStep::setVisualModelProxy (
    const SBProxy * proxy
)

function toPythonCode#

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

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

function ~SBDVisualPresetStep#

virtual SBDVisualPresetStep::~SBDVisualPresetStep ()

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
)

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
)

function getDefaultPalette#

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

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

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
)

function isPerAttributeColorScheme#

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

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

Protected Attributes Documentation#

variable dataPointer#

SBDVisualPresetStepData* dataPointer;