API Docs for:

ClipHelper

Helper that visualizes the position and direction of a Clip. The helper works by tracking updates to the Clip's pos and dir.

Constructor

ClipHelper

(
  • cfg
)

Parameters:

  • cfg

    Configuration

    • clip Clip

      A Clip to visualize.

    • [solid=true] Boolean optional

      Indicates whether or not this helper is filled with color or just wireframe.

    • [visible=true] Boolean optional

      Indicates whether or not this helper is visible.

    • [planeSize] Float32Array optional

      The width and height of the ClipHelper plane indicator.

    • [autoPlaneSize=false] Boolean optional

      Indicates whether or not this ClipHelper's planeSize is automatically sized to fit within the Scene's boundary.

Properties

autoPlaneSize

Boolean

Indicates whether this ClipHelper's planeSize is automatically generated or not.

When auto-generated, planeSize will automatically size to fit within the Scene's boundary.

Default: false

planeSize

Float32Array

The width and height of the ClipHelper plane indicator.

When no value is specified, will automatically size to fit within the Scene's boundary.

Default: Fitted to scene boundary

solid

Boolean

Indicates whether this ClipHelper's plane is filled or just wireframe.

Default: true

visible

Boolean

Indicates whether this ClipHelper is visible or not.

Default: true