xeogl / API Docs

API Docs for:

PlaneHelper

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

Helper that visualizes the position and direction of a plane.

Constructor

PlaneHelper

(
  • cfg
)

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

Parameters:

  • cfg

    Configuration

    • [pos=[0,0,0] Float32Array optional

      World-space position.

    • [dir=[0,0,1] Float32Array optional

      World-space direction vector.

    • [color=[0.4,0.4,0.4] Float32Array optional

      Emmissive color

    • [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 PlaneHelper plane indicator.

    • [autoPlaneSize=false] Boolean optional

      Indicates whether or not this PlaneHelper'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/planeHelper.js:200

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

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

Default: false

color

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/planeHelper.js:241

Emmissive color of this PlaneHelper.

Default: [0.4,0.4,0.4]

dir

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/planeHelper.js:163

World-space direction of this PlaneHelper.

Default: [0,0,1]

planeSize

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/planeHelper.js:181

The width and height of the PlaneHelper plane indicator.

Values assigned to this property will be overridden by an auto-computed value when autoPlaneSize is true.

Default: [1,1]

solid

Boolean

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/planeHelper.js:258

Indicates whether this PlaneHelper is filled with color or just wireframe.

Default: true

visible

Boolean

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/planeHelper.js:274

Indicates whether this PlaneHelper is visible or not.

Default: true

worldPos

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/helpers/planeHelper.js:146

World-space position of this PlaneHelper.

Default: [0,0,0]