Represents an instance of a model in the scene.
Extends
Members
allowExport :bool
Is the instance exportable
Type:
- bool
animations :Array.<Animation>
Dictionary of animations
Type:
- Array.<Animation>
displayTemplate :Array.<Object>
Template used for displaying instances properties
Type:
- Array.<Object>
hasChangeableProperties :bool
Flag if this instance has any changeable properties.
Type:
- bool
id :string
- Inherited From:
System-wide unique identifier
Type:
- string
insertionTime :float
Measured insertion time in ms.
Type:
- float
interaction :Interaction
- Inherited From:
Node's interaction settings.
Type:
isMeshInstance :bool
Is the mesh an instance
Type:
- bool
meta :MetaData
- Inherited From:
Node's meta data.
Type:
model :Model
Model this object was instantiated from
Type:
pose :Pose
- Inherited From:
Node's pose.
Type:
properties :Object.<string, Property>
Dictionary of properties this instance has
Type:
- Object.<string, Property>
propertyValues :PropertyValues
Dictionary of property values keyed by their names
Type:
videos :Array.<Video>
Dictionary of videos
Type:
- Array.<Video>
visible :boolean
- Inherited From:
Node's visibility.
Type:
- boolean
Methods
(async) setInteraction(newInteraction) → {Promise}
- Inherited From:
Changes object's interaction settings.
Parameters:
| Name | Type | Description |
|---|---|---|
newInteraction |
Interaction |
Returns:
Promise that resolves when updated.
- Type
- Promise
setMeta(metaChanges) → {Boolean}
- Inherited From:
Parameters:
| Name | Type | Description |
|---|---|---|
metaChanges |
MetaData |
Returns:
assignment result
- Type
- Boolean
(async) setParent(newParent) → {Promise}
- Inherited From:
Moves the node to a new container.
Parameters:
| Name | Type | Description |
|---|---|---|
newParent |
Container |
Returns:
resolved when done.
- Type
- Promise
(async) setPose(newPose) → {Promise}
- Inherited From:
Changes object's pose.
Parameters:
| Name | Type | Description |
|---|---|---|
newPose |
Pose |
Returns:
Promise that resolves when updated.
- Type
- Promise
(async) setPropertyValues(newValues)
Assigns values to one or more properties.
Parameters:
| Name | Type | Description |
|---|---|---|
newValues |
PropertyValues |
(async) setSurfaceMaterials(newMaterials)
Assigns materials to surfaces.
Parameters:
| Name | Type | Description |
|---|---|---|
newMaterials |
SurfaceMaterials |
(async) setVisible(newVisible) → {Promise}
- Inherited From:
Changes object's visibility.
Parameters:
| Name | Type | Description |
|---|---|---|
newVisible |
boolean |
Returns:
Promise that resolves when updated.
- Type
- Promise