Class Gizmos

Staticenabled

StaticDrawArrow

• DrawArrow(
      pt0: Vec3,
      pt1: Vec3,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
      wireframe?: boolean,
  ): void

  Parameters

  • pt0: Vec3
  • pt1: Vec3
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true
  • wireframe: boolean = false

  Returns void

StaticDrawCircle

• DrawCircle(
      pt0: Vec3,
      normal: Vec3,
      radius: number,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • pt0: Vec3
  • normal: Vec3
  • radius: number
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticDrawDirection

• DrawDirection(
      pt: Vec3,
      direction: Vec3 | Vec4,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
      lengthFactor?: number,
  ): void

  Parameters

  • pt: Vec3
  • direction: Vec3 | Vec4
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true
  • lengthFactor: number = 1

  Returns void

StaticDrawLabel

• DrawLabel(
      position: Vec3,
      text: string,
      size?: number,
      duration?: number,
      color?: ColorRepresentation,
      backgroundColor?: ColorRepresentation | ColorWithAlpha,
      parent?: Object3D<Object3DEventMap>,
  ): null | LabelHandle

  Draw a label in the scene or attached to an object (if a parent is provided)

  Parameters

  • position: Vec3
  • text: string
  • size: number = .05
  • duration: number = 0
  • Optionalcolor: ColorRepresentation
  • OptionalbackgroundColor: ColorRepresentation | ColorWithAlpha
  • Optionalparent: Object3D<Object3DEventMap>

  Returns null | LabelHandle

  a handle to the label that can be used to change the text

StaticDrawLine

• DrawLine(
      pt0: Vec3,
      pt1: Vec3,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • pt0: Vec3
  • pt1: Vec3
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticDrawRay

• DrawRay(
      origin: Vec3,
      dir: Vec3,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • origin: Vec3
  • dir: Vec3
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticDrawSphere

• DrawSphere(
      center: Vec3,
      radius: number,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • center: Vec3
  • radius: number
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticDrawWireBox

• DrawWireBox(
      center: Vec3,
      size: Vec3,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • center: Vec3
  • size: Vec3
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticDrawWireBox3

• DrawWireBox3(
      box: Box3,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • box: Box3
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticDrawWireMesh

• DrawWireMesh(
      options: {
          color?: ColorRepresentation | undefined;
          depthTest?: boolean;
          duration?: number;
      } & ({ mesh: Mesh } | { geometry: BufferGeometry; matrix: Matrix4 }),
  ): void

  Render a wireframe mesh in the scene. The mesh will be removed after the given duration (if duration is 0 it will be rendered for one frame).
  If a mesh object is provided then the mesh's matrixWorld and geometry will be used. Otherwise, the provided matrix and geometry will be used.

  Parameters

  • options: {
        color?: ColorRepresentation | undefined;
        depthTest?: boolean;
        duration?: number;
    } & ({ mesh: Mesh } | { geometry: BufferGeometry; matrix: Matrix4 })

    the options for the wire mesh

    • Optionalcolor?: ColorRepresentation | undefined

      the color of the wire mesh

    • OptionaldepthTest?: boolean

      if true the wire mesh will be rendered with depth test

    • Optionalduration?: number

      the duration in seconds the mesh will be rendered. If 0 it will be rendered for one frame
    • { mesh: Mesh }

      • mesh: Mesh

        the mesh object to render (if it is provided the matrix and geometry will be used)
    • { geometry: BufferGeometry; matrix: Matrix4 }

      • geometry: BufferGeometry

        the geometry of the mesh to render

      • matrix: Matrix4

        the matrix of the mesh to render

  Returns void

  Example

  Gizmos.DrawWireMesh({ duration: 1, color: 0xff0000, mesh: myMesh });
  Copy

StaticDrawWireSphere

• DrawWireSphere(
      center: Vec3,
      radius: number,
      color?: ColorRepresentation,
      duration?: number,
      depthTest?: boolean,
  ): void

  Parameters

  • center: Vec3
  • radius: number
  • color: ColorRepresentation = defaultColor
  • duration: number = 0
  • depthTest: boolean = true

  Returns void

StaticisGizmo

• isGizmo(obj: Object3D): boolean

  Returns true if a given object is a gizmo

  Parameters

  • obj: Object3D

  Returns boolean

StaticsetVisible

• setVisible(visible: boolean): void

  Set visibility of all currently rendered gizmos

  Parameters

  • visible: boolean

  Returns void