Web Analytics Made Easy - Statcounter
Skip to content

Class SBDColorSchemePerOccupancy#

ClassList > SBDColorSchemePerOccupancy

This class describes a color scheme based on atom's occupancy. More...

  • #include <SBDColorSchemePerOccupancy.hpp>

Inherits the following classes: SBDColorSchemePerAttribute

Public Functions#

Type Name
SBDColorSchemePerOccupancy ()
Constructs a color scheme.
SBDColorSchemePerOccupancy (const SBNodeIndexer & nodeIndexer, const SBDPalette * palette=nullptr)
Constructs a color scheme.
virtual SBDDataGraphNodeColorScheme * clone () override const
Returns a copy of the color scheme.
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 color scheme to the given serializer.
virtual void 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 given serializer.
virtual ~SBDColorSchemePerOccupancy ()
Destructs the color scheme.

Public Functions inherited from SBDColorSchemePerAttribute#

See SBDColorSchemePerAttribute

Type Name
SBDColorSchemePerAttribute ()
Default constructor.
SBDColorSchemePerAttribute (const SBNodeIndexer & nodeIndexer, const SBDDataGraphNodePredicate & nodePredicate, const SBDDataGraphNodeGetter< Output > & nodeGetter)
Constructs a color scheme based on node attributes.
virtual bool canHavePalette () override const
Returns whether the color scheme requires and therefore can have a color palette.
virtual void getColor (float * color, SBDDataGraphNode * node=nullptr, const SBPosition3 & position=SBPosition3::zero) override const
Returns a color given a node and / or aposition .
Output getDefaultMaximumValue () const
Returns the default maximum value for the attribute bounds used for colorization. It is computed during the color scheme construction based on the given node indexer and predicates.
Output getDefaultMinimumValue () const
Returns the default minimum value for the attribute bounds used for colorization. It is computed during the color scheme construction based on the given node indexer and predicates.
virtual SBDPalette * getDefaultPalette () override const
Returns a clone of the default color palette for this color scheme.
Output getMaximumValue () const
Returns the maximum value for the attribute bounds used for colorization.
Output getMinimumValue () const
Returns the minimum value for the attribute bounds used for colorization.
virtual bool isSerializable () override const
Returns false - this base class is not serializable and the serialization should be implemented in the derived classes.
virtual void serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const
A virtual function function for the serialization - should be implemented in the derived classes.
void setMaximumValue (Output value)
Sets the maximum value for the attribute bounds used for colorization.
void setMinimumValue (Output value)
Sets the minimum value for the attribute bounds used for colorization.
virtual void unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override
A virtual function function for the unserialization - should be implemented in the derived classes.
virtual ~SBDColorSchemePerAttribute ()
Destructor.

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 SBDColorSchemePerAttribute#

See SBDColorSchemePerAttribute

Type Name
Output * defaultMaxValue
The default maximum value for the attribute bounds determined when constructing the color scheme based on the input node indexer.
Output * defaultMinValue
The default minimum value for the attribute bounds determined when constructing the color scheme based on the input node indexer.
Output * maxValue
The current maximum value for the attribute bounds used for colorization.
Output * minValue
The current minimum value for the attribute bounds used for colorization.
SBDDataGraphNodeGetter< Output > * nodeGetter
The node getter.
SBNodeIndexer nodeIndexer
The node indexer.
SBDDataGraphNodePredicate * nodePredicate
The node predicate.

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#

This class describes a per occupancy color scheme.

Please refer to Color schemes for more information.

Short name: SBColorSchemePerOccupancy

See also: Color schemes

Public Functions Documentation#

function SBDColorSchemePerOccupancy [1/2]#

Constructs a color scheme. 

SBDColorSchemePerOccupancy::SBDColorSchemePerOccupancy ()

Constructs a per-occupancy color scheme with default range and palette.

Initializes the minimum and maximum occupancy values to 0.0 and 1.0, respectively, and sets the color palette to the default palette for this scheme.

function SBDColorSchemePerOccupancy [2/2]#

Constructs a color scheme. 

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

Constructs a per-occupancy color scheme for a given node indexer and optional palette.

Initializes the color scheme with the specified node indexer. If a palette is provided, it is used as the color palette; otherwise, the default palette is assigned.

Parameters:

  • nodeIndexer The indexer used to identify nodes for which the color scheme is applied.
  • palette Optional pointer to a palette to be used. If nullptr, the default palette is used.

function clone#

Returns a copy of the color scheme. 

virtual SBDDataGraphNodeColorScheme * SBDColorSchemePerOccupancy::clone () override const

Creates a copy of this color scheme.

Returns a new instance that is a clone of the current per-occupancy color scheme, including its range and palette settings.

Returns:

A pointer to the newly created copy of the color scheme.

Implements SBDDataGraphNodeColorScheme::clone

function getDefaultPalette#

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

virtual SBDPalette * SBDColorSchemePerOccupancy::getDefaultPalette () override const

Retrieves the default palette for this color scheme.

Returns a clone of the standard diverging HCL blue-to-red palette used as the default for per-occupancy color schemes.

Returns:

A pointer to a newly cloned default palette.

Implements SBDColorSchemePerAttribute::getDefaultPalette

function isSerializable#

Returns true __ 

virtual bool SBDColorSchemePerOccupancy::isSerializable () override const

Indicates whether the color scheme supports serialization.

This method always returns true for per-occupancy color schemes.

Returns:

true, indicating that the object can be serialized.

Implements SBDColorSchemePerAttribute::isSerializable

function serialize#

Serializes the color scheme to the given serializer. 

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

Writes the color palette (if any) and the minimum and maximum occupancy values to the provided serializer, using the specified SDK and class version numbers.

Parameters:

  • serializer The serializer object used to write the data.
  • nodeIndexer The node indexer associated with the color scheme.
  • sdkVersionNumber The version number of the SDK for compatibility checks.
  • classVersionNumber The version number of this class for compatibility checks.

Implements SBDColorSchemePerAttribute::serialize

function unserialize#

Deserializes the color scheme from the given serializer. 

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

Restores the color palette (if serialized) and the minimum and maximum occupancy values from the provided serializer, using the specified SDK and class version numbers.

Parameters:

  • serializer The serializer object used to read the data.
  • nodeIndexer The node indexer associated with the color scheme.
  • sdkVersionNumber The version number of the SDK for compatibility checks.
  • classVersionNumber The version number of this class for compatibility checks.

Implements SBDColorSchemePerAttribute::unserialize

function ~SBDColorSchemePerOccupancy#

Destructs the color scheme. 

virtual SBDColorSchemePerOccupancy::~SBDColorSchemePerOccupancy ()

Destructs the per-occupancy color scheme.