Web Analytics Made Easy - Statcounter
Skip to content

Class SBDDataGraphNodeColorScheme#

ClassList > SBDDataGraphNodeColorScheme

This class describes a color scheme. More...

  • #include <SBDDataGraphNodeColorScheme.hpp>

Inherits the following classes: SBCReferenceTarget

Inherited by the following classes: SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemePerAttribute, SBDColorSchemeCPK, SBDColorSchemeCPKConstantCarbons, SBDColorSchemeConstant, SBDColorSchemePerAttribute

Public Functions#

Type Name
SBDDataGraphNodeColorScheme ()
Constructs a color scheme.
SB_DECLARE_DATA (SBDDataGraphNodeColorScheme)
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 aposition .
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 ()
unsigned int getMemoryFootprint () const
void printReferencesToOwners () const
virtual ~SBCReferenceTarget ()

Protected Attributes inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type Name
SBCReferenceTargetData * dataPointer

Protected Functions#

Type Name
SBDDataGraphNodeColorScheme (SBDDataGraphNodeColorSchemeData * dataPointer)

Protected Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type Name
SBCReferenceTarget (SBCReferenceTargetData * dataPointer)
void removeAllReferenceOwners ()

Detailed Description#

This class describes a color scheme in SAMSON. Please refer to Color schemes for more information.

Short name: SBNodeColorScheme

See also: Color schemes

Public Functions Documentation#

function SBDDataGraphNodeColorScheme [1/2]#

Constructs a color scheme. 

SBDDataGraphNodeColorScheme::SBDDataGraphNodeColorScheme ()

function SB_DECLARE_DATA#

SBDDataGraphNodeColorScheme::SB_DECLARE_DATA (
    SBDDataGraphNodeColorScheme
)

function canHavePalette#

Returns whether the color scheme requires and therefore can have a color palette. 

virtual bool SBDDataGraphNodeColorScheme::canHavePalette () const

function clone#

Returns a copy of the color scheme. 

virtual SBDDataGraphNodeColorScheme * SBDDataGraphNodeColorScheme::clone () const

function getColor#

Returns a color given a node and / or aposition . 

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

function getDefaultPalette#

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

virtual SBDPalette * SBDDataGraphNodeColorScheme::getDefaultPalette () const

function getPalette#

Returns a pointer to a color palette owned by the color scheme. 

const SBDPalette * SBDDataGraphNodeColorScheme::getPalette () const

function hasPalette#

Returns whether the color scheme has a color palette defined. 

bool SBDDataGraphNodeColorScheme::hasPalette () const

function isSerializable#

Returns true when the class is serializable. 

virtual bool SBDDataGraphNodeColorScheme::isSerializable () const

function requestUpdate#

Requests a material update for a node to which the material that owns this color scheme is applied. 

void SBDDataGraphNodeColorScheme::requestUpdate ()

function resetPalette#

Resets the color palette to the default one for color schemes that can have it. 

void SBDDataGraphNodeColorScheme::resetPalette ()

function serialize#

Serializes the color scheme. 

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

function setPalette#

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 SBDDataGraphNodeColorScheme::setPalette (
    SBDPalette * palette
)

function unserialize#

Unserializes the color scheme. 

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

function ~SBDDataGraphNodeColorScheme#

Destructs the color scheme. 

virtual SBDDataGraphNodeColorScheme::~SBDDataGraphNodeColorScheme ()

Protected Functions Documentation#

function SBDDataGraphNodeColorScheme [2/2]#

SBDDataGraphNodeColorScheme::SBDDataGraphNodeColorScheme (
    SBDDataGraphNodeColorSchemeData * dataPointer
)