update docs

piqnt · May 13, 2024 · 293c0c6 · 293c0c6
1 parent fe82918
commit 293c0c6
Show file tree

Hide file tree

Showing 149 changed files with 47 additions and 740 deletions.
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -13,6 +13,6 @@
  "react": "latest",
  "react-dom": "latest",
  "typescript": "latest",
- "vocs": "latest"
+ "vocs": "^1.0.0-alpha.50"
  }
 }
diff --git a/docs/pages/api-conventions/factories-and-definitions.md b/docs/pages/api-conventions/factories-and-definitions.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 ## Factories and Definitions
 

diff --git a/docs/pages/api-conventions/implicit-destruction.md b/docs/pages/api-conventions/implicit-destruction.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 ## Implicit Destruction
 

diff --git a/docs/pages/api-conventions/units.md b/docs/pages/api-conventions/units.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 ## Units
 Planck.js works with floating point numbers and tolerances have to be used to make Planck.js perform well.

diff --git a/docs/pages/api-conventions/user-data.md b/docs/pages/api-conventions/user-data.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 ## User Data
 The `Fixture`, `Body`, and `Joint` classes allow you to attach user data.

diff --git a/docs/pages/api/classes/aabb.md b/docs/pages/api/classes/aabb.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: AABB
 

diff --git a/docs/pages/api/classes/body.md b/docs/pages/api/classes/body.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: Body
 

diff --git a/docs/pages/api/classes/boxshape.md b/docs/pages/api/classes/boxshape.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: BoxShape
 
@@ -20,12 +17,6 @@ A rectangle polygon which extend PolygonShape.
 
 ### Properties
 
-* [m_centroid](/api/classes/boxshape#m_centroid)
-* [m_count](/api/classes/boxshape#m_count)
-* [m_normals](/api/classes/boxshape#m_normals)
-* [m_radius](/api/classes/boxshape#m_radius)
-* [m_type](/api/classes/boxshape#m_type)
-* [m_vertices](/api/classes/boxshape#m_vertices)
 * [style](/api/classes/boxshape#style)
 * [TYPE](/api/classes/boxshape#static-type)
 
@@ -46,75 +37,23 @@ A rectangle polygon which extend PolygonShape.
 
 ### constructor
 
-\+ **new BoxShape**(`hx`: number, `hy`: number, `center?`: [Vec2Value](/api/interfaces/vec2value), `angle?`: number): *[BoxShape](/api/classes/boxshape)*
+\+ **new BoxShape**(`halfWidth`: number, `halfHeight`: number, `center?`: [Vec2Value](/api/interfaces/vec2value), `angle?`: number): *[BoxShape](/api/classes/boxshape)*
 
 *Overrides [PolygonShape](/api/classes/polygonshape).[constructor](/api/classes/polygonshape#constructor)*
 
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`hx` | number |
-`hy` | number |
+`halfWidth` | number |
+`halfHeight` | number |
 `center?` | [Vec2Value](/api/interfaces/vec2value) |
 `angle?` | number |
 
 **Returns:** *[BoxShape](/api/classes/boxshape)*
 
 ## Properties
 
-### m_centroid
-
-• **m_centroid**: *Vec2*
-
-*Inherited from [PolygonShape](/api/classes/polygonshape).[m_centroid](/api/classes/polygonshape#m_centroid)*
-
-___
-
-### m_count
-
-• **m_count**: *number*
-
-*Inherited from [PolygonShape](/api/classes/polygonshape).[m_count](/api/classes/polygonshape#m_count)*
-
-___
-
-### m_normals
-
-• **m_normals**: *Vec2[]*
-
-*Inherited from [PolygonShape](/api/classes/polygonshape).[m_normals](/api/classes/polygonshape#m_normals)*
-
-___
-
-### m_radius
-
-• **m_radius**: *number*
-
-*Inherited from [PolygonShape](/api/classes/polygonshape).[m_radius](/api/classes/polygonshape#m_radius)*
-
-*Overrides [Shape](/api/classes/shape).[m_radius](/api/classes/shape#m_radius)*
-
-___
-
-### m_type
-
-• **m_type**: *"polygon"*
-
-*Inherited from [PolygonShape](/api/classes/polygonshape).[m_type](/api/classes/polygonshape#m_type)*
-
-*Overrides [Shape](/api/classes/shape).[m_type](/api/classes/shape#m_type)*
-
-___
-
-### m_vertices
-
-• **m_vertices**: *Vec2[]*
-
-*Inherited from [PolygonShape](/api/classes/polygonshape).[m_vertices](/api/classes/polygonshape#m_vertices)*
-
-___
-
 ### style
 
 • **style**: *[Style](/api/interfaces/style)*

diff --git a/docs/pages/api/classes/broadphase.md b/docs/pages/api/classes/broadphase.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: BroadPhase
 

diff --git a/docs/pages/api/classes/chainshape.md b/docs/pages/api/classes/chainshape.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: ChainShape
 
@@ -25,15 +22,6 @@ WARNING: The chain will not collide properly if there are self-intersections.
 
 ### Properties
 
-* [m_count](/api/classes/chainshape#m_count)
-* [m_hasNextVertex](/api/classes/chainshape#m_hasnextvertex)
-* [m_hasPrevVertex](/api/classes/chainshape#m_hasprevvertex)
-* [m_isLoop](/api/classes/chainshape#m_isloop)
-* [m_nextVertex](/api/classes/chainshape#m_nextvertex)
-* [m_prevVertex](/api/classes/chainshape#m_prevvertex)
-* [m_radius](/api/classes/chainshape#m_radius)
-* [m_type](/api/classes/chainshape#m_type)
-* [m_vertices](/api/classes/chainshape#m_vertices)
 * [style](/api/classes/chainshape#style)
 * [TYPE](/api/classes/chainshape#static-type)
 
@@ -73,64 +61,6 @@ Name | Type |
 
 ## Properties
 
-### m_count
-
-• **m_count**: *number*
-
-___
-
-### m_hasNextVertex
-
-• **m_hasNextVertex**: *boolean*
-
-___
-
-### m_hasPrevVertex
-
-• **m_hasPrevVertex**: *boolean*
-
-___
-
-### m_isLoop
-
-• **m_isLoop**: *boolean*
-
-___
-
-### m_nextVertex
-
-• **m_nextVertex**: *Vec2 | null*
-
-___
-
-### m_prevVertex
-
-• **m_prevVertex**: *Vec2 | null*
-
-___
-
-### m_radius
-
-• **m_radius**: *number*
-
-*Overrides [Shape](/api/classes/shape).[m_radius](/api/classes/shape#m_radius)*
-
-___
-
-### m_type
-
-• **m_type**: *"chain"*
-
-*Overrides [Shape](/api/classes/shape).[m_type](/api/classes/shape#m_type)*
-
-___
-
-### m_vertices
-
-• **m_vertices**: *Vec2[]*
-
-___
-
 ### style
 
 • **style**: *[Style](/api/interfaces/style)*

diff --git a/docs/pages/api/classes/circleshape.md b/docs/pages/api/classes/circleshape.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: CircleShape
 
@@ -18,9 +15,6 @@ showOutline: false
 
 ### Properties
 
-* [m_p](/api/classes/circleshape#m_p)
-* [m_radius](/api/classes/circleshape#m_radius)
-* [m_type](/api/classes/circleshape#m_type)
 * [style](/api/classes/circleshape#style)
 * [TYPE](/api/classes/circleshape#static-type)
 
@@ -64,28 +58,6 @@ Name | Type |
 
 ## Properties
 
-### m_p
-
-• **m_p**: *Vec2*
-
-___
-
-### m_radius
-
-• **m_radius**: *number*
-
-*Overrides [Shape](/api/classes/shape).[m_radius](/api/classes/shape#m_radius)*
-
-___
-
-### m_type
-
-• **m_type**: *"circle"*
-
-*Overrides [Shape](/api/classes/shape).[m_type](/api/classes/shape#m_type)*
-
-___
-
 ### style
 
 • **style**: *[Style](/api/interfaces/style)*

diff --git a/docs/pages/api/classes/clipvertex.md b/docs/pages/api/classes/clipvertex.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: ClipVertex
 

diff --git a/docs/pages/api/classes/contact.md b/docs/pages/api/classes/contact.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: Contact
 

diff --git a/docs/pages/api/classes/contactedge.md b/docs/pages/api/classes/contactedge.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: ContactEdge
 

diff --git a/docs/pages/api/classes/contactid.md b/docs/pages/api/classes/contactid.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: ContactID
 

diff --git a/docs/pages/api/classes/contactimpulse.md b/docs/pages/api/classes/contactimpulse.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: ContactImpulse
 

diff --git a/docs/pages/api/classes/distanceinput.md b/docs/pages/api/classes/distanceinput.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: DistanceInput
 

diff --git a/docs/pages/api/classes/distancejoint.md b/docs/pages/api/classes/distancejoint.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: DistanceJoint
 

diff --git a/docs/pages/api/classes/distanceoutput.md b/docs/pages/api/classes/distanceoutput.md
@@ -1,6 +1,3 @@
----
-showOutline: false
----
 
 # Class: DistanceOutput