# cee::ug::CuttingPlanePropertyHandler

class `CuttingPlanePropertyHandler`

  Property handler for cutting plane properties.

  Public Types

  enum `PropertyKey`

    List of property keys for CuttingPlanePropertyHandler.

    Values:

    enumerator `VISIBLE`

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

    enumerator `POINT`

      Cutting plane defining point.

    enumerator `NORMAL`

      Cutting plane defining normal.

    enumerator `MAP_SCALAR_RESULT_ID`

      Id of mapped scalar result.

    enumerator `MAP_VECTOR_RESULT_ID`

      Id of mapped vector result.

    enumerator `MAP_CONTOUR_LINES_RESULT_ID`
    enumerator `VECTOR_GRID_SPACING_MODE`

      Grid spacing mode for mapped vector result.

    enumerator `VECTOR_GRID_SPACING`

      Grid spacing.

    enumerator `SURFACE_VISIBLE`

      Surface visibility.

    enumerator `SURFACE_COLOR`

      Surface color.

    enumerator `CLIP_MODEL`

      Model clipping.

    enumerator `COMPUTE_FROM_VISIBLE_PARTS`

      Compute cutting plane from visible parts only.

    enumerator `DRAW_STYLE`

      Cutting plane surface draw style.

    enumerator `OPACITY`

      Surface opacity.

    enumerator `SPECULAR_INTENSITY`

      Surface specular intensity.

    enumerator `USE_SOURCE_PART_COLOR`

      If true, part source color will be used.

    enumerator `GRID_LINES_VISIBLE`

      Grid lines visibility.

    enumerator `PROJECT_VECTORS_ON_PLANE`

      Project the vectors onto the cutting plane.

    enumerator `CRINKLE_CUT_SURFACE`

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

    enumerator `EYE_LIFT_FACTOR`

      Eye lift factor (to avoid z-fighting)

    enumerator `LIGHTING`

      Lighting.

    enumerator `FILTER_SCALAR_RESULT_ID`

      Id for scalar used for filtering.

    enumerator `FILTER_SCALAR_RANGE_MIN`

      Minimum value used for the scalar filtering.

    enumerator `FILTER_SCALAR_RANGE_MAX`

      Maximum value used for the scalar filtering.

  Public Functions

  `CuttingPlanePropertyHandler`(PropertySet *propSet)

    Creates a cutting plane 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 `applyToCuttingPlane`(ug::CuttingPlane *cuttingPlane) const

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

  void `buildProperties`(const ug::CuttingPlane &cuttingPlane)

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

  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 cutting plane property set.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...