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
Methods
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 model’s largest bounding box extent 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
Methods
getAsProperties
- DisplacementSettings.getAsProperties()
Gets the settings for this displacement settings as a Plain Old JavaScript Object (POJO).
- Return type:
DisplacementSettingsProperties