ClipPlaneCreatedEvent

• webVis API Reference
• ClipPlaneCreatedEvent

Class ClipPlaneCreatedEvent

Event that is fired when a clip plane is created in the scene. Contains the clip plane ID and an object with all the initial properties of the clip plane.

See

• ClipPlaneAPI
• EventType.CLIPPLANE_CREATED

Hierarchy (View Summary)

• WebVisEvent
  • ClipPlaneCreatedEvent

Index

Properties

clipPlaneID id properties transactionCode? transactionID? type?

Accessors

disabled invisible localTransform name normal point position thickness

Properties

clipPlaneID

clipPlaneID: number

The ID of the clip plane that was created

id

id: number

The unique ID of the event.

Inherited from WebVisEvent.id

properties

properties: ClipPlaneProperties

An object containing all properties of the created clip plane

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

Inherited from WebVisEvent.transactionCode

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Inherited from WebVisEvent.transactionID

Optionaltype

type?: EventType

The type of the event.

Inherited from WebVisEvent.type

Accessors

disabled

• get disabled(): boolean

• Returns boolean

  Deprecated

  The disabled getter is deprecated. Please use ClipPlaneProperties.enabled instead (note that disabled = !enabled).

  Returns whether the clip plane is disabled. This is the inverse of the enabled property in the properties object.

  See

  ClipPlaneProperties.enabled

invisible

• get invisible(): boolean

• Returns boolean

  Deprecated

  The invisible getter is deprecated. Please use ClipPlaneProperties.invisible instead.

  Returns whether the clip plane is visually hidden. When true, the clip plane's wireframe outline will not be displayed, though the clipping effect remains active.

  See

  ClipPlaneProperties.invisible

localTransform

• get localTransform(): | Float32Array<ArrayBufferLike>
  | [
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
  ]

• Returns
      | Float32Array<ArrayBufferLike>
      | [
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
      ]

  Deprecated

  The localTransform getter is deprecated. Please use ClipPlaneProperties.transform instead.

  Returns the 4x4 transformation matrix that defines the position, rotation, and scale of the clip plane in world space.

  See

  ClipPlaneProperties.transform

name

• get name(): string

• Returns string

  Deprecated

  The name getter is deprecated. Please use ClipPlaneProperties.name instead.

  Returns the display name of the clip plane, which can be used for identification in user interfaces or for debugging purposes.

  See

  ClipPlaneProperties.name

normal

• get normal(): Float32Array<ArrayBufferLike> | [number, number, number]

• Returns Float32Array<ArrayBufferLike> | [number, number, number]

  Deprecated

  The normal getter is deprecated. Please use ClipPlaneProperties.normal instead.

  Returns the normal vector of the clip plane, which defines its orientation in space.

  See

  ClipPlaneProperties.normal

point

• get point(): Float32Array<ArrayBufferLike> | [number, number, number]

• Returns Float32Array<ArrayBufferLike> | [number, number, number]

  Deprecated

  The point getter is deprecated. Please use ClipPlaneProperties.position instead.

  Returns the position of the clip plane in world space.

  See

  ClipPlaneProperties.position

position

• get position(): Float32Array<ArrayBufferLike> | [number, number, number]

• Returns Float32Array<ArrayBufferLike> | [number, number, number]

  Deprecated

  The position getter is deprecated. Please use ClipPlaneProperties.position instead.

  Returns the position of the clip plane in world space.

  See

  ClipPlaneProperties.position

thickness

• get thickness(): number

• Returns number

  Deprecated

  The thickness getter is deprecated. Please use ClipPlaneProperties.thickness instead.

  Returns the visual thickness of the clip plane representation in the scene.

  See

  ClipPlaneProperties.thickness