PartSettings

class cee.usg.PartSettings()

Settings describing how to render a Part in a Geometry.

Accessors

cee.usg.PartSettings.color()
get color(): Color3Like

The color of the part. Note that the returned color cannot be modified.

Returns: Color3Like

set color(color: Color3Like): void

Parameters

color: Color3Like

Returns: void

cee.usg.PartSettings.displacementVisible()
get displacementVisible(): boolean

If true (default), displacements will be used (if present) for the part

Returns: boolean

set displacementVisible(visible: boolean): void

Parameters

visible: boolean

Returns: void

cee.usg.PartSettings.drawStyle()
get drawStyle(): DrawStyle

The specification of how to render the part

Returns: DrawStyle

set drawStyle(drawStyle: DrawStyle): void

Parameters

drawStyle: DrawStyle

Returns: void

cee.usg.PartSettings.fringesVisible()
get fringesVisible(): boolean

If true (default), scalar fringes will be shown on the part if present in the state. If false, no scalar will be shown even if the result is present.

Returns: boolean

set fringesVisible(visible: boolean): void

Parameters

visible: boolean

Returns: void

cee.usg.PartSettings.highlight()
get highlight(): boolean

Whether the part should be highlighted.

Returns: boolean

set highlight(highlight: boolean): void

Parameters

highlight: boolean

Returns: void

cee.usg.PartSettings.opacity()
get opacity(): number

The opacity of the part.

1.0 is fully opaque, 0.0 is fully transparent (invisible).

Returns: number

set opacity(opacity: number): void

Parameters

opacity: number

Returns: void

cee.usg.PartSettings.smooth()
get smooth(): boolean

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.

Note: Flat shading requires each element to have unique vertices, so it will be slower and use more memory (both normal and GPU).

Returns: boolean

set smooth(smooth: boolean): void

Parameters

smooth: boolean

Returns: void

cee.usg.PartSettings.vectorsVisible()
get vectorsVisible(): boolean

If true (default), vector results will be shown on the part if present in the state. If false, no vector result will be shown even if the result is present.

Returns: boolean

set vectorsVisible(visible: boolean): void

Parameters

visible: boolean

Returns: void

cee.usg.PartSettings.visible()
get visible(): boolean

The visibility of the part

Returns: boolean

set visible(visible: boolean): void

Parameters

visible: boolean

Returns: void