cee::ug::CuttingPlanePropertyHandler Class Reference

Property handler for cutting plane properties. More...

Public Types

enum  PropertyKey {
  VISIBLE, POINT, NORMAL, MAP_SCALAR_RESULT_ID,
  MAP_VECTOR_RESULT_ID, VECTOR_GRID_SPACING_MODE, VECTOR_GRID_SPACING, SURFACE_VISIBLE,
  SURFACE_COLOR, CLIP_MODEL, COMPUTE_FROM_VISIBLE_PARTS, DRAW_STYLE,
  OPACITY, SPECULAR_INTENSITY, USE_SOURCE_PART_COLOR, GRID_LINES_VISIBLE,
  PROJECT_VECTORS_ON_PLANE, CRINKLE_CUT_SURFACE
}
 List of property keys for CuttingPlanePropertyHandler. More...
 

Public Member Functions

 CuttingPlanePropertyHandler (PropertySet *propSet)
 Creates a cutting plane 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 applyToCuttingPlane (ug::CuttingPlane *cuttingPlane) const
 Applies the properties in this property set to the specified cutting plane. More...
 
void buildProperties (const ug::CuttingPlane &cuttingPlane)
 Sets the property keys and values for this property set from the cutting plane. 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 cutting plane property set. More...
 

Detailed Description

Property handler for cutting plane properties.

Member Enumeration Documentation

List of property keys for CuttingPlanePropertyHandler.

Enumerator
VISIBLE 

Set if the cutting plane and its features (vectors, grid, etc) should be visible or not.

POINT 

Cutting plane defining point.

NORMAL 

Cutting plane defining normal.

MAP_SCALAR_RESULT_ID 

Id of mapped scalar result.

MAP_VECTOR_RESULT_ID 

Id of mapped vector result.

VECTOR_GRID_SPACING_MODE 

Grid spacing mode for mapped vector result.

VECTOR_GRID_SPACING 

Grid spacing.

SURFACE_VISIBLE 

Surface visibility.

SURFACE_COLOR 

Surface color.

CLIP_MODEL 

Model clipping.

COMPUTE_FROM_VISIBLE_PARTS 

Compute cutting plane from visible parts only.

DRAW_STYLE 

Cutting plane surface draw style.

OPACITY 

Surface opacity.

SPECULAR_INTENSITY 

Surface specular intensity.

USE_SOURCE_PART_COLOR 

If true, part source color will be used.

GRID_LINES_VISIBLE 

Grid lines visibility.

PROJECT_VECTORS_ON_PLANE 

Project the vectors onto the cutting plane.

CRINKLE_CUT_SURFACE 

If true, the surface will be shown as a crinkle cut and not a flat surface.

Constructor & Destructor Documentation

cee::ug::CuttingPlanePropertyHandler::CuttingPlanePropertyHandler ( PropertySet propSet)

Creates a cutting plane property handler from a given property set propSet.

Member Function Documentation

void cee::ug::CuttingPlanePropertyHandler::applyToCuttingPlane ( ug::CuttingPlane cuttingPlane) const

Applies the properties in this property set to the specified cutting plane.

void cee::ug::CuttingPlanePropertyHandler::buildProperties ( const ug::CuttingPlane cuttingPlane)

Sets the property keys and values for this property set from the cutting plane.

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

Returns true if the specified property set is a valid cutting plane property set.

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

Returns the class type of the property set.

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