cee::ug::IsovolumePropertyHandler Class Reference

Property handler for isovolume properties. More...

Public Types

enum  PropertyKey {
  VISIBLE, MINIMUM_ISO_VALUE, MAXIMUM_ISO_VALUE, ISO_SCALAR_RESULT_ID,
  MAP_SCALAR_RESULT_ID, MAP_VECTOR_RESULT_ID, VOLUME_VISIBLE, VOLUME_COLOR,
  COMPUTE_FROM_VISIBLE_PARTS, DRAW_STYLE, OPACITY, SPECULAR_INTENSITY,
  TEXTURE_IMAGE_NAME, TEXTURE_ENVIRONMENT_MAPPING
}
 List of property keys for IsovolumePropertyHandler. More...
 

Public Member Functions

 IsovolumePropertyHandler (PropertySet *propSet, ImageResources *imageResources)
 Creates an isovolume 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...
 
void applyToIsovolume (ug::Isovolume *isovolume) const
 Applies the properties in this property set to the specified isovolume. More...
 
void buildProperties (const ug::Isovolume &isovolume)
 Sets the property keys and values for this property set from the isovolume. 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 isovolume property set. More...
 

Detailed Description

Property handler for isovolume properties.

Member Enumeration Documentation

List of property keys for IsovolumePropertyHandler.

Enumerator
VISIBLE 

Set if the isovolume and its features (vectors) should be visible or not.

MINIMUM_ISO_VALUE 

Minimum iso value for calculating isovolume.

MAXIMUM_ISO_VALUE 

Maximum iso value for calculating isovolume.

ISO_SCALAR_RESULT_ID 

Id of scalar result used for isovolume calculation.

MAP_SCALAR_RESULT_ID 

Id of mapped scalar result.

MAP_VECTOR_RESULT_ID 

Id of mapped vector result.

VOLUME_VISIBLE 

Isovolume visibility.

VOLUME_COLOR 

Isovolume color.

COMPUTE_FROM_VISIBLE_PARTS 

Compute isovolume from visible parts only.

DRAW_STYLE 

Isovolume draw style.

OPACITY 

Isovolume opacity.

SPECULAR_INTENSITY 

Isovolume specular intensity.

TEXTURE_IMAGE_NAME 

Texture image name.

TEXTURE_ENVIRONMENT_MAPPING 

Texture environment mapping.

Constructor & Destructor Documentation

cee::ug::IsovolumePropertyHandler::IsovolumePropertyHandler ( PropertySet propSet,
ImageResources imageResources 
)

Creates an isovolume property handler from a given property set propSet.

Member Function Documentation

void cee::ug::IsovolumePropertyHandler::applyToIsovolume ( ug::Isovolume isovolume) const

Applies the properties in this property set to the specified isovolume.

void cee::ug::IsovolumePropertyHandler::buildProperties ( const ug::Isovolume isovolume)

Sets the property keys and values for this property set from the isovolume.

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

Returns true if the specified property set is a valid isovolume property set.

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

Returns the class type of the property set.

cee::Variant cee::ug::IsovolumePropertyHandler::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::IsovolumePropertyHandler::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.