Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ClipPlaneCreatedEvent

• webVis API Reference
• ClipPlaneCreatedEvent

Class ClipPlaneCreatedEvent

CLIPPLANE_CREATED CLIPPLANE_CREATED

Hierarchy (View Summary)

• WebVisEvent
  • ClipPlaneCreatedEvent

Index

Constructors

constructor

Properties

clipPlaneID id properties transactionCode? transactionID? type?

Accessors

disabled invisible localTransform name normal point position thickness

Constructors

constructor

• new ClipPlaneCreatedEvent(
      clipPlaneID: number,
      properties: ClipPlaneProperties,
  ): ClipPlaneCreatedEvent

• The ClipPlaneCreatedEvent occurs if a clip plane was created.

  Parameters

  • clipPlaneID: number

    The ID of the clip plane.
  • properties: ClipPlaneProperties

    An object with the changed properties.

  Returns ClipPlaneCreatedEvent

  Overrides WebVisEvent.constructor

Properties

clipPlaneID

clipPlaneID: number

The ID of the clip plane.

id

id: number

The unique ID of the event.

Inherited from WebVisEvent.id

properties

properties: ClipPlaneProperties

An object with the changed properties.

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

  disabled is deprecated, please use properties.enabled instead.

invisible

• get invisible(): boolean

• Returns boolean

  Deprecated

  invisible is deprecated, please use properties.invisible instead.

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

  localTransform is deprecated, please use properties.transform instead.

name

• get name(): string

• Returns string

  Deprecated

  name is deprecated, please use properties.name instead.

normal

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

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

  Deprecated

  normal is deprecated, please use properties.normal instead.

point

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

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

  Deprecated

  point is deprecated, please use properties.position instead.

position

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

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

  Deprecated

  position is deprecated, please use properties.position instead.

thickness

• get thickness(): number

• Returns number

  Deprecated

  thickness is deprecated, please use properties.thickness instead.