cee::ug::ParticleTraceGroupPropertyHandler Class Reference

Property handler for particle trace group properties. More...

Public Types

enum  PropertyKey {
  VISIBLE, SEED_POINTS, VECTOR_RESULT_ID, MAP_SCALAR_RESULT_ID,
  VISUALIZATION_STYLE, COLOR, RADIUS_SCALE_MODE, RADIUS_SCALE_FACTOR,
  POINT_SAMPLING_NUM_PULSES, COMET_LENGTH, RIBBON_RELATIVE_WIDTH, RIBBON_RELATIVE_THICKNESS,
  ARROW_LENGTH, IGNORE_CLIPPING
}
 List of property keys for ParticleTraceGroupPropertyHandler. More...
 

Public Member Functions

 ParticleTraceGroupPropertyHandler (PropertySet *propSet)
 Creates a particle trace group 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 applyToParticleTraceGroup (ug::ParticleTraceGroup *particleTraceGroup) const
 Applies the properties in this property set to the specified particle trace group. More...
 
void buildProperties (const ug::ParticleTraceGroup &particleTraceGroup)
 Sets the property keys and values for this property set from the particle trace group. 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 particle trace group property set. More...
 

Detailed Description

Property handler for particle trace group properties.

Member Enumeration Documentation

List of property keys for ParticleTraceGroupPropertyHandler.

Enumerator
VISIBLE 

Set if the traces in the group should be visible or not.

SEED_POINTS 

Array of seed point for particle traces in group.

VECTOR_RESULT_ID 

Id of vector result used to calculate particle trajectories.

MAP_SCALAR_RESULT_ID 

Id of scalar result mapped on primitives.

VISUALIZATION_STYLE 

Primitive visualization style (Ribbon, Comet, etc...)

COLOR 

Primitive color.

RADIUS_SCALE_MODE 

Primitive radius scale mode.

RADIUS_SCALE_FACTOR 

Primitive radius factor.

POINT_SAMPLING_NUM_PULSES 

Point sampling, number of pulses.

COMET_LENGTH 

Length of comet primitive.

RIBBON_RELATIVE_WIDTH 

Relative width of ribbon.

RIBBON_RELATIVE_THICKNESS 

Relative thickness of ribbon.

ARROW_LENGTH 

Length of arrow primitive.

IGNORE_CLIPPING 

Whether traces in the group should ignore clipping.

Constructor & Destructor Documentation

cee::ug::ParticleTraceGroupPropertyHandler::ParticleTraceGroupPropertyHandler ( PropertySet propSet)

Creates a particle trace group property handler from a given property set propSet.

Member Function Documentation

void cee::ug::ParticleTraceGroupPropertyHandler::applyToParticleTraceGroup ( ug::ParticleTraceGroup particleTraceGroup) const

Applies the properties in this property set to the specified particle trace group.

void cee::ug::ParticleTraceGroupPropertyHandler::buildProperties ( const ug::ParticleTraceGroup particleTraceGroup)

Sets the property keys and values for this property set from the particle trace group.

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

Returns true if the specified property set is a valid particle trace group property set.

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

Returns the class type of the property set.

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