cee::ug::VectorSettingsPropertyHandler Class Reference

Property handler for vector settings properties. More...

Public Types

enum  PropertyKey {
  CONTEXT_RESULT_ID, SCALE_MODE, SCALE_FACTOR, COLOR_MODE,
  SINGLE_COLOR, CLAMP_MIN_LENGTH, CLAMP_MAX_LENGTH, FILTER_MIN_LENGTH,
  FILTER_MAX_LENGTH, ARROW_SHAFT_RELATIVE_RADIUS, ARROW_HEAD_RELATIVE_RADIUS, ARROW_HEAD_RELATIVE_LENGTH,
  LOCAL_COORDINATES, SHOW_ON_REFERENCED_NODES_ONLY, SIMPLE_VECTOR_LINE_WIDTH, DRAW_MODE,
  DRAW_SKIPBY, DRAW_MAX_COUNT
}
 List of property keys for VectorSettingsPropertyHandler. More...
 

Public Member Functions

 VectorSettingsPropertyHandler (PropertySet *propSet)
 Creates a state selection 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
 Decodes the context from the properties. More...
 
void encodeContext (int resultId)
 Encodes the context as properties. More...
 
void applyToVectorSettings (VectorSettings *vectorSettings) const
 Applies the properties in this property set to the specified vector settings. More...
 
void buildProperties (const VectorSettings &vectorSettings)
 Sets the property keys and values for this property set from the vector 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 vector settings property set. More...
 

Detailed Description

Property handler for vector settings properties.

Member Enumeration Documentation

List of property keys for VectorSettingsPropertyHandler.

Enumerator
CONTEXT_RESULT_ID 

Context result id.

SCALE_MODE 

Scale mode.

SCALE_FACTOR 

Scale factor.

COLOR_MODE 

Color mode.

SINGLE_COLOR 

Single color.

CLAMP_MIN_LENGTH 

Clamping minimum length.

CLAMP_MAX_LENGTH 

Clamping maximum length.

FILTER_MIN_LENGTH 

Filtering minimum length.

FILTER_MAX_LENGTH 

Filtering maximum length.

ARROW_SHAFT_RELATIVE_RADIUS 

Arrow shaft, relative radius.

ARROW_HEAD_RELATIVE_RADIUS 

Arrow head, relative radius.

ARROW_HEAD_RELATIVE_LENGTH 

Arrow head, relative length.

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.

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.

SIMPLE_VECTOR_LINE_WIDTH 

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

DRAW_MODE 

Vector draw mode.

DRAW_SKIPBY 

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

DRAW_MAX_COUNT 

Maximum number of vector arrows do draw.

Constructor & Destructor Documentation

cee::ug::VectorSettingsPropertyHandler::VectorSettingsPropertyHandler ( PropertySet propSet)

Creates a state selection property handler from a given property set propSet.

Member Function Documentation

void cee::ug::VectorSettingsPropertyHandler::applyToVectorSettings ( VectorSettings vectorSettings) const

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

void cee::ug::VectorSettingsPropertyHandler::buildProperties ( const VectorSettings vectorSettings)

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

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

Decodes the context from the properties.

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

Encodes the context as properties.

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

Returns true if the specified property set is a valid vector settings property set.

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

Returns the class type of the property set.

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