EngageableObject Class

Initializes a new instance of the EngageableObject class

True if controllers are tracking (this object is moving towards the controllers every frame)

The list of engaged controllers

The top most parent that is also the root of the hierarchy

True if interaction is allowed, otherwise false

An alternative point to use for interaction calculations

True if this object is currently engaged by one or more controllers

Specifies how physics should behave after engagement ends

True if this object needs both hands to interact with

The associated RigidBody

Sensitivity of movement that is applied (acts like a dampener). Note this is applied to both angular movement and positional movement.

This object's Transform component

The associated TransformSync component

Engage After this is called a Ghost message is broadcast

Unity Component Method

Iterate over all the reactions

Calculates the average angular velocity of all the engaging controllers

Default direction is from interaction point to controller

Calculates the distance from the interaction point (using the transform's position as default) to the average position of all the engaging controllers using world coordinates

Calculates the average velocity of all the engaging controllers using world coordinates

Default direction is from interaction point to controller

Gets the message payload for this object

Returns the target position for this object based on the current engaging controller and interaction point

Vector from where the object was grabbed (tracked on object) to the same relative interaction point (tracked on controlelr)

Calculates the distance from the interaction point (using the transform's position as default) to the average position of all the engaging controllers using world coordinates

Calculates the average velocity of all the engaging controllers using world coordinates

Initialise this pickup with the secified settings

Checks if the object is engaged by a specific controller

Checks whether the vector passed in is valid - checks for Nan, and that it's magnitude is greater than Mathf.Epsilon

Unity Component Method

Masks the specified vector by only allowing the axis specified

Moves the object towards the average position of all the engaged controllers using physics in VR (in WebGL we will just set the position). Note: world coordinates are used when doing calculations.

Rotates the object towards the average rotation of all the engaged controllers using physics in VR (in WebGL we will just set the position)

Moves this object by applying the velocity

Called when an object engagement ends (before network message is sent). Note: Only the local user will receive this.

Unity Component Method

Called when an object engagement starts (before network message is sent). Note: Only the local user will receive this.

Called when a delete message is received

Called when an object engagement ends (when network message is received). Note: All users (local and remote) will receive this.

Called when an object engagement starts (when network message is received). Note: All users (local and remote) will receive this.

Called after an engagement starts/ends. Will execute all the valid reactions for this action.

Returns true if interaction is allowed, and interaction requirements are met.

Override this to restrict movement direction in some way. Default behavior is to return the direction unmodified.

Override this to restrict an object's position in some way. Default behavior is to return the target position unmodified.

Rotates the object towards the average rotation of all the engaged controllers using physics. This rotation is also masked so only the world axis specified is used.

Rotates the object using the average angular velocity of all the engaged controllers using physics. This rotation is also masked so only the local axis specified is used.

Sends the network message

Sets the interaction target on the controller

Used to trigger a small vibration for the user

Used to trigger a small vibration for the user

Returns true if the default throw force should be added (only valid for local disengagements that has authority)

Shows/Hides a highlight around the object

We reduce drag for smoother interaction. This method toggles it on or off

Trigger a short vibration on the current engaged object

Unity Component Method

Called when this object's engagement state changes. Override to implement any visual feedback required.

Fired when this object is disengaged

Fired when this object is disengaged (local only)

Fired when this object is engaged

Fired when this object is engaged (local only)

An alternative point to use for interaction calculations

Requirements that has to be satisfied to allow interaction

Specifies how physics should behave after engagement ends

Indicates whether this object needs to be engaged with by 2 controllers to move

Indicates whether this object needs to be engaged with by 2 controllers to unsnap

The associated TransformSync component

Any distance less than this would be ignored in calculations for movement

Any distance less than this would be ignored in calculations for movement

Disengage an engageable object

Engage an engageable object. This will be a local/remote engagement based on it's type (EngageableObject)

Copies all properties of a component from source to target. Uses reflection to set properties.

Checks whether the target is available for interaction

Waits for a singleton on a coroutine