ClipPlaneCreatedEvent

• webVis API Reference
• ClipPlaneCreatedEvent

Class ClipPlaneCreatedEvent

CLIPPLANE_CREATED CLIPPLANE_CREATED

Hierarchy

• 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, properties): 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

Inherited from WebVisEvent.id

properties

properties: ClipPlaneProperties

An object with the changed properties.

Optional transactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

Optional transactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optional type

type?: EventType

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 | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

• Returns Float32Array | [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 | [number, number, number]

• Returns Float32Array | [number, number, number]

  Deprecated

  normal is deprecated, please use properties.normal instead.

point

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

• Returns Float32Array | [number, number, number]

  Deprecated

  point is deprecated, please use properties.position instead.

position

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

• Returns Float32Array | [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.