Class Gizmos

Staticenabled

StaticDrawArrow

• 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

StaticDrawCircle

• DrawCircle(pt0, normal, radius, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

StaticDrawDirection

• 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

StaticDrawLabel

• DrawLabel(position, text, size?, duration?, color?, backgroundColor?, parent?): 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, pt1, color?, duration?, depthTest?): void

• Parameters

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

  Returns void

StaticDrawRay

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

• Parameters

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

  Returns void

StaticDrawSphere

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

• Parameters

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

  Returns void

StaticDrawWireBox

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

• Parameters

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

  Returns void

StaticDrawWireBox3

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

• Parameters

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

  Returns void

StaticDrawWireMesh

• 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 | undefined;
        depthTest?: boolean;
        duration?: number;
    } & ({
        mesh: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>;
    } | {
        geometry: BufferGeometry<NormalBufferAttributes>;
        matrix: Matrix4;
    })

    the options for the wire mesh

  Returns void

  Example

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

StaticDrawWireSphere

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

• Parameters

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

  Returns void

StaticisGizmo

• isGizmo(obj): boolean

• Returns true if a given object is a gizmo

  Parameters

  • obj: Object3D<Object3DEventMap>

  Returns boolean

StaticsetVisible

• setVisible(visible): void

• Set visibility of all currently rendered gizmos

  Parameters

  • visible: boolean

  Returns void