interface.RenderStateOutlines
API > RenderStateOutlines
Interface: RenderStateOutlines
Outline related render state.
Remarks
Enabling this feature will render the intersection of geometry surface with the specified plane as lines. This is particularly useful when in orthographic mode on surfaces that are perfectly perpendicular to the image plane. These surfaces would otherwise be invisible and unpickable.
Due to limitations of WebGL2, outline rendering comes as at potentially significant performance and memory cost. Thus, is may be unavailable on weaker devices and should be used sparingly otherwise.
Properties
breakingPointAngleThreshold
readonly
breakingPointAngleThreshold:number
Minimum angle to create breaking points from outlines in degrees
Source
@novorender/core3d/state/index.ts:770
enabled
readonly
enabled:boolean
Whether to do outline rendering.
Source
@novorender/core3d/state/index.ts:725
hidden
readonly
hidden:boolean
Hide outline on screen, it can still be used for measurement
Source
@novorender/core3d/state/index.ts:722
lineColor
readonly
lineColor:RGB
Color of outline lines.
Remarks
Due to tone mapping the color displayed on screen will a bit duller.
If you require bright colors, you may "overexpose" them, e.g. [10,0,0]
for bright red.
Source
@novorender/core3d/state/index.ts:757
linearThickness
readonly
linearThickness:number
Outline thickness, in meters.
Default
0.01
Source
@novorender/core3d/state/index.ts:730
maxPixelThickness
readonly
maxPixelThickness:number
Outline maximum thickness, in pixels.
Default
9
Source
@novorender/core3d/state/index.ts:740
minPixelThickness
readonly
minPixelThickness:number
Outline minimum thickness, in pixels.
Default
3
Source
@novorender/core3d/state/index.ts:735
planes
readonly
planes:ReadonlyVec4
[]
The outline intersection plane.
Source
@novorender/core3d/state/index.ts:767
relativePointSize
readonly
relativePointSize:number
Outline relative size between lines and points.
Default
2
Source
@novorender/core3d/state/index.ts:745
vertexColor
readonly
vertexColor:RGB
Color of outline vertices.
Remarks
Due to tone mapping the color displayed on screen will a bit duller.
If you require bright colors, you may "overexpose" them, e.g. [10,0,0]
for bright red.
Source
@novorender/core3d/state/index.ts:764
vertexObjectIdBase
readonly
vertexObjectIdBase:number
Outline vertex base object id value.
Default
0x7000_0000