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

• resultId

• scaleFactor

Methods

• getAsProperties

• setFromProperties

---

Accessors

cee.ug.resultId()

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

Return type:

number

cee.ug.scaleFactor()

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

Return type:

number

cee.ug.scaleFactor(scaleFactor)

Arguments:

• scaleFactor (number) – None

Return type:

void

Methods

getAsProperties

DisplacementSettings.getAsProperties()

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

Return type:

DisplacementSettingsProperties

setFromProperties

DisplacementSettings.setFromProperties(props)

Arguments:

• props (Partial) – None

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

Return type:

void