Skip to content

Commit b9d3834

Browse files
committed
docs(joint): mark the joint API as alpha
1 parent 5f468cf commit b9d3834

4 files changed

Lines changed: 11 additions & 0 deletions

File tree

src/framework/components/joint/component.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,7 @@ const jointImpls = {
296296
*
297297
* @hideconstructor
298298
* @category Physics
299+
* @alpha
299300
*/
300301
class JointComponent extends Component {
301302
/**

src/framework/components/joint/constants.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* Joint rigidly locks all degrees of freedom, welding the two bodies together.
33
*
44
* @category Physics
5+
* @alpha
56
*/
67
export const JOINTTYPE_FIXED = 'fixed';
78

@@ -10,6 +11,7 @@ export const JOINTTYPE_FIXED = 'fixed';
1011
* limits constrain the swing (cone) and twist angles.
1112
*
1213
* @category Physics
14+
* @alpha
1315
*/
1416
export const JOINTTYPE_BALL = 'ball';
1517

@@ -18,6 +20,7 @@ export const JOINTTYPE_BALL = 'ball';
1820
* axle. Supports optional rotation limits and a motor.
1921
*
2022
* @category Physics
23+
* @alpha
2124
*/
2225
export const JOINTTYPE_HINGE = 'hinge';
2326

@@ -26,6 +29,7 @@ export const JOINTTYPE_HINGE = 'hinge';
2629
* runner or a piston. Supports optional travel limits and a motor.
2730
*
2831
* @category Physics
32+
* @alpha
2933
*/
3034
export const JOINTTYPE_SLIDER = 'slider';
3135

@@ -34,26 +38,30 @@ export const JOINTTYPE_SLIDER = 'slider';
3438
* limited or free, with optional springs.
3539
*
3640
* @category Physics
41+
* @alpha
3742
*/
3843
export const JOINTTYPE_6DOF = '6dof';
3944

4045
/**
4146
* Specified degree of freedom has free movement.
4247
*
4348
* @category Physics
49+
* @alpha
4450
*/
4551
export const MOTION_FREE = 'free';
4652

4753
/**
4854
* Specified degree of freedom has limited movement.
4955
*
5056
* @category Physics
57+
* @alpha
5158
*/
5259
export const MOTION_LIMITED = 'limited';
5360

5461
/**
5562
* Specified degree of freedom is locked and allows no movement.
5663
*
5764
* @category Physics
65+
* @alpha
5866
*/
5967
export const MOTION_LOCKED = 'locked';

src/framework/components/joint/system.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ const _properties = [
2424
* Manages creation of {@link JointComponent}s.
2525
*
2626
* @category Physics
27+
* @alpha
2728
*/
2829
class JointComponentSystem extends ComponentSystem {
2930
/**

src/framework/components/registry.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ class ComponentSystemRegistry extends EventHandler {
109109
*
110110
* @type {JointComponentSystem|undefined}
111111
* @readonly
112+
* @alpha
112113
*/
113114
joint;
114115

0 commit comments

Comments
 (0)