Class SBDVisualPreset#

The SBDVisualPreset class is a base class for visual preset.More...

#include <SBDVisualPreset.hpp>

Public Functions#

Type	Name
	SBDVisualPreset (const std::string & name, const std::vector< SBDVisualPresetStep * > & visualPresetSteps=std::vector< SBDVisualPresetStep * >()) Constructor that does a deep copy of the vector of visual preset steps, i.e. it clones visual preset steps.
	SBDVisualPreset (const std::string & name, std::vector< SBDVisualPresetStep * > && visualPresetSteps) noexcept Constructor taking the vector of visual preset steps by move.
	SBDVisualPreset (const SBDVisualPreset & other) Copy constructor.
	SBDVisualPreset (SBDVisualPreset && other) noexcept Move constructor.
	SB_DECLARE_DATA (SBDVisualPreset)
void	addVisualPresetStep (const SBDVisualPresetStep & visualPresetStep) Adds the cloned visual preset step `visualPresetStep` to this visual preset.
void	apply (SBNodeIndexer & nodeIndexer, SBFolder * preferredFolder=nullptr) Applies the visual preset to nodes in `nodeIndexer` and adds the node groups and visual models (if any) to`preferredFolder` .
virtual SBDVisualPreset *	clone () const Clones the visual preset.
void	deleteVisualPresetStep (int index) Deletes the visual preset step with index `index` from the visual preset.
void	deleteVisualPresetStep (SBDVisualPresetStep * visualPresetStep) Removes the visual preset step `visualPresetStep` from the visual preset if it has any, and, if found, deletes the visual preset step`visualPresetStep` .
const std::string &	getName () const Returns the name of the visual preset.
int	getNumberOfVisualPresetSteps () const Returns the number of visual preset steps.
const std::vector< SBDVisualPresetStep * > &	getVisualPresetSteps () const Returns the vector of visual preset steps.
bool	operator!= (const SBDVisualPreset & other) const
SBDVisualPreset &	operator= (const SBDVisualPreset & other) Copy assignment operator.
SBDVisualPreset &	operator= (SBDVisualPreset && other) noexcept Move assignment operator.
bool	operator== (const SBDVisualPreset & other) const
void	setName (const std::string & name) Sets the name of the visual preset to `name` .
void	swap (int i, int j) Swaps visual preset steps `i` and`j` .
virtual std::string	toPythonCode () const Returns the string representation of the object that can be used to reconstruct it in Python.
virtual	~SBDVisualPreset ()

Public Static Functions#

Type	Name
const std::vector< const SBDVisualPreset * > *	getDefaultVisualPresets () Returns a vector of the default visual presets.

Protected Attributes#

Type	Name
SBDVisualPresetData *	dataPointer

Detailed Description#

Short name: SBVisualPreset

Public Functions Documentation#

function SBDVisualPreset [1/4]#

Constructor that does a deep copy of the vector of visual preset steps, i.e. it clones visual preset steps.

SBDVisualPreset::SBDVisualPreset (
    const std::string & name,
    const std::vector< SBDVisualPresetStep * > & visualPresetSteps=std::vector< SBDVisualPresetStep * >()
)

function SBDVisualPreset [2/4]#

Constructor taking the vector of visual preset steps by move.

SBDVisualPreset::SBDVisualPreset (
    const std::string & name,
    std::vector< SBDVisualPresetStep * > && visualPresetSteps
) noexcept

function SBDVisualPreset [3/4]#

Copy constructor.

SBDVisualPreset::SBDVisualPreset (
    const SBDVisualPreset & other
)

function SBDVisualPreset [4/4]#

Move constructor.

SBDVisualPreset::SBDVisualPreset (
    SBDVisualPreset && other
) noexcept

function SB_DECLARE_DATA#

SBDVisualPreset::SB_DECLARE_DATA (
    SBDVisualPreset
)

function addVisualPresetStep#

Adds the cloned visual preset step visualPresetStep to this visual preset.

void SBDVisualPreset::addVisualPresetStep (
    const SBDVisualPresetStep & visualPresetStep
)

function apply#

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

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

function clone#

Clones the visual preset.

virtual SBDVisualPreset * SBDVisualPreset::clone () const

function deleteVisualPresetStep [1/2]#

Deletes the visual preset step with index index from the visual preset.

void SBDVisualPreset::deleteVisualPresetStep (
    int index
)

function deleteVisualPresetStep [2/2]#

Removes the visual preset step visualPresetStep from the visual preset if it has any, and, if found, deletes the visual preset stepvisualPresetStep .

void SBDVisualPreset::deleteVisualPresetStep (
    SBDVisualPresetStep * visualPresetStep
)

function getName#

Returns the name of the visual preset.

const std::string & SBDVisualPreset::getName () const

function getNumberOfVisualPresetSteps#

Returns the number of visual preset steps.

int SBDVisualPreset::getNumberOfVisualPresetSteps () const

function getVisualPresetSteps#

Returns the vector of visual preset steps.

const std::vector< SBDVisualPresetStep * > & SBDVisualPreset::getVisualPresetSteps () const

function operator!=#

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

function operator=#

Copy assignment operator.

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

function operator=#

Move assignment operator.

SBDVisualPreset & SBDVisualPreset::operator= (
    SBDVisualPreset && other
) noexcept

function operator==#

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

function setName#

Sets the name of the visual preset to name .

void SBDVisualPreset::setName (
    const std::string & name
)

function swap#

Swaps visual preset steps i andj .

void SBDVisualPreset::swap (
    int i,
    int j
)

function toPythonCode#

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

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

function ~SBDVisualPreset#

virtual SBDVisualPreset::~SBDVisualPreset ()

Public Static Functions Documentation#

function getDefaultVisualPresets#

Returns a vector of the default visual presets.

static const std::vector< const SBDVisualPreset * > * SBDVisualPreset::getDefaultVisualPresets ()

Protected Attributes Documentation#

variable dataPointer#

SBDVisualPresetData* dataPointer;