cee::ug::ParticleTraceGroupPropertyHandler

class ParticleTraceGroupPropertyHandler

Property handler for particle trace group properties.

Public Types

enum PropertyKey

List of property keys for ParticleTraceGroupPropertyHandler.

Values:

enumerator VISIBLE

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

enumerator SEED_POINTS

Array of seed point for particle traces in group.

enumerator VECTOR_RESULT_ID

Id of vector result used to calculate particle trajectories.

enumerator MAP_SCALAR_RESULT_ID

Id of scalar result mapped on primitives.

enumerator VISUALIZATION_STYLE

Primitive visualization style (Ribbon, Comet, etc…)

enumerator COLOR

Primitive color.

enumerator RADIUS_SCALE_MODE

Primitive radius scale mode.

enumerator RADIUS_SCALE_FACTOR

Primitive radius factor.

enumerator POINT_SAMPLING_NUM_PULSES

Point sampling, number of pulses.

enumerator COMET_LENGTH

Length of comet primitive.

enumerator RIBBON_RELATIVE_WIDTH

Relative width of ribbon.

enumerator RIBBON_RELATIVE_THICKNESS

Relative thickness of ribbon.

enumerator ARROW_LENGTH

Length of arrow primitive.

enumerator IGNORE_CLIPPING

Whether traces in the group should ignore clipping.

Public Functions

ParticleTraceGroupPropertyHandler(PropertySet *propSet)

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

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

void applyToParticleTraceGroup(ug::ParticleTraceGroup *particleTraceGroup) const

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

void buildProperties(const ug::ParticleTraceGroup &particleTraceGroup)

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

Public Static Functions

static Str propertySetClassType()

Returns the class type of the property set.

static bool isValidPropertySet(const PropertySet &propSet)

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