generateEdges

generateEdges: undefined | boolean

Controls whether edges are generated for surfaces. Edges are only displayed if ViewFlags.renderMode is not RenderMode.SmoothShade or ViewFlags.visibleEdges is true. Since all decoration graphics except GraphicType.Scene are drawn in smooth shaded mode with no visible edges, by default edges are only produced for scene graphics, and

• if a Viewport is supplied with the options - only if ViewFlags.edgesRequired is true for the viewport. That default can be overridden by explicitly specifying true or false. This can be useful for non-scene decorations contained in a GraphicBranch that applies ViewFlagOverrides that change the edge display settings; or for scene decorations that might be cached for reuse after the viewport's edge settings are changed.

note Edges will tend to z-fight with their surfaces unless the graphic is GraphicBuilderOptions.pickable.

Defined in

• core/frontend/src/render/GraphicBuilder.ts Line 160

Last Updated: 20 June, 2023