PartSettings

class cee.geo.PartSettings()

PartSettings defines properties that control how the part is rendered and behaves.

Index

Accessors

• color
• eyeLift
• highlight
• intersectable
• lineWidth
• opacity
• polygonOffset
• specularIntensity
• texture
• visible

Accessors

cee.geo.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.geo.PartSettings.eyeLift()

get eyeLift(): EyeLift

The eye lift mode to use for this part

Returns: EyeLift

set eyeLift(mode: EyeLift): void

Parameters

mode: EyeLift

Returns: void

cee.geo.PartSettings.highlight()

get highlight(): boolean

Whether the part should be highlighted.

Returns: boolean

set highlight(highlight: boolean): void

Parameters

highlight: boolean

Returns: void

cee.geo.PartSettings.intersectable()

get intersectable(): boolean

Specifies if the part should be considered by picking (rayIntersect()) or not

Returns: boolean

set intersectable(intersectable: boolean): void

Parameters

intersectable: boolean

Returns: void

cee.geo.PartSettings.lineWidth()

get lineWidth(): number

The line width in pixels for line meshes

Note that setting the width to values greater than 1, will trigger generation and rendering of thick lines which can significantly reduce update and rendering performance.

Returns: number

set lineWidth(lineWidth: number): void

Parameters

lineWidth: number

Returns: void

cee.geo.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.geo.PartSettings.polygonOffset()

get polygonOffset(): PolygonOffset

The polygon offset mode to use for this part

Returns: PolygonOffset

set polygonOffset(mode: PolygonOffset): void

Parameters

mode: PolygonOffset

Returns: void

cee.geo.PartSettings.specularIntensity()

get specularIntensity(): number

The intensity of the specular highlight of the part

Note that the part’s default value for specularIntensity is undefined in which case the global default specular intensity will be used. Specify this value to override the default setting.

Returns: number

set specularIntensity(intensity: number): void

Parameters

intensity: number

Returns: void

cee.geo.PartSettings.texture()

get texture(): Texture

Texture to use for this part. If no texture is defined, null is returned.

Note that using textures requires that the mesh type is MeshIndexedTriangles and that you have specified texture coordinates in the mesh.

Returns: Texture

set texture(texture: Texture): void

Parameters

texture: Texture

Returns: void

cee.geo.PartSettings.visible()

get visible(): boolean

The visibility of the part

Returns: boolean

set visible(visible: boolean): void

Parameters

visible: boolean

Returns: void