Class LineMesh

Hierarchy

  • IObject3D
    • LineMesh

Implements

  • RenderDomObjectType

Constructors

constructor

Properties

doms name needsRender object? points type

Accessors

color dashed geometry lineOpacity lineWidth occlusionMode occlusionVisibility style

Methods

_onAdded _onHidden _onRemoved _onShowed add addIfNotExists highlight remove removeChildren removeFromParent setPoints setResolution setStyle unhighlight updateMatrixWorld

Constructors

constructor

  • new LineMesh(params?): LineMesh

  • Parameters

    • Optionalparams: Partial<LineColorStyle & LineOpacityStyle & LineWidthStyle & {
          dashed?: boolean;
      } & OcclusionStyle & Partial<LengthConfig> & Partial<DisplayInfoConfig> & PointsData>

    Returns LineMesh

Properties

doms

doms: LightTag[] = []

name

name: string = 'LineMesh'

needsRender

needsRender: boolean

Optionalobject

object?: Object3D

points

points: Vector3[] = []

type

type: string = 'Line2'

Accessors

color

  • get color(): Color

  • Returns Color

dashed

  • get dashed(): boolean

  • Returns boolean

geometry

  • get geometry(): LineGeometry

  • Returns LineGeometry

  • set geometry(geometry): void

  • Parameters

    • geometry: LineGeometry

    Returns void

lineOpacity

  • get lineOpacity(): number

  • Returns number

lineWidth

  • get lineWidth(): number

  • Returns number

occlusionMode

  • get occlusionMode(): "translucence" | "depthTest"

  • Returns "translucence" | "depthTest"

occlusionVisibility

  • get occlusionVisibility(): boolean

  • Returns boolean

style

  • get style(): LineMeshStyle

  • Returns LineMeshStyle

Methods

_onAdded

  • _onAdded(): void

  • Returns void

_onHidden

  • _onHidden(): void

  • Returns void

_onRemoved

  • _onRemoved(): void

  • Returns void

_onShowed

  • _onShowed(): void

  • Returns void

add

  • add(...objects): LineMesh

  • Adds object as child of this object.

    Parameters

    • Rest...objects: Object3D[]

    Returns LineMesh

addIfNotExists

  • addIfNotExists(...objects): LineMesh

  • Parameters

    • Rest...objects: Object3D[]

    Returns LineMesh

highlight

  • highlight(params?): void

  • Parameters

    • Optionalparams: {
          color?: Color;
      }
      • Optionalcolor?: Color

    Returns void

remove

  • remove(...objects): LineMesh

  • Removes object as child of this object.

    Parameters

    • Rest...objects: Object3D[]

    Returns LineMesh

removeChildren

  • removeChildren(): LineMesh

  • Returns LineMesh

removeFromParent

  • removeFromParent(): LineMesh

  • Returns LineMesh

setPoints

  • setPoints(points): void

  • Parameters

    • points: AnyPositions

    Returns void

setResolution

  • setResolution(width, height): void

  • Parameters

    • width: number
    • height: number

    Returns void

setStyle

  • setStyle(params): void

  • Parameters

    • params: Partial<LineMeshStyle>

    Returns void

unhighlight

  • unhighlight(): void

  • Returns void

updateMatrixWorld

  • updateMatrixWorld(force?): void

  • Updates global transform of the object and its children.

    Parameters

    • Optionalforce: boolean

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods