PartSettings
- class cee.ug.PartSettings()
Specification of the visual appearance of a part in a RemoteModel
Use this object to control how the part will be rendered in the 3D viewer. You can set whether the part is
visible
thedrawStyle
color
opacity
and if the part should besmooth
or flat shaded. You can also setshowFringes
to specify if the part should show the current scalar result (if a scalar result is specified in theModelSpec
and setshowVectors
to specify if vector arrows should be drawn for the surface of this part (if a vector result is specified in theModelSpec
You can access PartSettings objects with
RemoteModel.getPartSettingsAt
Example: Show all parts as transparent
for (var i = 0; i < myModel.partCount; ++i) { var partSettings = myModel.getPartSettingsAt(i); partSettings.drawStyle = cee.ug.DrawStyle.SURFACE; partSettings.opacity = 0.5; }
or
for (var ps of myModel.getPartSettingsArray()) { ps.drawStyle = cee.ug.DrawStyle.SURFACE; ps.opacity = 0.5; }
Accessors
Methods
Accessors
- cee.ug.PartSettings.color
The color of the part.
- cee.ug.PartSettings.disableElementSetFiltering
Disables element set filtering for this part. See
ModelSpec.visibleSetIdArray
- cee.ug.PartSettings.disableFeatureExtraction
Disables feature extraction for this part. It will be excluded when computing e.g. isosurfaces.
- cee.ug.PartSettings.disableMirroring
Disable mirroring for this part.
If set to true, this part will not be included in the mirroring of the model.
- cee.ug.PartSettings.drawStyle
The specification of how to render the part (surface, lines, points, mesh, etc).
- cee.ug.PartSettings.eyeLift
The eye lift mode to use for this part.
Eye lift can be used when facing z fighting issues (triangles rendered in the same plane). By applying eye lift to one part, it will be moved slightly towards the eye, resolving the z fighting issues. The current version offers 3 eye lift factors to choose from.
- cee.ug.PartSettings.geometryIndex
The zero-based geometryIndex of the part. A RemoteModel might have more than one geometry, but in most cases there is only one. The combination of geometryIndex and partId uniquely identifies the part.
- cee.ug.PartSettings.highlight
Whether the part should be highlighted.
- cee.ug.PartSettings.opacity
The opacity of the part. 1.0 is fully opaque, 0.0 if fully transparent (invisible).
- cee.ug.PartSettings.partId
The id of the part. The id is >=0 and unique within the part’s geometry. The combination of geometryIndex and partId uniquely identifies the part.
- cee.ug.PartSettings.showFringes
Whether scalar fringes (filled contours) should be shown on this part. This flag only applies if the
ModelSpec.fringesResultId
is set to a valid scalar result id.
- cee.ug.PartSettings.showVectors
Whether vector arrows should be rendered on the surface of this part. This flag only applies if the
ModelSpec.vectorResultIdArray
is set to valid vector result id(s).
- cee.ug.PartSettings.smooth
Flag controlling the shading model of the part.
If true, smooth shading will be used for the part, where it is rendered with a smoothed out surface with a per pixel lighting. If false, a flat shading rendering will be applied where the surface of an element is rendered with the same color.
- cee.ug.PartSettings.visible
Visibility of the part. Use this to show or hide a part in the 3D Viewer.
Methods
getAsProperties
- cee.ug.PartSettings.getAsProperties()
Gets the settings for this part as a Plain Old JavaScript Object (POJO).
- Return type
cee.ug.PartSettingsProperties
setFromProperties
- cee.ug.PartSettings.setFromProperties(props)
Applies the settings in the given properties object to this part
- Arguments
props (
Partial[cee.ug.PartSettingsProperties]
) –
- Return type
void