Class Gizmos

Static enabled

Static DrawArrow

• DrawArrow(pt0, pt1, color?, duration?, depthTest?, wireframe?): void

• Parameters

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

  Returns void

Static DrawDirection

• DrawDirection(pt, direction, color?, duration?, depthTest?, lengthFactor?): void

• Parameters

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

  Returns void

Static DrawLabel

• DrawLabel(position, text, size?, duration?, color?, backgroundColor?, parent?): 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
  • Optional color: ColorRepresentation
  • Optional backgroundColor: any
  • Optional parent: Object3D

  Returns LabelHandle

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

Static DrawLine

• DrawLine(pt0, pt1, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

Static DrawRay

• DrawRay(origin, dir, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

Static DrawSphere

• DrawSphere(center, radius, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

Static DrawWireBox

• DrawWireBox(center, size, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

Static DrawWireBox3

• DrawWireBox3(box, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

Static DrawWireMesh

• DrawWireMesh(options): 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;
        depthTest?: boolean;
        duration?: number;
    } & ({
        mesh: Mesh;
    } | {
        geometry: BufferGeometry;
        matrix: Matrix4;
    })

    the options for the wire mesh

  Returns void

  Example

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

Static DrawWireSphere

• DrawWireSphere(center, radius, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

Static isGizmo

• isGizmo(obj): boolean

• Returns true if a given object is a gizmo

  Parameters

  • obj: Object3D

  Returns boolean