# cee::ug::DisplacementSettings

class `DisplacementSettings` : public RefCountedObject

  Settings for a specific displacement result.

  A displacement result is a collection of displacement values. Displacement results are always node based. The displacement result has settings that can be configured to tailor the visual appearance of your result data.

  Each displacement result has its own settings. Get displacement settings for a specific displacement result by calling UnstructGridModel::displacementSettings() with the requested id.

      cee::ug::DisplacementSettings* settings = ugModel->displacementSettings(displacementId);

  See also

  UnstructGridModel

  Public Types

  enum `ScaleMode`

    Values:

    enumerator `ABSOLUTE_SCALING`
    enumerator `RELATIVE_SCALING`

  Public Functions

  ScaleMode `scaleMode`() const

    Returns current scale mode.

  double `scaleFactor`() const

    Returns scale factor.

    See also

    scaleMode() and setScaleFactor()

  void `setScaleFactor`(double scaleFactor, ScaleMode mode = ABSOLUTE_SCALING)

    Sets the scale factor to apply to displacements.

    If the scale mode is RELATIVE_SCALING, displacements will be scaled relative to model extent If mode is ABSOLUTE_SCALING the displacements will be scaled using scaleFactor regardless of model extent.

    Warning

    The specified scale factor must be greater that 0.

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