Class SBDColorSchemePerSideChainPolarity#

ClassList > SBDColorSchemePerSideChainPolarity

This class describes a color scheme based on side chain polarity. More...

#include "SBDColorSchemePerSideChainPolarity.hpp"

Inherits the following classes: SBDColorSchemePerAttribute

Public Functions#

Type	Name
	SBDColorSchemePerSideChainPolarity () Constructs a color scheme.
	SBDColorSchemePerSideChainPolarity (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 A virtual function function for the serialization - should be implemented in the derived classes.
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	~SBDColorSchemePerSideChainPolarity () 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 a`position` .
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 a`position` .
SBDDataGraphNodeColorSchemeData *	getDataPointer ()
const SBDDataGraphNodeColorSchemeData *	getDataPointer () const
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 side chain polarity color scheme for residues.

Please refer to Color schemes for more information.

Short name: SBColorSchemePerSideChainPolarity

See also: Color schemes

Public Functions Documentation#

function SBDColorSchemePerSideChainPolarity [1/2]#

Constructs a color scheme.

SBDColorSchemePerSideChainPolarity::SBDColorSchemePerSideChainPolarity ()

function SBDColorSchemePerSideChainPolarity [2/2]#

Constructs a color scheme.

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

function clone#

Returns a copy of the color scheme.

virtual SBDDataGraphNodeColorScheme * SBDColorSchemePerSideChainPolarity::clone () override const

Implements SBDDataGraphNodeColorScheme::clone

function getDefaultPalette#

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

virtual SBDPalette * SBDColorSchemePerSideChainPolarity::getDefaultPalette () override const

Implements SBDColorSchemePerAttribute::getDefaultPalette

function isSerializable#

Returns true __

virtual bool SBDColorSchemePerSideChainPolarity::isSerializable () override const

Implements SBDColorSchemePerAttribute::isSerializable

function serialize#

A virtual function function for the serialization - should be implemented in the derived classes.

virtual void SBDColorSchemePerSideChainPolarity::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#

A virtual function function for the unserialization - should be implemented in the derived classes.

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

Implements SBDColorSchemePerAttribute::unserialize

function ~SBDColorSchemePerSideChainPolarity#

Destructs the color scheme.

virtual SBDColorSchemePerSideChainPolarity::~SBDColorSchemePerSideChainPolarity ()