Class GuidePlaneManager

allPlanesVisible

addPlane

• addPlane(
      origin: Vector3,
      normal: Vector3,
      visible: boolean,
      outlineColor: RGBA,
      fillColor: RGBA,
  ): string

  Parameters

  • origin: Vector3
  • normal: Vector3
  • visible: boolean
  • outlineColor: RGBA
  • fillColor: RGBA

  Returns string

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

getPlane

• getPlane(planeId: string): GuidePlane | undefined

  Parameters

  • planeId: string

  Returns GuidePlane | undefined

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

getPlanes

• getPlanes(): GuidePlane[]

  Returns GuidePlane[]

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

removePlane

• removePlane(planeId: string): void

  Parameters

  • planeId: string

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

setPlaneColors

• setPlaneColors(planeId: string, outlineColor: RGBA, fillColor: RGBA): void

  Parameters

  • planeId: string
  • outlineColor: RGBA
  • fillColor: RGBA

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

setPlaneNormal

• setPlaneNormal(planeId: string, normal: Vector3): void

  Parameters

  • planeId: string
  • normal: Vector3

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

setPlaneOrigin

• setPlaneOrigin(planeId: string, origin: Vector3): void

  Parameters

  • planeId: string
  • origin: Vector3

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

setPlaneVisibility

• setPlaneVisibility(planeId: string, visible: boolean): void

  Parameters

  • planeId: string
  • visible: boolean

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.