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
scaleMode

Methods

getAsProperties
setFromProperties

Accessors

DisplacementSettings.resultId()

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

Return type:	number

DisplacementSettings.scaleFactor()

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.

Return type:	number

DisplacementSettings.scaleFactor(scaleFactor)

Arguments:	scaleFactor (`number`) – None
Return type:	void

DisplacementSettings.scaleMode()

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

Return type:	DisplacementScaleMode

DisplacementSettings.scaleMode(scaleMode)

Arguments:	scaleMode (`DisplacementScaleMode`) – None

<nbsp>

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