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

cee.ug.DisplacementSettings.resultId()
get resultId(): number

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

Returns: number

cee.ug.DisplacementSettings.scaleFactor()
get scaleFactor(): number

The scale factor to use for the displacement result.

The behavior depends on the chosen scaleMode. For absolute displacements, they will be simply multiplied by this factor.

For relative displacements, this will scale them in a way that the largest displacement will have its length equal to the length of the model bounding box’s diagonal multiplied by this factor. Typical usable values for relative displacements are in the range 0 to 0.5.

Returns: number

set scaleFactor(scaleFactor: number): void

Parameters

scaleFactor: number

Returns: void

cee.ug.DisplacementSettings.scaleMode()
get scaleMode(): DisplacementScaleMode

The scaling mode to use for displacement results (absolute or relative). The default is absolute.

Returns: DisplacementScaleMode

set scaleMode(scaleMode: DisplacementScaleMode): void

<nbsp>

Parameters

Returns: void

Methods

cee.ug.DisplacementSettings.getAsProperties()
getAsProperties(): DisplacementSettingsProperties

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

Returns: DisplacementSettingsProperties

cee.ug.DisplacementSettings.setFromProperties()
setFromProperties(props: Partial): void

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

Parameters

props: Partial

Returns: void