SBDVisualPreset Class Reference

The SBDVisualPreset class is a base class for visual presets.

Public Member Functions
	SB_DECLARE_DATA (SBDVisualPreset)

Protected Attributes
SBDVisualPresetData *	dataPointer

Constructors and destructors
	SBDVisualPreset ()
	SBDVisualPreset (const std::string &selectorClassName, const SBUUID &selectorElementUUID, const std::string &visualModelClassName=std::string(), const SBUUID &visualModelElementUUID=SBUUID(), bool hideStructureFlag=true)
	SBDVisualPreset (const std::string &selectorClassName, const SBUUID &selectorElementUUID, const std::string &visualModelClassName, const SBUUID &visualModelElementUUID, const SBColor &color, bool hideStructureFlag=true)
	SBDVisualPreset (const std::string &selectorClassName, const SBUUID &selectorElementUUID, const std::string &visualModelClassName, const SBUUID &visualModelElementUUID, const std::string &colorSchemeClassName, const SBUUID &colorSchemeElementUUID, const SBColorPalette *colorPalette=nullptr, bool hideStructureFlag=true)
virtual	~SBDVisualPreset ()

Clone function
virtual SBDVisualPreset *	clone () const
	Clones the preset.

Functionality for the default per attribute color schemes
static bool	isPerAttributeColorScheme (const std::string &colorSchemeClassName)
	Returns true if the color scheme colorSchemeClassName is a per-attribute color scheme.
static const SBDColorPalette *	getDefaultColorPalette (const std::string &colorSchemeClassName)
	Returns the default color palette for color scheme colorSchemeClassName.
static SBNodeColorScheme *	createColorScheme (const std::string &colorSchemeClassName, const SBNodeIndexer &nodeIndexer, const SBColorPalette *colorPalette)
	Creates a color scheme colorSchemeClassName.

Apply function
void	apply (SBNodeIndexer &nodeIndexer, SBFolder *preferredFolder=nullptr)
	Applies the visual preset to nodes in nodeIndexer and adds the visual models (if any) to preferredFolder.

Visual preset parameters
bool	hasSelector () const
	Returns true if the visual preset has a selector.
void	clearSelector ()
	Clears the selector.
SBProxy *	getSelectorProxy () const
	Returns a proxy to the selector.
void	setSelectorProxy (SBProxy *proxy)
	Sets the selector by proxy.
const std::string &	getSelectorClassName () const
	Returns the selector's class name.
void	setSelectorClassName (const std::string &className)
	Sets the selector's class name.
const SBUUID &	getSelectorElementUUID () const
	Returns the selector's extension UUID.
void	setSelectorElementUUID (const SBUUID &elementUUID)
	Sets the selector's extension UUID.
bool	hasVisualModel () const
	Returns true if the visual preset has a visual model.
void	clearVisualModel ()
	Clears the visual model.
SBProxy *	getVisualModelProxy () const
	Returns a proxy to the visual model.
void	setVisualModelProxy (SBProxy *proxy)
	Sets the visual model by proxy.
const std::string &	getVisualModelClassName () const
	Returns the visual model's class name.
void	setVisualModelClassName (const std::string &className)
	Sets the visual model's class name.
const SBUUID &	getVisualModelElementUUID () const
	Returns the visual model's extension UUID.
void	setVisualModelElementUUID (const SBUUID &elementUUID)
	Sets the visual model's extension UUID.
bool	hasColorScheme () const
	Returns true if the visual preset has a color scheme.
void	clearColorScheme ()
	Clears the color scheme.
SBProxy *	getColorSchemeProxy () const
	Returns a proxy to the color scheme.
void	setColorSchemeProxy (SBProxy *proxy)
	Sets the color scheme by proxy.
const std::string &	getColorSchemeClassName () const
	Returns the color scheme's class name.
void	setColorSchemeClassName (const std::string &className)
	Sets the color scheme's class name.
const SBUUID &	getColorSchemeElementUUID () const
	Returns the color scheme's extension UUID.
void	setColorSchemeElementUUID (const SBUUID &elementUUID)
	Sets color scheme's extension UUID.
bool	hasDefaultColorPalette () const
	Returns true if the color scheme has a default color palette.
SBColorPalette *	getDefaultColorPaletteForCurrentColorScheme () const
	Returns the default color palette of the color scheme.
SBColorPalette *	getColorPalette () const
	Returns the color palette.
void	setColorPalette (SBColorPalette *colorPalette)
	Sets the color palette.
void	setColorPaletteToDefaultColorPaletteForCurrentColorScheme ()
	Sets the color palette to the default color palette of the color scheme.
bool	hasColor () const
	Returns true if the visual preset has a color.
void	clearColor ()
	Clears the color.
const SBColor &	getColor () const
	Returns the color.
void	setColor (const SBColor &color)
	Sets the proxy.
bool	getHideStructureFlag () const
	Returns the hide structure flag.
void	setHideStructureFlag (bool flag)
	Sets the hide structure flag.