Loading...
Searching...
No Matches
SBDColorSchemeConstantIllustrate Class Reference

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

Constructors and destructors

 SBDColorSchemeConstantIllustrate ()
 Constructs a color (1.0f, 1.0f, 1.0f, 1.0f)
 
 SBDColorSchemeConstantIllustrate (float red, float green, float blue, float alpha=1.0f)
 Constructs a color (red, green, blue, alpha)
 
 SBDColorSchemeConstantIllustrate (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
 Constructs a color (red, green, blue, alpha)
 
 SBDColorSchemeConstantIllustrate (float *color)
 Constructs a color (color[0], color[1], color[2], color[3])
 
 SBDColorSchemeConstantIllustrate (const SBColor &color)
 Constructs a color (color[0], color[1], color[2], color[3])
 
virtual ~SBDColorSchemeConstantIllustrate ()
 Destructs the color.
 

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 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.
 

Clone function

virtual SBDDataGraphNodeColorSchemeclone () 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.
 

Additional Inherited Members

- Public Member Functions inherited from SBDColorSchemeConstant
 SBDColorSchemeConstant ()
 Constructs a color (1.0f, 1.0f, 1.0f, 1.0f)
 
 SBDColorSchemeConstant (float red, float green, float blue, float alpha=1.0f)
 Constructs a color (red, green, blue, alpha)
 
 SBDColorSchemeConstant (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
 Constructs a color (red, green, blue, alpha)
 
 SBDColorSchemeConstant (float *color)
 Constructs a color (color[0], color[1], color[2], color[3])
 
 SBDColorSchemeConstant (const SBColor &color)
 Constructs a color (color[0], color[1], color[2], color[3])
 
virtual ~SBDColorSchemeConstant ()
 Destructs the color.
 
 SB_DECLARE_DATA (SBDColorSchemeConstant)
 
- Public Member Functions inherited from SBDDataGraphNodeColorScheme
 SBDDataGraphNodeColorScheme ()
 Constructs a color scheme.
 
virtual ~SBDDataGraphNodeColorScheme ()
 Destructs the color scheme.
 
virtual bool canHavePalette () const
 Returns whether the color scheme requires and therefore can have a color palette.
 
virtual SBDPalettegetDefaultPalette () 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 SBDPalettegetPalette () 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 SBCReferenceTarget
SBCReferenceTargetData * dataPointer
 

Detailed Description

This class describes an illustrative constant 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 * SBDColorSchemeConstantIllustrate::clone ( ) const
overridevirtual

Reimplemented from SBDColorSchemeConstant.

◆ getColor()

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

Reimplemented from SBDColorSchemeConstant.

◆ isSerializable()

bool SBDColorSchemeConstantIllustrate::isSerializable ( ) const
overridevirtual

Reimplemented from SBDColorSchemeConstant.

◆ serialize()

void SBDColorSchemeConstantIllustrate::serialize ( SBCSerializer serializer,
const SBNodeIndexer nodeIndexer,
const SBVersionNumber sdkVersionNumber = SB_SDK_VERSION_NUMBER,
const SBVersionNumber classVersionNumber = SBVersionNumber(1, 0, 0) 
) const
overridevirtual

Reimplemented from SBDColorSchemeConstant.

◆ unserialize()

void SBDColorSchemeConstantIllustrate::unserialize ( SBCSerializer serializer,
const SBNodeIndexer nodeIndexer,
const SBVersionNumber sdkVersionNumber = SB_SDK_VERSION_NUMBER,
const SBVersionNumber classVersionNumber = SBVersionNumber(1, 0, 0) 
)
overridevirtual

Reimplemented from SBDColorSchemeConstant.