API Docs for: 0.8.0

ClipControl

Helper that visualizes the position and direction of a plane.

Constructor

ClipControl

(
  • cfg
)

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 ClipControl plane indicator.

    • [autoPlaneSize=false] Boolean optional

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

Properties

active

Boolean

Indicates whether this ClipControl is active or not.

Default: true

autoPlaneSize

Boolean

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

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

Default: false

clip

Clip

The Clip attached to this ClipControl.

color

Float32Array

Emissive color of this ClipControl.

Default: [0.4,0.4,0.4]

planeSize

Float32Array

The width and height of the ClipControl plane indicator.

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

Default: [1,1]

solid

Boolean

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

Default: true

visible

Boolean

Visibility of this ClipControl.

Default: true