Class SBDColorSchemePerTemperatureFactor#
ClassList > SBDColorSchemePerTemperatureFactor
This class describes a color scheme based on atom's temperature factor. More...
#include <SBDColorSchemePerTemperatureFactor.hpp>
Inherits the following classes: SBDColorSchemePerAttribute
Public Functions#
Type | Name |
---|---|
SBDColorSchemePerTemperatureFactor () |
|
SBDColorSchemePerTemperatureFactor (const SBNodeIndexer & nodeIndexer, const SBDPalette * palette=nullptr) |
|
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. |
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 color scheme. |
virtual | ~SBDColorSchemePerTemperatureFactor () |
Public Functions inherited from SBDColorSchemePerAttribute#
See SBDColorSchemePerAttribute
Type | Name |
---|---|
SBDColorSchemePerAttribute () |
|
SBDColorSchemePerAttribute (const SBNodeIndexer & nodeIndexer, const SBDDataGraphNodePredicate & nodePredicate, const SBDDataGraphNodeGetter< Output > & nodeGetter) |
|
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 |
Output | getDefaultMinimumValue () const |
virtual SBDPalette * | getDefaultPalette () override const Returns a clone of the default color palette for this color scheme. |
Output | getMaximumValue () const |
Output | getMinimumValue () const |
virtual bool | isSerializable () override const Returns true when the class is serializable. |
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. |
void | setMaximumValue (Output value) |
void | setMinimumValue (Output value) |
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 color scheme. |
virtual | ~SBDColorSchemePerAttribute () |
Public Functions inherited from SBDDataGraphNodeColorScheme#
See SBDDataGraphNodeColorScheme
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#
Type | Name |
---|---|
SBCReferenceTarget () |
|
unsigned int | getMemoryFootprint () const |
void | printReferencesToOwners () const |
virtual | ~SBCReferenceTarget () |
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 |
SBNodeIndexer | nodeIndexer |
SBDDataGraphNodePredicate * | nodePredicate |
Protected Attributes inherited from SBCReferenceTarget#
Type | Name |
---|---|
SBCReferenceTargetData * | dataPointer |
Protected Functions inherited from SBDDataGraphNodeColorScheme#
See SBDDataGraphNodeColorScheme
Type | Name |
---|---|
SBDDataGraphNodeColorScheme (SBDDataGraphNodeColorSchemeData * dataPointer) |
Protected Functions inherited from SBCReferenceTarget#
Type | Name |
---|---|
SBCReferenceTarget (SBCReferenceTargetData * dataPointer) |
|
void | removeAllReferenceOwners () |
Detailed Description#
This class describes a per temperature color scheme. Please refer to Color schemes for more information.
Short name: SBColorSchemePerTemperatureFactor
See also: Color schemes
Public Functions Documentation#
function SBDColorSchemePerTemperatureFactor [1/2]#
function SBDColorSchemePerTemperatureFactor [2/2]#
SBDColorSchemePerTemperatureFactor::SBDColorSchemePerTemperatureFactor (
const SBNodeIndexer & nodeIndexer,
const SBDPalette * palette=nullptr
)
function clone#
Returns a copy of the color scheme.
Implements SBDDataGraphNodeColorScheme::clone
function getDefaultPalette#
Returns a clone of the default color palette for this color scheme.
Implements SBDColorSchemePerAttribute::getDefaultPalette
function isSerializable#
Returns true.
Implements SBDColorSchemePerAttribute::isSerializable
function serialize#
Serializes the color scheme.
virtual void SBDColorSchemePerTemperatureFactor::serialize (
SBCSerializer * serializer,
const SBNodeIndexer & nodeIndexer,
const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override const
Implements SBDColorSchemePerAttribute::serialize
function unserialize#
Unserializes the color scheme.
virtual void SBDColorSchemePerTemperatureFactor::unserialize (
SBCSerializer * serializer,
const SBNodeIndexer & nodeIndexer,
const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override
Implements SBDColorSchemePerAttribute::unserialize