Web Analytics Made Easy - Statcounter
Skip to content

Class SBDColorSchemeConstant#

ClassList > SBDColorSchemeConstant

This class describes a constant color scheme. More...

  • #include <SBDColorSchemeConstant.hpp>

Inherits the following classes: SBDDataGraphNodeColorScheme

Inherited by the following classes: SBDColorSchemeConstantIllustrate

Public Functions#

Type Name
SBDColorSchemeConstant ()
Constructs a color scheme with the white color (1.0f, 1.0f, 1.0f, 1.0f)
SBDColorSchemeConstant (float red, float green, float blue, float alpha=1.0f)
Constructs a color scheme with the given color (red, green, blue, alpha)
SBDColorSchemeConstant (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
Constructs a color scheme with the given color (red, green, blue, alpha)
SBDColorSchemeConstant (float * color)
Constructs a color scheme with the given color (color[0], color[1], color[2], color[3])
SBDColorSchemeConstant (const SBColor & color)
Constructs a color scheme with the given color color .
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 aposition .
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 ~SBDColorSchemeConstant ()
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 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 ()
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: SBColorSchemeConstant

See also: Color schemes

Public Functions Documentation#

function SBDColorSchemeConstant [1/5]#

Constructs a color scheme with the white color (1.0f, 1.0f, 1.0f, 1.0f) 

SBDColorSchemeConstant::SBDColorSchemeConstant ()

Constructs a constant color scheme with the default white color.

This constructor initializes the color to white (1.0f, 1.0f, 1.0f, 1.0f).

function SBDColorSchemeConstant [2/5]#

Constructs a color scheme with the given color (red, green, blue, alpha) 

SBDColorSchemeConstant::SBDColorSchemeConstant (
    float red,
    float green,
    float blue,
    float alpha=1.0f
)

Constructs a constant color scheme with the specified RGBA components.

Parameters:

  • red Red component of the color in the range [0.0, 1.0].
  • green Green component of the color in the range [0.0, 1.0].
  • blue Blue component of the color in the range [0.0, 1.0].
  • alpha Alpha component of the color in the range [0.0, 1.0]. Defaults to 1.0.

function SBDColorSchemeConstant [3/5]#

Constructs a color scheme with the given color (red, green, blue, alpha) 

SBDColorSchemeConstant::SBDColorSchemeConstant (
    unsigned char red,
    unsigned char green,
    unsigned char blue,
    unsigned char alpha=255
)

Constructs a constant color scheme with the specified RGBA components as 8-bit values.

Parameters:

  • red Red component (0-255).
  • green Green component (0-255).
  • blue Blue component (0-255).
  • alpha Alpha component (0-255). Defaults to 255.

function SBDColorSchemeConstant [4/5]#

Constructs a color scheme with the given color (color[0], color[1], color[2], color[3]) 

SBDColorSchemeConstant::SBDColorSchemeConstant (
    float * color
)

Constructs a constant color scheme with the given color array.

Parameters:

  • color Pointer to an array of four floats representing RGBA components.

function SBDColorSchemeConstant [5/5]#

Constructs a color scheme with the given color color . 

SBDColorSchemeConstant::SBDColorSchemeConstant (
    const SBColor & color
)

Constructs a constant color scheme with the given SBColor object.

Parameters:

  • color The SBColor instance that defines the RGBA color.

function clone#

Returns a copy of the color scheme. 

virtual SBDDataGraphNodeColorScheme * SBDColorSchemeConstant::clone () override const

Creates a copy of this constant color scheme.

Returns:

A pointer to a new SBDDataGraphNodeColorScheme that is a copy of this scheme.

Implements SBDDataGraphNodeColorScheme::clone

function getColor#

Returns a color given a node and / or aposition . 

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

Retrieves the constant color.

Parameters:

  • color Output array to receive the RGBA components (must have space for four floats).
  • node Optional node parameter (unused in this implementation).
  • position Optional position parameter (unused in this implementation).

Implements SBDDataGraphNodeColorScheme::getColor

function isSerializable#

Returns true __ 

virtual bool SBDColorSchemeConstant::isSerializable () override const

Checks whether the color scheme can be serialized.

Returns:

true, indicating that this scheme supports serialization.

Implements SBDDataGraphNodeColorScheme::isSerializable

function serialize#

Serializes the document. 

virtual void SBDColorSchemeConstant::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 the provided serializer.

Parameters:

  • serializer The serializer used to write the color data.
  • nodeIndexer Indexer for node references (unused in this implementation).
  • sdkVersionNumber SDK version number (unused in this implementation).
  • classVersionNumber Class version number (unused in this implementation).

Implements SBDDataGraphNodeColorScheme::serialize

function unserialize#

Unserializes the document. 

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

Deserializes the color scheme from the provided serializer.

Parameters:

  • serializer The serializer used to read the color data.
  • nodeIndexer Indexer for node references (unused in this implementation).
  • sdkVersionNumber SDK version number (unused in this implementation).
  • classVersionNumber Class version number (unused in this implementation).

Implements SBDDataGraphNodeColorScheme::unserialize

function ~SBDColorSchemeConstant#

Destructs the color scheme. 

virtual SBDColorSchemeConstant::~SBDColorSchemeConstant ()

Destroys the constant color scheme.