xeogl / API Docs

API Docs for:

ClipHelper

Defined in: /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/clipHelper.js:1
Module: xeogl

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
)

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/clipHelper.js:1

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

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/clipHelper.js:73

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

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/clipHelper.js:55

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

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/clipHelper.js:92

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

Default: true

visible

Boolean

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/clipHelper.js:107

Indicates whether this ClipHelper is visible or not.

Default: true