SBDDataGraphNodeColorScheme Class Reference

This class describes a color scheme. More...

Constructors and destructors
	SBDDataGraphNodeColorScheme ()
	Constructs a color scheme.
virtual	~SBDDataGraphNodeColorScheme ()
	Destructs the color scheme.

Serialization
virtual bool	isSerializable () const
	Returns true when the class is serializable.
virtual void	serialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) const
	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))
	Unserializes the color scheme.

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

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

Color palette
virtual bool	canHavePalette () const
	Returns whether the color scheme requires and therefore can have a color palette.
virtual SBDPalette *	getDefaultPalette () const
	Returns a clone of the default color palette for this 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.

Update
void	requestUpdate ()
	Requests a material update for a node to which the material that owns this color scheme is applied.
	SB_DECLARE_DATA (SBDDataGraphNodeColorScheme)
	SBDDataGraphNodeColorScheme (SBDDataGraphNodeColorSchemeData *dataPointer)

Additional Inherited Members
Public Member Functions inherited from SBCReferenceTarget
unsigned int	getMemoryFootprint () const
void	printReferencesToOwners () const
	SBCReferenceTarget ()
virtual	~SBCReferenceTarget ()
Protected Member Functions inherited from SBCReferenceTarget
void	removeAllReferenceOwners ()
	SBCReferenceTarget (SBCReferenceTargetData *dataPointer)
Protected Attributes inherited from SBCReferenceTarget
SBCReferenceTargetData *	dataPointer

Detailed Description

This class describes a color scheme in SAMSON. Please refer to this page for more information.

See also

Color schemes

Member Function Documentation

canHavePalette()

bool SBDDataGraphNodeColorScheme::canHavePalette ( ) const

virtual

Reimplemented in SBDColorSchemePerAttribute< Output >, SBDColorSchemePerAttribute< int >, SBDColorSchemePerAttribute< SBQuantity::dimensionless >, SBDColorSchemePerAttribute< float >, SBDColorSchemePerAttribute< double >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::ResidueType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SecondaryStructureType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >, and SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainPolarity >.

clone()

SBDDataGraphNodeColorScheme * SBDDataGraphNodeColorScheme::clone ( ) const

virtual

Reimplemented in SBDColorSchemeConstant, SBDColorSchemeConstantIllustrate, SBDColorSchemeCPK, SBDColorSchemePerChainID, SBDColorSchemePerChainIllustrate, SBDColorSchemePerFormalCharge, SBDColorSchemePerOccupancy, SBDColorSchemePerPartialCharge, SBDColorSchemePerResidueHydrophobicity, SBDColorSchemePerResidueSequenceNumber, SBDColorSchemePerResidueType, SBDColorSchemePerSecondaryStructureType, SBDColorSchemePerSideChainCharge, SBDColorSchemePerSideChainPolarity, and SBDColorSchemePerTemperatureFactor.

getColor()

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

virtual

Reimplemented in SBDColorSchemeConstant, SBDColorSchemeConstantIllustrate, SBDColorSchemeCPK, SBDColorSchemePerAttribute< Output >, SBDColorSchemePerAttribute< int >, SBDColorSchemePerAttribute< SBQuantity::dimensionless >, SBDColorSchemePerAttribute< float >, SBDColorSchemePerAttribute< double >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::ResidueType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SecondaryStructureType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainPolarity >, and SBDColorSchemePerChainIllustrate.

getDefaultPalette()

SBDPalette * SBDDataGraphNodeColorScheme::getDefaultPalette ( ) const

virtual

Reimplemented in SBDColorSchemePerAttribute< Output >, SBDColorSchemePerAttribute< int >, SBDColorSchemePerAttribute< SBQuantity::dimensionless >, SBDColorSchemePerAttribute< float >, SBDColorSchemePerAttribute< double >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::ResidueType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SecondaryStructureType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainPolarity >, SBDColorSchemePerChainID, SBDColorSchemePerChainIllustrate, SBDColorSchemePerFormalCharge, SBDColorSchemePerOccupancy, SBDColorSchemePerPartialCharge, SBDColorSchemePerResidueHydrophobicity, SBDColorSchemePerResidueSequenceNumber, SBDColorSchemePerResidueType, SBDColorSchemePerSecondaryStructureType, SBDColorSchemePerSideChainCharge, SBDColorSchemePerSideChainPolarity, and SBDColorSchemePerTemperatureFactor.

isSerializable()

bool SBDDataGraphNodeColorScheme::isSerializable ( ) const

virtual

Reimplemented in SBDColorSchemeConstant, SBDColorSchemeConstantIllustrate, SBDColorSchemeCPK, SBDColorSchemePerAttribute< Output >, SBDColorSchemePerAttribute< int >, SBDColorSchemePerAttribute< SBQuantity::dimensionless >, SBDColorSchemePerAttribute< float >, SBDColorSchemePerAttribute< double >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::ResidueType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SecondaryStructureType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainPolarity >, SBDColorSchemePerChainID, SBDColorSchemePerChainIllustrate, SBDColorSchemePerFormalCharge, SBDColorSchemePerOccupancy, SBDColorSchemePerPartialCharge, SBDColorSchemePerResidueHydrophobicity, SBDColorSchemePerResidueSequenceNumber, SBDColorSchemePerResidueType, SBDColorSchemePerSecondaryStructureType, SBDColorSchemePerSideChainCharge, SBDColorSchemePerSideChainPolarity, and SBDColorSchemePerTemperatureFactor.

serialize()

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

virtual

Reimplemented in SBDColorSchemeConstant, SBDColorSchemeConstantIllustrate, SBDColorSchemeCPK, SBDColorSchemePerAttribute< Output >, SBDColorSchemePerAttribute< int >, SBDColorSchemePerAttribute< SBQuantity::dimensionless >, SBDColorSchemePerAttribute< float >, SBDColorSchemePerAttribute< double >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::ResidueType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SecondaryStructureType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainPolarity >, SBDColorSchemePerChainID, SBDColorSchemePerChainIllustrate, SBDColorSchemePerFormalCharge, SBDColorSchemePerOccupancy, SBDColorSchemePerPartialCharge, SBDColorSchemePerResidueHydrophobicity, SBDColorSchemePerResidueSequenceNumber, SBDColorSchemePerResidueType, SBDColorSchemePerSecondaryStructureType, SBDColorSchemePerSideChainCharge, SBDColorSchemePerSideChainPolarity, and SBDColorSchemePerTemperatureFactor.

unserialize()

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

virtual

Reimplemented in SBDColorSchemeConstant, SBDColorSchemeConstantIllustrate, SBDColorSchemeCPK, SBDColorSchemePerAttribute< Output >, SBDColorSchemePerAttribute< int >, SBDColorSchemePerAttribute< SBQuantity::dimensionless >, SBDColorSchemePerAttribute< float >, SBDColorSchemePerAttribute< double >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::ResidueType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SecondaryStructureType >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >, SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainPolarity >, SBDColorSchemePerChainID, SBDColorSchemePerChainIllustrate, SBDColorSchemePerFormalCharge, SBDColorSchemePerOccupancy, SBDColorSchemePerPartialCharge, SBDColorSchemePerResidueHydrophobicity, SBDColorSchemePerResidueSequenceNumber, SBDColorSchemePerResidueType, SBDColorSchemePerSecondaryStructureType, SBDColorSchemePerSideChainCharge, SBDColorSchemePerSideChainPolarity, and SBDColorSchemePerTemperatureFactor.