Object3DSync - Documentation

new Object3DSync(configopt)

The Object3DSync behavior syncs an object's transform and data

Parameters:

Name Type Attributes Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`position`	Boolean	<optional>	false	Whether object's position should be synced
`rotation`	Boolean	<optional>	false	Whether object's rotation should be synced
`scale`	Boolean	<optional>	false	Whether object's scale should be synced
`auto`	Boolean	<optional>	false	Whether the object should be synced automatically. Not currently recommended.
`world`	Boolean	<optional>	false	Whether world coordiantes should be sent when synchronizing position and rotation, instead of the transformation relative to the object's parent. Use if synced object is a child (e.g. of the tracking skeleton) only in the sender scene.

Members

(readonly) dataRef :Firebase

Firebase reference for the 'data' child location, can be used to store data related to this object.

(readonly) isMine :boolean

True if this object is currently owned by this client, false otherwise.

Methods

takeOwnership()

Take ownership of this object. The client that instantiates an object owns it, afterwards changes in ownership must be managed by the app. Manual modifications to the Firebase ref's will not obey ownership status.