DisplacementSettings

class cee.ug.DisplacementSettings()

Specification of how to render parts with the given displacement result.

With this object you can control the (absolute) scaling of displacements.

Accessors


Accessors

cee.ug.DisplacementSettings.resultId

The id (>=0) of the displacement result. This id must refer to one of the displacement results in ModelDirectory.displacementResultArray

cee.ug.DisplacementSettings.scaleFactor

The absolute scale factor to use for the displacement result. The default is 1.0 (no scaling).

Methods

getAsProperties

cee.ug.DisplacementSettings.getAsProperties()

Gets the settings for this displacement settings as a Plain Old JavaScript Object (POJO).

Return type

cee.ug.DisplacementSettingsProperties

setFromProperties

cee.ug.DisplacementSettings.setFromProperties(props)

Applies the settings in the given properties object to this displacement settings.

Arguments
  • props (Partial[cee.ug.DisplacementSettingsProperties]) –

Return type

void