Global

Type Definitions

Emitter

Properties:
Name Type Description
clientUUID string

Client unique identifier in the session

userUUID string

User unique identifier

sessionUUID string

Session unique identifier where the action occurs

Action emitter. Occurs during an entity event.

viewport_info

Properties:
Name Type Description
id number

The id of the viewport

width number

Viewport width ratio (from 0.0 to 1.0) within the display area (display resolution)

height number

Viewport height ratio (from 0.0 to 1.0) within the display area (display resolution)

left number

Viewport left border position ratio (from 0.0 to 1.0) within the display area

top number

Viewport top border position ratio (from 0.0 to 1.0) within the display area

camera SDK3DVerse_Entity

Camera entity associated with the viewport

viewport object definition

Events

onEntitiesDeleted

Properties:
Name Type Description
deletedEntityRTIDs Array.<string>

An array of deleted entity IDs

emitter Emitter

Client emitting the event.

Get notified when one or more entity have been deleted SDK3DVerse.notifier.on('onEntitiesDeleted', (deletedEntityRTIDs) => ...

onEntitiesUpdated

Properties:
Name Type Description
entities Array.<SDK3DVerse_Entity>

An array of all updated entities

propagater string

Name of the propagater module. Used to ignore our own propagated events.

updatedComponentByEUIDs Object

An object listing updated component by entity unique identifer.

updatedAncestors Array.<SDK3DVerse_Entity>

An array of parents of updated entities. Empty during propagateChanges

emitter Emitter

Client emitting the event. null during propagateChanges

Entity selection has changed SDK3DVerse.notifier.on('onEntitiesUpdated', (entities, propagater) =>

onEntityCreated

Properties:
Name Type Description
createdEntity SDK3DVerse_Entity

Created entity

emitter Emitter

Client emitting the event. Could be null if the client initiated the creation.

Get notified when an entity has been created SDK3DVerse.notifier.on('onEntityCreated', (entity) => ...

onEntityReparent

Properties:
Name Type Description
movingEntity SDK3DVerse_Entity

Specified entity

oldParentEntity SDK3DVerse_Entity

Previous parent entity

newParentEntity SDK3DVerse_Entity

New parent entity

emitter Emitter

Client emitting the event.

Entity has been parent's has been changed. SDK3DVerse.notifier.on('onEntityReparent', (movingEntity, oldParentEntity, newParentEntity) => ...

onEntitySelectionChanged

Properties:
Name Type Description
selectedEntities Array.<SDK3DVerse_Entity>

An array of all selected entities

Entity selection has changed SDK3DVerse.notifier.on('onEntitySelectionChanged', (entities) =>

onEntityVisibilityChanged

Properties:
Name Type Description
entityRTID string

Entity ID

Entity Visibility has been updated SDK3DVerse.notifier.on('OnEntityVisibilityChanged', (entityRTID) => ...

onSettingsUpdated

Properties:
Type Description
object

Each property of this object is an updated setting value

Editor settings have been updated SDK3DVerse.notifier.on('onSettingsUpdated', () => ...