ClippingRoomCreatedEvent

Class ClippingRoomCreatedEvent

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

See

Hierarchy (View Summary)

Properties

clipRoomID id properties transactionCode? transactionID? type?

Accessors

disabled invisible name size transformation

Properties

clipRoomID

clipRoomID: number

The ID of the clip room that was created

id

id: number

The unique ID of the event.

properties

properties: ClipRoomProperties

An object containing all properties of the created clip room

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Optionaltype

type?: EventType

The type of the event.

Accessors

disabled

  • get disabled(): boolean

  • Returns boolean

    Deprecated

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

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

    See

    ClipRoomProperties.enabled

invisible

  • get invisible(): boolean

  • Returns boolean

    Deprecated

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

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

    See

    ClipRoomProperties.invisible

name

  • get name(): string

  • Returns string

    Deprecated

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

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

    See

    ClipRoomProperties.name

size

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

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

    Deprecated

    The size getter is deprecated. Please use ClipRoomProperties.size instead.

    Returns the dimensions of the clip room along the X, Y, and Z axes. The size defines the extent of the clipping box in local space.

    See

    ClipRoomProperties.size

transformation

  • get transformation(): | 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 transformation getter is deprecated. Please use ClipRoomProperties.transform instead.

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

    See

    ClipRoomProperties.transform



Was this page helpful? Please leave a thumbs up or down.