Interface NotificationsInternal

Cogs internal notifications API

interface NotificationsInternal {
    Image360?: Image360Notifications;
    OGC3DTiles?: OGC3DTilesNotifications;
    Potree?: PotreeNotifications;
    componentNotify(
        componentId: number,
        entityId: number,
        message: number,
        data: ArrayBufferView<ArrayBufferLike>,
    ): void;
    initialize(settings: ControlSettings): void;
    onEntityDestroyed(entity: Entity): void;
    unsubscribe(subscription: NotificationSubscription): void;
}

Hierarchy (View Summary)

Notifications
- NotificationsInternal

Index

Properties

Image360? OGC3DTiles? Potree?

Methods

componentNotify initialize onEntityDestroyed unsubscribe

Properties

`Optional`Image360

Image360?: Image360Notifications

Subscription endpoints for the Image360Component.

`Optional`OGC3DTiles

OGC3DTiles?: OGC3DTilesNotifications

Subscription endpoints for the OGC3DTilesComponent.

`Optional`Potree

Potree?: PotreeNotifications

Subscription endpoints for the PotreeComponent.

Methods

componentNotify

componentNotify(
    componentId: number,
    entityId: number,
    message: number,
    data: ArrayBufferView<ArrayBufferLike>,
): void
CogsInternal: Invoked by the component notify callback passed to cogs.core.
Parameters
- componentId: number
- entityId: number
- message: number
- data: ArrayBufferView<ArrayBufferLike>
Returns void
- Defined in Source/Notifications.ts:81

initialize

initialize(settings: ControlSettings): void
CogsInternal: Invoked by the runtime when engine is initialized.
Parameters
- settings: ControlSettings
Returns void
- Defined in Source/Notifications.ts:78

onEntityDestroyed

onEntityDestroyed(entity: Entity): void
CogsInternal: Invoked when an entity is destroyed, destroys all subscriptions for that entity.
Parameters
- entity: Entity
Returns void
- Defined in Source/Notifications.ts:84

unsubscribe

unsubscribe(subscription: NotificationSubscription): void
Unsubscribe to an existing subscription.
Parameters
- subscription: NotificationSubscription
Returns void
Inherited from Notifications.unsubscribe
- Defined in Source/Notifications.ts:71