xeogl / API Docs

API Docs for: 0.7.0

ClipHelper

Defined in: 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 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 examples/js/helpers/clipHelper.js:114

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.

Fires an autoPlaneSize event on change.

Default: false

clip

Clip

Defined in examples/js/helpers/clipHelper.js:42

The Clip attached to this ClipHelper.

Fires an ClipHelper/Clip:event event on change.

planeSize

Float32Array

Defined in examples/js/helpers/clipHelper.js:83

The width and height of the ClipHelper plane indicator.

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

Fires an planeSize event on change.

Default: Fitted to scene boundary

solid

Boolean

Defined in examples/js/helpers/clipHelper.js:146

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

Fires a ClipHelper/active:event event on change.

Default: true

visible

Boolean

Defined in examples/js/helpers/clipHelper.js:175

Indicates whether this ClipHelper is visible or not.

Fires a ClipHelper/active:event event on change.

Default: true

Events

autoPlaneSize

Defined in examples/js/helpers/clipHelper.js:133

Fired whenever this ClipHelper's autoPlaneSize property changes.

Event Payload:

  • value Float32Array

    The property's new value

planeSize

Defined in examples/js/helpers/clipHelper.js:101

Fired whenever this ClipHelper's planeSize property changes.

Event Payload:

  • value Float32Array

    The property's new value

solid

Defined in examples/js/helpers/clipHelper.js:161

Fired whenever this helper's solid property changes.

Event Payload:

  • value Boolean

    The property's new value

visible

Defined in examples/js/helpers/clipHelper.js:190

Fired whenever this helper's visible property changes.

Event Payload:

  • value Boolean

    The property's new value