Class SBDColorSchemePerStructuralModelIllustrate#

ClassList > SBDColorSchemePerStructuralModelIllustrate

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

#include <SBDColorSchemePerStructuralModelIllustrate.hpp>

Inherits the following classes: SBDColorSchemePerStructuralModel

Public Functions#

Type	Name
	SBDColorSchemePerStructuralModelIllustrate () Constructs a color scheme.
	SBDColorSchemePerStructuralModelIllustrate (const SBNodeIndexer & nodeIndexer, const SBDPalette * palette=nullptr) Constructs a color scheme.
virtual SBDDataGraphNodeColorScheme *	clone () override const Returns a copy of the color scheme.
virtual void	getColor (float * color, SBDDataGraphNode * node=nullptr, const SBPosition3 & position=SBPosition3::zero) override const Returns a color given a `node` and / or a`position` .
virtual SBDPalette *	getDefaultPalette () override const Returns a clone of the default color palette for this color scheme.
virtual bool	isSerializable () override const Returns `true` __
virtual void	serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const Serializes the document.
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 document.
virtual	~SBDColorSchemePerStructuralModelIllustrate () Destructs the color scheme.

Public Functions inherited from SBDColorSchemePerStructuralModel#

See SBDColorSchemePerStructuralModel

Type	Name
	SBDColorSchemePerStructuralModel () Constructs a color scheme.
	SBDColorSchemePerStructuralModel (const SBNodeIndexer & nodeIndexer, const SBDPalette * palette=nullptr) Constructs a color scheme.
virtual bool	canHavePalette () override const Returns whether the color scheme requires and therefore can have a color palette.
virtual SBDDataGraphNodeColorScheme *	clone () override const Returns a copy of the color scheme.
virtual void	getColor (float * color, SBDDataGraphNode * node=nullptr, const SBPosition3 & position=SBPosition3::zero) override const Returns a color given a `node` and / or a`position` .
virtual SBDPalette *	getDefaultPalette () override const Returns a clone of the default color palette for this color scheme.
virtual bool	isSerializable () override const Returns `true` __
virtual void	serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const Serializes the document.
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 document.
virtual	~SBDColorSchemePerStructuralModel () Destructs the color scheme.

Public Functions inherited from SBDDataGraphNodeColorScheme#

See SBDDataGraphNodeColorScheme

Type	Name
	SBDDataGraphNodeColorScheme () Constructs a color scheme.
virtual bool	canHavePalette () const Returns whether the color scheme requires and therefore can have a color palette.
virtual SBDDataGraphNodeColorScheme *	clone () const Returns a copy of the color scheme.
virtual void	getColor (float * color, SBDDataGraphNode * node=nullptr, const SBPosition3 & position=SBPosition3::zero) const Returns a color given a `node` and / or a`position` .
virtual SBDPalette *	getDefaultPalette () const Returns a clone of the default color palette for this color scheme.
const SBDPalette *	getPalette () const Returns a pointer to a color palette owned by the color scheme.
bool	hasPalette () const Returns whether the color scheme has a color palette defined.
virtual bool	isSerializable () const Returns `true` when the class is serializable.
void	requestUpdate () Requests a material update for a node to which the material that owns this color scheme is applied.
void	resetPalette () Resets the color palette to the default one for color schemes that can have it.
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.
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.
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.
virtual	~SBDDataGraphNodeColorScheme () Destructs the color scheme.

Public Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget () Builds the reference target.
unsigned int	getMemoryFootprint () const Returns the memory footprint.
void	printReferencesToOwners () const Prints the references to the owners of this reference target.
virtual	~SBCReferenceTarget () Destructor.

Protected Attributes inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer A pointer to the private data.

Protected Functions inherited from SBDDataGraphNodeColorScheme#

See SBDDataGraphNodeColorScheme

Type	Name
	SBDDataGraphNodeColorScheme (SBDDataGraphNodeColorSchemeData * dataPointer) Protected constructor.

Protected Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description#

Please refer to Color schemes for more information.

Short name: SBColorSchemePerStructuralModelIllustrate

See also: Color schemes

Public Functions Documentation#

function SBDColorSchemePerStructuralModelIllustrate [1/2]#

Constructs a color scheme.

SBDColorSchemePerStructuralModelIllustrate::SBDColorSchemePerStructuralModelIllustrate ()

Constructs a default SBDColorSchemePerStructuralModelIllustrate instance.

function SBDColorSchemePerStructuralModelIllustrate [2/2]#

Constructs a color scheme.

SBDColorSchemePerStructuralModelIllustrate::SBDColorSchemePerStructuralModelIllustrate (
    const SBNodeIndexer & nodeIndexer,
    const SBDPalette * palette=nullptr
)

Constructs a SBDColorSchemePerStructuralModelIllustrate with the given node indexer and optional palette.

Parameters:

nodeIndexer Indexer used to map nodes to the color scheme.
palette Optional palette to use for coloring; if null, the default palette is used.

function clone#

Returns a copy of the color scheme.

virtual SBDDataGraphNodeColorScheme * SBDColorSchemePerStructuralModelIllustrate::clone () override const

Creates a deep copy of this color scheme.

Returns:

Pointer to a new SBDColorSchemePerStructuralModelIllustrate instance that is a copy of this object.

Implements SBDColorSchemePerStructuralModel::clone

function getColor#

Returns a color given a node and / or aposition .

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

Computes the color for a given node and position.

Parameters:

color Output buffer (array of 4 floats) that receives the RGBA color values.
node Optional data graph node for which the color is computed; may be null.
position Optional 3D position associated with the node; defaults to zero.

The method determines the base color and applies any special handling, such as lightening for certain atom types.

Implements SBDColorSchemePerStructuralModel::getColor

function getDefaultPalette#

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

virtual SBDPalette * SBDColorSchemePerStructuralModelIllustrate::getDefaultPalette () override const

Retrieves the default palette for this color scheme.

Returns:

A cloned instance of the default palette.

Implements SBDColorSchemePerStructuralModel::getDefaultPalette

function isSerializable#

Returns true __

virtual bool SBDColorSchemePerStructuralModelIllustrate::isSerializable () override const

Indicates whether the color scheme supports serialization.

Returns:

True, as this color scheme can be serialized.

Implements SBDColorSchemePerStructuralModel::isSerializable

function serialize#

Serializes the document.

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

Serializes the color scheme to a serializer.

Parameters:

serializer Serializer object used to write the color scheme data.
nodeIndexer Indexer providing node mapping information for serialization.
sdkVersionNumber Version number of the SDK used during serialization.
classVersionNumber Version number of the class being serialized.

Implements SBDColorSchemePerStructuralModel::serialize

function unserialize#

Unserializes the document.

virtual void SBDColorSchemePerStructuralModelIllustrate::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 from a serializer.

Parameters:

serializer Serializer object used to read the color scheme data.
nodeIndexer Indexer providing node mapping information for deserialization.
sdkVersionNumber Version number of the SDK used during deserialization.
classVersionNumber Version number of the class being deserialized.

Implements SBDColorSchemePerStructuralModel::unserialize

function ~SBDColorSchemePerStructuralModelIllustrate#

Destructs the color scheme.

virtual SBDColorSchemePerStructuralModelIllustrate::~SBDColorSchemePerStructuralModelIllustrate ()

Destroys the SBDColorSchemePerStructuralModelIllustrate and releases any associated resources.