Global

Members

DEFAULT_AR_CAMERA_POSE :ControllableCameraPose

Type:

DEFAULT_HIGHLIGHT_INFO :ControllableCameraPose

Type:

DEFAULT_INTERACTION :Vector3d

Type:

DEFAULT_LOOKAT :Quaternion

Type:

DEFAULT_ORIENTATION :Vector3d

Type:

DEFAULT_PANORAMA_CAMERA_POSE :PerspectiveCameraPose

Type:

DEFAULT_POSE :boolean

Type:
  • boolean

DEFAULT_POSITION :Vector3d

Type:

DEFAULT_SCALE :Pose

Type:

DEFAULT_VISIBLE :MetaData

Type:

DEFAULT_VR_CAMERA_POSE :ControllableCameraPose

Type:

Methods

prepareSource(src)

Wrap source code with plugins specific code.

Parameters:
Name Type Description
src

The user's plugin source code.

setToken(newToken)

Set the token from outside (if already logged in).

Parameters:
Name Type Description
newToken string

Type Definitions

BulkInsertionInfo

Properties:
Name Type Attributes Description
model Model | string
instanceProps ModelInsertionParams <nullable>
insertionParams Object <nullable>
Type:
  • Object

CameraInteraction

Properties:
Name Type Description
primaryDrag string
secondaryDrag string
rotate string
pinch string

Possible interaction type strings: "rotationAroundPivot", "translationScreenSpace", "translationDolly", "disabled"

Type:
  • Object

ColorRgb

Properties:
Name Type Description
r number

the color's red component between 0-255.
g number

the color's green component between 0-255.
b number

the color's blue component between 0-255.

RGB Color

Type:
  • Object

ContainerInsertionParams

Properties:
Name Type Attributes Description
parent Container <nullable>
position Pose <nullable>
interaction Interaction <nullable>
visible boolean <nullable>
type string <nullable>
moveBelowFloor boolean <nullable>
Type:
  • Object

ControllableCameraPose

Properties:
Name Type Attributes Description
position Vector3d <nullable>
orientation Quaternion <nullable>
Type:
  • Object

DeviceRamInfo

Current memory usage of the device.

Type:
  • Object

EmailObject

Properties:
Name Type Attributes Description
subject string

subject of the outgoing email.
message string

body of the outgoing email (can also include html tags).
recipients Array.<string>

list of recipients.
cc Array.<string> <nullable>

list of recipients in cc.
bcc Array.<string> <nullable>

list of recipients in bcc.
attachments Array.<string> <nullable>

list of attachments to be added to the email. Prefix with '@' to send local files.
shareAsText boolean <nullable>

Send content as text instead of HTML (default false).

Defines an outgoing email.

Type:
  • Object

FeaturePointHit

Properties:
Name Type Description
intersection Vector3d

the position of the feature point projected onto the ray.
distance number

distance from the ray origin to the intersection.
position Vector3d

the position of the feature point.
offset number

the distance from the feature point to the intersection.
Type:
  • Object

HighlightInfo

Properties:
Name Type Description
type string
visible boolean
Type:
  • object

InstanceHit

Properties:
Name Type Description
faceID number

the intersection's face id.
x number

the intersection's x position.
y number

the intersection's y position.
z number

the intersection's z position.
normalX number

the intersection's normal x component.
normalY number

the intersection's normal y component.
normalZ number

the intersection's normal z component.
/

/**
instanceId string

the id of the model instance.
mesh string

the name of the hit mesh.
meshid string

the id of the hit mesh.
modelid string

the model id of the model instance.
submesh string

the name of the hit submesh.
submeshid number

the id of the hit submesh.
surfaceId string

the id of the hit surface.
intersection InstanceHitIntersection

the intersection position.
Type:
  • Object

Interaction

Properties:
Name Type Attributes Description
manipulationPlane string <nullable>

direction where touch drag is applied to. Either 'horizontal' or 'vertical'.
translation boolean <nullable>

allow translation of the model instance.
rotation boolean <nullable>

allow rotation of the model instance.
scaling boolean <nullable>

allow scaling of the model instance.
Type:
  • Object

MetaData

Type:
  • Object

ModelInsertionParams

Properties:
Name Type Attributes Description
parent Container <nullable>
position Pose <nullable>
interaction Interaction <nullable>
visible boolean <nullable>
propertyValues Object <nullable>
meshInstance boolean <nullable>

insert to model as mesh instance of another mesh (if already existing)to improve rendering performance.
moveBelowFloor boolean <nullable>
Type:
  • Object

PerspectiveCameraPose

Properties:
Name Type Attributes Description
position Vector3d <nullable>
lookAt Vector3d <nullable>
Type:
  • Object

Pose

Properties:
Name Type Attributes Description
position Vector3d <nullable>
orientation Quaternion <nullable>
scale Vector3d <nullable>
Type:
  • Object

PropertyValues

Type:
  • Object.<string, (string|number)>

Quaternion

Properties:
Name Type Description
w number
x number
y number
z number
Type:
  • Object

Ray

Properties:
Name Type Description
origin Vector3d

the origin of the ray.
direction Vector3d

the normalized direction of the ray.
Type:
  • Object

RayHits

Properties:
Name Type Description
featurePoints Array.<FeaturePointHit>

the intersection with feature points.
realWorldPlanes Array.<RealWorldPlaneHit>

the intersection with feature points.
floors Array.<Vector3d>

the intersection with the floor.
instances Array.<InstanceHit>

the intersections with scene instances.
ray Ray

the ray that was casted.
Type:
  • Object

RealWorldPlaneHit

Properties:
Name Type Description
intersection Vector3d

the position of the real world plane point projected onto the ray.
distance number

distance from the ray origin to the intersection.
position Vector3d

the position of the real world plane point.
offset number

the distance from the real world plane point to the intersection.
Type:
  • Object

SceneExportResult

Properties:
Name Type Description
success bool

the success of the operation.
error string

the error message if success is false.
path string

the relative path or the url (if format is 'usd') to the exported scene file.
Type:
  • Object

SurfaceMaterials

Type:
  • Object.<string, string>

SyncParams

Properties:
Name Type Attributes Description
pollInterval number <nullable>

polling interval in ms. Sync manager will wait at least this long between pollings
send boolean <nullable>

whether this instance should send payloads or not
receive boolean <nullable>

whether this instance should receive payloads or not
Type:
  • object

Vector3d

Properties:
Name Type Description
x number
y number
z number
Type:
  • Object