SBDColorSchemePerChainIllustrate Class Reference

This class describes an illustrative color scheme, based on chain ID, inspired by the "Molecule of the Month" style of the Protein Data Bank. More...

Constructors and destructors
	SBDColorSchemePerChainIllustrate ()
	SBDColorSchemePerChainIllustrate (const SBNodeIndexer &nodeIndexer, const SBDPalette *palette=nullptr)
virtual	~SBDColorSchemePerChainIllustrate ()

Serialization
virtual bool	isSerializable () const override
	Returns true.
virtual void	serialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) const override
	Serializes the color scheme.
virtual void	unserialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) override
	Unserializes the color scheme.

Clone function
virtual SBDDataGraphNodeColorScheme *	clone () const override
	Returns a copy of the color scheme.

Colors
virtual void	getColor (float *color, SBDDataGraphNode *node=nullptr, const SBPosition3 &position=SBPosition3::zero) const override
	Returns a color given a node and / or a position.

Default color palette
virtual SBDPalette *	getDefaultPalette () const override
	Returns a clone of the default color palette for this color scheme.

Additional Inherited Members
Public Member Functions inherited from SBDColorSchemePerAttribute< int >
int	getMinimumValue () const
int	getMaximumValue () const
int	getDefaultMinimumValue () const
int	getDefaultMaximumValue () const
void	setMinimumValue (int value)
void	setMaximumValue (int value)
	SBDColorSchemePerAttribute ()
	SBDColorSchemePerAttribute (const SBNodeIndexer &nodeIndexer, const SBDDataGraphNodePredicate &nodePredicate, const SBDDataGraphNodeGetter< int > &nodeGetter)
virtual	~SBDColorSchemePerAttribute ()
virtual bool	canHavePalette () const override
	Returns whether the color scheme requires and therefore can have a color palette.
Public Member Functions inherited from SBDDataGraphNodeColorScheme
	SBDDataGraphNodeColorScheme ()
	Constructs a color scheme.
virtual	~SBDDataGraphNodeColorScheme ()
	Destructs the color scheme.
bool	hasPalette () const
	Returns whether the color scheme has a color palette defined.
const SBDPalette *	getPalette () const
	Returns a pointer to a color palette owned by the color scheme.
void	setPalette (SBDPalette *palette)
	Sets the color palette for color schemes that can have it. The color scheme takes ownership of the color palette. If NULL is supplied then it will reset to the default color palette.
void	resetPalette ()
	Resets the color palette to the default one for color schemes that can have it.
void	requestUpdate ()
	Requests a material update for a node to which the material that owns this color scheme is applied.
	SB_DECLARE_DATA (SBDDataGraphNodeColorScheme)
Public Member Functions inherited from SBCReferenceTarget
unsigned int	getMemoryFootprint () const
void	printReferencesToOwners () const
	SBCReferenceTarget ()
virtual	~SBCReferenceTarget ()
Protected Member Functions inherited from SBDDataGraphNodeColorScheme
	SBDDataGraphNodeColorScheme (SBDDataGraphNodeColorSchemeData *dataPointer)
Protected Member Functions inherited from SBCReferenceTarget
void	removeAllReferenceOwners ()
	SBCReferenceTarget (SBCReferenceTargetData *dataPointer)
Protected Attributes inherited from SBDColorSchemePerAttribute< int >
int *	minValue
	The current minimum value for the attribute bounds used for colorization.
int *	maxValue
	The current maximum value for the attribute bounds used for colorization.
int *	defaultMinValue
	The default minimum value for the attribute bounds determined when constructing the color scheme based on the input node indexer.
int *	defaultMaxValue
	The default maximum value for the attribute bounds determined when constructing the color scheme based on the input node indexer.
SBNodeIndexer	nodeIndexer
SBDDataGraphNodePredicate *	nodePredicate
SBDDataGraphNodeGetter< int > *	nodeGetter
Protected Attributes inherited from SBCReferenceTarget
SBCReferenceTargetData *	dataPointer

Detailed Description

This class describes an illustrative per chain ID color scheme inspired by the "Molecule of the Month" style of the Protein Data Bank.

Please refer to this page for more information.

See also

Color schemes

Member Function Documentation

clone()

SBDDataGraphNodeColorScheme * SBDColorSchemePerChainIllustrate::clone ( ) const

overridevirtual

Reimplemented from SBDDataGraphNodeColorScheme.

getColor()

void SBDColorSchemePerChainIllustrate::getColor ( float *  color, SBDDataGraphNode *  node = nullptr, const SBPosition3 &  position = SBPosition3::zero  ) const

overridevirtual

Reimplemented from SBDColorSchemePerAttribute< int >.

getDefaultPalette()

SBPalette * SBDColorSchemePerChainIllustrate::getDefaultPalette ( ) const

overridevirtual

Reimplemented from SBDColorSchemePerAttribute< int >.

isSerializable()

bool SBDColorSchemePerChainIllustrate::isSerializable ( ) const

overridevirtual

Reimplemented from SBDColorSchemePerAttribute< int >.

serialize()

void SBDColorSchemePerChainIllustrate::serialize ( SBCSerializer *  serializer, const SBNodeIndexer &  nodeIndexer, const SBVersionNumber &  sdkVersionNumber = SB_SDK_VERSION_NUMBER, const SBVersionNumber &  classVersionNumber = SBVersionNumber(1, 0, 0)  ) const

overridevirtual

Reimplemented from SBDColorSchemePerAttribute< int >.

unserialize()

void SBDColorSchemePerChainIllustrate::unserialize ( SBCSerializer *  serializer, const SBNodeIndexer &  nodeIndexer, const SBVersionNumber &  sdkVersionNumber = SB_SDK_VERSION_NUMBER, const SBVersionNumber &  classVersionNumber = SBVersionNumber(1, 0, 0)  )

overridevirtual

Reimplemented from SBDColorSchemePerAttribute< int >.