Core API Reference: Entity Joint

From Color Infection Wiki

Jump to: navigation, search


Contents


Set Joint Limits Enabled

Enabled or disable the limits for a joint. Currently, this API is only for hinge and slider joints.

Input Parameters:

The Joint
the joint
Enabled?
true to enable, false to disable

Output Parameters:

(none)
Set Joint Motor Enabled

Enabled or disable motor for a joint. Currently, this API is only for hinge and slider joints.

Input Parameters:

The Joint
the joint
Enabled?
true to enable, false to disable

Output Parameters:

(none)
Get Hinge Angle (By Degrees)

Get the current angle by degrees of a hinge. The initial angle is zero.

Input Parameters:

The Hinge
the hinge joint

Output Parameters:

Current Angle (degrees)
the result
Get Hinge Limits (By Degrees)

Get the lower angle and upper angle limits of a hinge joint.

Input Parameters:

The Hinge
the hinge joint

Output Parameters:

Lower Angle (degrees)
lower limit
Upper Angle (degrees)
upper limit
Set Hinge Limits (By Degrees)

Set the lower angle and upper angle limits of a hinge joint.

Input Parameters:

The Hinge
the hinge joint
Lower Angle (degrees)
lower limit
Upper Angle (degrees)
upper limit

Output Parameters:

(none)
Get Hinge Motor Speed (By Degrees)

Get the motor speed of a hinge joint by degrees.

Input Parameters:

The Hinge
the hinge joint

Output Parameters:

Motor Speed (degrees/s)
the motor speed
Set Hinge Motor Speed (By Degrees)

Set the motor speed of a hinge joint by degrees.

Input Parameters:

The Hinge
the hinge joint
Motor Speed (degrees/s)
the motor speed

Output Parameters:

(none)
Get Slider Translation

Get the current translation of a slider joint. The initial translation is zero.

Input Parameters:

The Slider
the slider joint

Output Parameters:

Current Translation
the result
Get Slider Limits

Get the lower translation and upper translation limits of a slider joint.

Input Parameters:

The Slider
the slider joint

Output Parameters:

Lower Translation
lower translation
Upper Translation
upper translation
Set Slider Limits

Set the lower translation and upper translation limits of a slider joint.

Input Parameters:

The Slider
the slider joint
Lower Translation
lower translation
Upper Translation
upper translation

Output Parameters:

(none)
Get Slider Motor Speed

Get the motor speed of a slider joint.

Input Parameters:

The Slider
the slider joint

Output Parameters:

Motor Speed (m/s)
the motor speed
Set Slider Motor Speed

Set the motor speed of a slider joint.

Input Parameters:

The Slider
the slider joint
Motor Speed (m/s)
the motor speed

Output Parameters:

(none)
Personal tools