Options
All
  • Public
  • Public/Protected
  • All
Menu

This class is used to generate edges of the mesh that could then easily be rendered in a scene.

Hierarchy

Implements

Index

Constructors

  • Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh. Beware when you use this class with complex objects as the adjacencies computation can be really long

    Parameters

    • source: AbstractMesh

      Mesh used to create edges

    • Optional epsilon: number

      sum of angles in adjacency to check for edge

    • Optional checkVerticesInsteadOfIndices: boolean

      bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true

    • Optional generateEdgesLines: boolean

      should generate Lines or only prepare resources.

    • Optional options: IEdgesRendererOptions

      The options to apply when generating the edges

    Returns EdgesRenderer

Properties

customInstances: SmartArray<Matrix>

List of instances to render in case the source mesh has instances

edgesWidthScalerForOrthographic: number

Define the size of the edges with an orthographic camera

edgesWidthScalerForPerspective: number

Define the size of the edges with a perspective camera

isEnabled: boolean

Gets or sets a boolean indicating if the edgesRenderer is active

Accessors

  • Gets or sets the shader used to draw the lines

    Returns ShaderMaterial

  • Gets or sets the shader used to draw the lines

    Parameters

    Returns void

  • get linesIndices(): readonly number[]
  • Gets the indices generated by the edge renderer

    Returns readonly number[]

  • get linesNormals(): readonly number[]
  • Gets the normals generated by the edge renderer

    Returns readonly number[]

  • get linesPositions(): readonly number[]
  • Gets the vertices generated by the edge renderer

    Returns readonly number[]

Methods

  • dispose(): void
  • Releases the required resources for the edges renderer

    Returns void

  • isReady(): boolean
  • Checks whether or not the edges renderer is ready to render.

    Returns boolean

    true if ready, otherwise false.

  • render(): void
  • Renders the edges of the attached mesh,

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme