cee::ug::ColorMapperFilledContoursUniformPropertyHandler Class Reference

Property handler for colormapper filled contours properties. More...

Public Types

enum  PropertyKey {
  CONTEXT_RESULT_ID, RANGE_MIN, RANGE_MAX, COLOR_SCHEME,
  LOGARITHMIC_SCALE, NUM_COLORS, LEVEL_COLORS, ABOVE_RANGE_COLOR,
  BELOW_RANGE_COLOR, UNDEFINED_COLOR, UNDEFINED_OPACITY
}
 List of property keys for ColorMapperFilledContoursUniformPropertyHandler. More...
 

Public Member Functions

 ColorMapperFilledContoursUniformPropertyHandler (PropertySet *propSet)
 Creates a color mapper filled contour uniform property handler from a given property set propSet. More...
 
Variant propertyValue (PropertyKey key) const
 Returns the property value for the specified property key. More...
 
void setPropertyValue (PropertyKey key, Variant data)
 Sets the property key and value to this handlers property set. More...
 
bool decodeContext (int *resultId) const
 Decode the context from the properties. More...
 
void encodeContext (int resultId)
 Encode the context as properties. More...
 
void applyToScalarSettings (ScalarSettings *scalarSettings) const
 Applies the properties in this property set to the specified scalar settings. More...
 
void buildProperties (const ScalarSettings &scalarSettings)
 Sets the property keys and values for this property set from the scalar settings. More...
 

Static Public Member Functions

static Str propertySetClassType ()
 Returns the class type of the property set. More...
 
static bool isValidPropertySet (const PropertySet &propSet)
 Returns true if the specified property set is a valid color mapper filled contour uniform property set. More...
 

Detailed Description

Property handler for colormapper filled contours properties.

Member Enumeration Documentation

List of property keys for ColorMapperFilledContoursUniformPropertyHandler.

Enumerator
CONTEXT_RESULT_ID 

Context result id.

RANGE_MIN 

Minimum range value.

RANGE_MAX 

Maximum range value.

COLOR_SCHEME 

Color scheme.

LOGARITHMIC_SCALE 

Use logarithmic scale (true/false)

NUM_COLORS 

Number of colors.

LEVEL_COLORS 

Array of level colors.

ABOVE_RANGE_COLOR 

Above range color.

BELOW_RANGE_COLOR 

Below range color.

UNDEFINED_COLOR 

Undefined color.

UNDEFINED_OPACITY 

Undefined opacity.

Constructor & Destructor Documentation

cee::ug::ColorMapperFilledContoursUniformPropertyHandler::ColorMapperFilledContoursUniformPropertyHandler ( PropertySet propSet)

Creates a color mapper filled contour uniform property handler from a given property set propSet.

Member Function Documentation

void cee::ug::ColorMapperFilledContoursUniformPropertyHandler::applyToScalarSettings ( ScalarSettings scalarSettings) const

Applies the properties in this property set to the specified scalar settings.

void cee::ug::ColorMapperFilledContoursUniformPropertyHandler::buildProperties ( const ScalarSettings scalarSettings)

Sets the property keys and values for this property set from the scalar settings.

bool cee::ug::ColorMapperFilledContoursUniformPropertyHandler::decodeContext ( int *  resultId) const

Decode the context from the properties.

void cee::ug::ColorMapperFilledContoursUniformPropertyHandler::encodeContext ( int  resultId)

Encode the context as properties.

bool cee::ug::ColorMapperFilledContoursUniformPropertyHandler::isValidPropertySet ( const PropertySet propSet)
static

Returns true if the specified property set is a valid color mapper filled contour uniform property set.

Str cee::ug::ColorMapperFilledContoursUniformPropertyHandler::propertySetClassType ( )
static

Returns the class type of the property set.

cee::Variant cee::ug::ColorMapperFilledContoursUniformPropertyHandler::propertyValue ( PropertyKey  key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void cee::ug::ColorMapperFilledContoursUniformPropertyHandler::setPropertyValue ( PropertyKey  key,
Variant  data 
)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.