Loading...
Searching...
No Matches
SBDColorSchemePerSideChainCharge Class Reference

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

Constructors and destructors

 SBDColorSchemePerSideChainCharge ()
 
 SBDColorSchemePerSideChainCharge (const SBNodeIndexer &nodeIndexer, const SBDPalette *palette=nullptr)
 
virtual ~SBDColorSchemePerSideChainCharge ()
 

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

Clone function

virtual SBDDataGraphNodeColorSchemeclone () const override
 Returns a copy of the color scheme.
 

Default color palette

virtual SBDPalettegetDefaultPalette () const override
 Returns a clone of the default color palette for this color scheme.
 

Additional Inherited Members

- Public Member Functions inherited from SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >
SBMStructuralModelNodeResidue::SideChainCharge getMinimumValue () const
 
SBMStructuralModelNodeResidue::SideChainCharge getMaximumValue () const
 
SBMStructuralModelNodeResidue::SideChainCharge getDefaultMinimumValue () const
 
SBMStructuralModelNodeResidue::SideChainCharge getDefaultMaximumValue () const
 
void setMinimumValue (SBMStructuralModelNodeResidue::SideChainCharge value)
 
void setMaximumValue (SBMStructuralModelNodeResidue::SideChainCharge value)
 
 SBDColorSchemePerAttribute ()
 
 SBDColorSchemePerAttribute (const SBNodeIndexer &nodeIndexer, const SBDDataGraphNodePredicate &nodePredicate, const SBDDataGraphNodeGetter< SBMStructuralModelNodeResidue::SideChainCharge > &nodeGetter)
 
virtual ~SBDColorSchemePerAttribute ()
 
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.
 
virtual bool canHavePalette () const override
 Returns whether the color scheme requires and therefore can have a color palette.
 
- Public Member Functions inherited from SBDDataGraphNodeColorScheme
 SBDDataGraphNodeColorScheme ()
 Constructs a color scheme.
 
virtual ~SBDDataGraphNodeColorScheme ()
 Destructs the 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 SBDColorSchemePerAttribute< SBMStructuralModelNodeResidue::SideChainCharge >
SBMStructuralModelNodeResidue::SideChainChargeminValue
 The current minimum value for the attribute bounds used for colorization.
 
SBMStructuralModelNodeResidue::SideChainChargemaxValue
 The current maximum value for the attribute bounds used for colorization.
 
SBMStructuralModelNodeResidue::SideChainChargedefaultMinValue
 The default minimum value for the attribute bounds determined when constructing the color scheme based on the input node indexer.
 
SBMStructuralModelNodeResidue::SideChainChargedefaultMaxValue
 The default maximum value for the attribute bounds determined when constructing the color scheme based on the input node indexer.
 
SBNodeIndexer nodeIndexer
 
SBDDataGraphNodePredicatenodePredicate
 
SBDDataGraphNodeGetter< SBMStructuralModelNodeResidue::SideChainCharge > * nodeGetter
 
- Protected Attributes inherited from SBCReferenceTarget
SBCReferenceTargetData * dataPointer
 

Detailed Description

This class describes a per side chain charge color scheme for residues. Please refer to this page for more information.

See also
Color schemes

Member Function Documentation

◆ clone()

SBDDataGraphNodeColorScheme * SBDColorSchemePerSideChainCharge::clone ( ) const
overridevirtual

Reimplemented from SBDDataGraphNodeColorScheme.

◆ getDefaultPalette()

SBPalette * SBDColorSchemePerSideChainCharge::getDefaultPalette ( ) const
overridevirtual

◆ isSerializable()

bool SBDColorSchemePerSideChainCharge::isSerializable ( ) const
overridevirtual

◆ serialize()

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

◆ unserialize()

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