cee::ug::VectorSettingsPropertyHandler

class VectorSettingsPropertyHandler

Property handler for vector settings properties.

Public Types

enum PropertyKey

List of property keys for VectorSettingsPropertyHandler.

Values:

enumerator CONTEXT_RESULT_ID

Context result id.

enumerator SCALE_MODE

Scale mode.

enumerator SCALE_FACTOR

Scale factor.

enumerator COLOR_MODE

Color mode.

enumerator SINGLE_COLOR

Single color.

enumerator CLAMP_MIN_LENGTH

Clamping minimum length.

enumerator CLAMP_MAX_LENGTH

Clamping maximum length.

enumerator FILTER_MIN_LENGTH

Filtering minimum length.

enumerator FILTER_MAX_LENGTH

Filtering maximum length.

enumerator ARROW_SHAFT_RELATIVE_RADIUS

Arrow shaft, relative radius.

enumerator ARROW_HEAD_RELATIVE_RADIUS

Arrow head, relative radius.

enumerator ARROW_HEAD_RELATIVE_LENGTH

Arrow head, relative length.

enumerator LOCAL_COORDINATES

If true, the vectors are defined in local coordinates and will be transformed with the part.

If false, they are in world coordinates

enumerator SHOW_ON_REFERENCED_NODES_ONLY

If true, the vectors are only shown on the nodes referenced by the display model.

If false, all vectors are shown including interior ones

enumerator SIMPLE_VECTOR_LINE_WIDTH

Line width of vector arrows when draw mode is simple vectors (not 3D)

enumerator DRAW_MODE

Vector draw mode.

enumerator DRAW_SKIPBY

Number of arrows to skip between each arrow that is drawn.

enumerator DRAW_MAX_COUNT

Maximum number of vector arrows do draw.

enumerator VECTOR_TYPE

Vector visualization type (arrow, symmetric, reverse symmetric)

Public Functions

VectorSettingsPropertyHandler(PropertySet *propSet)

Creates a state selection 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.

bool decodeContext(int *resultId) const

Decodes the context from the properties.

void encodeContext(int resultId)

Encodes the context as properties.

void applyToVectorSettings(VectorSettings *vectorSettings) const

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

void buildProperties(const VectorSettings &vectorSettings)

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

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 vector settings property set.