Document toolboxDocument toolbox

2023.1.1571.2 Double Gyroscopic Joint



Overview

This kinematic constraint keeps an objects up direction constant.

The Kinematic Gyroscopic Joint works without using any Kinematic Relations.


Where to find

The Kinematic Gyroscopic Joint can be found under Mechanics > Kinematics > Kinematic joints > Kinematic Gyroscopic Joint.

This will add the Kinematic Gyroscopic Joint component to the currently selected object or create a new empty GameObject with the component attached if no objects are selected.

Joints must be placed as children of a DKinematics Controller in the hierarchy.

The following inspector component will be shown:

 


Feature layout

The image below shows the complete feature layout of the Kinematic Gyroscopic Joint component.

 

Generic Joint Settings

 

Pass Priority

Priority of the kinematic chain calculations. Higher numbers are calculated earlier.

Enforce Outside Playmode

Enforces the joint to work in edit mode.

Prevent Kinematic Update

Removes the joint from the kinematic chain calculations.

Min Translation Delta

The minimum value the joint detects as a change in position.

Min Rotation Delta

The minimum value the joint detects as a change in rotation.

Kinematic Chaining

 

Show in Scene View

Shows chained connections of this object through arrows.

Show When Not Selected

Shows chained connections of this object through arrows even when the object is not selected.

Add Kinematic Transfer Relation

Select a Kinematic Body to set a transfer relation. Alternatively, drag a Kinematic Body into the field.

Opposing Kinematic Relation

The Kinematic Body to which this relation is connected.

Relation Direction

Describes the direction of the manipulation of the Transforms. The following options are available:

  • BIDIRECTIONAL: Allows for both kinematic transforms, when they are being manipulated, to manipulate each other equally.

  • RECIEVE_ONLY: Allows for the joint, when it is being manipulated, to manipulate the opposing kinematic transform, but not the other way around.

  • SEND_ONLY: Allows for the opposing kinematic transform, when it is being manipulated, to manipulate the joint, but not the other way around.

Ratio

The ratio in which the relation is applied (1 means all the applied rotation translation is equally transferred).

Invert Relation

Check to invert the direction of the relation.

Gyroscopic Joint Settings

 

Global Up Direction

Describing the up direction of the Kinematic Gyroscopic Joint in global space.

Local Up Direction

Describing the up direction of the Kinematic Gyroscopic Joint in local space.

Scene View Settings

 

Always Enabled

When checked the indicated up direction arrow is always visible.

Enabled in Scene View

When checked the indicated up direction arrow is visible when this object is selected.

Color Settings

 

Global Up Color

Color of the global up direction in scene view.

Local Up Color

Color of the local up direction in scene view.


How to use

  1. Add a Kinematic Gyroscopic Joint to an object.

  2. Set the Global Up Direction to your desired value and enable Enforce Outside Playmode.

 

 

  1. Test if the joint is working.

 

Prespective Documentation