Skip to content

Commit

Permalink
Improve Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Gugustinette committed May 11, 2024
1 parent ccc6e38 commit b3efc33
Show file tree
Hide file tree
Showing 22 changed files with 203 additions and 182 deletions.
14 changes: 7 additions & 7 deletions docs/api/classes/2d_src.FComponent2d.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[fibbojs](../README.md) / [Modules](../modules.md) / [2d/src](../modules/2d_src.md) / FComponent2d
[@fibbojs](/api/index) / [2d](/api/modules/2d_src) / FComponent2d

# Class: FComponent2d

[2d/src](../modules/2d_src.md).FComponent2d
[2d](/api/modules/2d_src).FComponent2d

**`Description`**

Expand Down Expand Up @@ -43,7 +43,7 @@ FComponent.constructor

#### Defined in

packages/2d/src/FComponent2d.ts:8
[packages/2d/src/FComponent2d.ts:8](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FComponent2d.ts#L8)

## Methods

Expand All @@ -67,7 +67,7 @@ FComponent.onFrame

#### Defined in

packages/2d/src/FComponent2d.ts:12
[packages/2d/src/FComponent2d.ts:12](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FComponent2d.ts#L12)

___

Expand All @@ -92,7 +92,7 @@ Set the position of the component.

#### Defined in

packages/2d/src/FComponent2d.ts:17
[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FComponent2d.ts#L17)

___

Expand All @@ -117,7 +117,7 @@ Set the rotation of the component.

#### Defined in

packages/2d/src/FComponent2d.ts:27
[packages/2d/src/FComponent2d.ts:27](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FComponent2d.ts#L27)

___

Expand All @@ -142,4 +142,4 @@ Set the scale of the component.

#### Defined in

packages/2d/src/FComponent2d.ts:22
[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FComponent2d.ts#L22)
16 changes: 8 additions & 8 deletions docs/api/classes/2d_src.FScene2d.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[fibbojs](../README.md) / [Modules](../modules.md) / [2d/src](../modules/2d_src.md) / FScene2d
[@fibbojs](/api/index) / [2d](/api/modules/2d_src) / FScene2d

# Class: FScene2d

[2d/src](../modules/2d_src.md).FScene2d
[2d](/api/modules/2d_src).FScene2d

**`Description`**

Expand Down Expand Up @@ -58,7 +58,7 @@ FScene.constructor

#### Defined in

packages/2d/src/FScene2d.ts:22
[packages/2d/src/FScene2d.ts:22](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FScene2d.ts#L22)

## Methods

Expand All @@ -82,7 +82,7 @@ FScene.addComponent

#### Defined in

packages/2d/src/FScene2d.ts:27
[packages/2d/src/FScene2d.ts:27](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FScene2d.ts#L27)

## Properties

Expand All @@ -96,7 +96,7 @@ FScene.camera

#### Defined in

packages/core/dist/index.d.ts:28
packages/core/dist/index.d.ts:25

___

Expand All @@ -110,7 +110,7 @@ FScene.components

#### Defined in

packages/2d/src/FScene2d.ts:19
[packages/2d/src/FScene2d.ts:19](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FScene2d.ts#L19)

___

Expand All @@ -132,7 +132,7 @@ FScene.gravity

#### Defined in

packages/core/dist/index.d.ts:29
packages/core/dist/index.d.ts:26

___

Expand All @@ -146,4 +146,4 @@ FScene.world

#### Defined in

packages/2d/src/FScene2d.ts:20
[packages/2d/src/FScene2d.ts:20](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/2d/src/FScene2d.ts#L20)
18 changes: 9 additions & 9 deletions docs/api/classes/3d_src.FAttachedCamera.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[fibbojs](../README.md) / [Modules](../modules.md) / [3d/src](../modules/3d_src.md) / FAttachedCamera
[@fibbojs](/api/index) / [3d](/api/modules/3d_src) / FAttachedCamera

# Class: FAttachedCamera

[3d/src](../modules/3d_src.md).FAttachedCamera
[3d](/api/modules/3d_src).FAttachedCamera

**`Description`**

Expand Down Expand Up @@ -179,7 +179,7 @@ export default class MyAttachedCamera extends FAttachedCamera {

#### Defined in

packages/3d/src/cameras/FAttachedCamera.ts:33
[packages/3d/src/cameras/FAttachedCamera.ts:33](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FAttachedCamera.ts#L33)

## Methods

Expand Down Expand Up @@ -1191,7 +1191,7 @@ ___

#### Defined in

packages/3d/src/cameras/FAttachedCamera.ts:38
[packages/3d/src/cameras/FAttachedCamera.ts:38](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FAttachedCamera.ts#L38)

___

Expand Down Expand Up @@ -1574,7 +1574,7 @@ Set the position of the camera.

#### Defined in

packages/3d/src/cameras/FAttachedCamera.ts:50
[packages/3d/src/cameras/FAttachedCamera.ts:50](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FAttachedCamera.ts#L50)

___

Expand Down Expand Up @@ -1604,7 +1604,7 @@ Set the rotation of the camera.

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:32
[packages/3d/src/cameras/FCamera3d.ts:32](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L32)

___

Expand Down Expand Up @@ -1743,7 +1743,7 @@ Set the scale of the camera.

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:25
[packages/3d/src/cameras/FCamera3d.ts:25](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L25)

___

Expand Down Expand Up @@ -2217,7 +2217,7 @@ ___

#### Defined in

packages/3d/src/cameras/FAttachedCamera.ts:26
[packages/3d/src/cameras/FAttachedCamera.ts:26](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FAttachedCamera.ts#L26)

___

Expand Down Expand Up @@ -2806,7 +2806,7 @@ ___

#### Defined in

packages/3d/src/cameras/FAttachedCamera.ts:28
[packages/3d/src/cameras/FAttachedCamera.ts:28](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FAttachedCamera.ts#L28)

___

Expand Down
14 changes: 7 additions & 7 deletions docs/api/classes/3d_src.FCamera3d.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[fibbojs](../README.md) / [Modules](../modules.md) / [3d/src](../modules/3d_src.md) / FCamera3d
[@fibbojs](/api/index) / [3d](/api/modules/3d_src) / FCamera3d

# Class: FCamera3d

[3d/src](../modules/3d_src.md).FCamera3d
[3d](/api/modules/3d_src).FCamera3d

**`Description`**

Expand Down Expand Up @@ -164,7 +164,7 @@ THREE.PerspectiveCamera.constructor

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:9
[packages/3d/src/cameras/FCamera3d.ts:9](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L9)

## Methods

Expand Down Expand Up @@ -1176,7 +1176,7 @@ FCamera.onFrame

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:13
[packages/3d/src/cameras/FCamera3d.ts:13](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L13)

___

Expand Down Expand Up @@ -1555,7 +1555,7 @@ Set the position of the camera.

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:18
[packages/3d/src/cameras/FCamera3d.ts:18](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L18)

___

Expand All @@ -1581,7 +1581,7 @@ Set the rotation of the camera.

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:32
[packages/3d/src/cameras/FCamera3d.ts:32](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L32)

___

Expand Down Expand Up @@ -1716,7 +1716,7 @@ Set the scale of the camera.

#### Defined in

packages/3d/src/cameras/FCamera3d.ts:25
[packages/3d/src/cameras/FCamera3d.ts:25](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/cameras/FCamera3d.ts#L25)

___

Expand Down
14 changes: 7 additions & 7 deletions docs/api/classes/3d_src.FComponent3d.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[fibbojs](../README.md) / [Modules](../modules.md) / [3d/src](../modules/3d_src.md) / FComponent3d
[@fibbojs](/api/index) / [3d](/api/modules/3d_src) / FComponent3d

# Class: FComponent3d

[3d/src](../modules/3d_src.md).FComponent3d
[3d](/api/modules/3d_src).FComponent3d

**`Description`**

Expand Down Expand Up @@ -41,7 +41,7 @@ The base class for all 2D and 3D components in FibboJS.

#### Defined in

packages/3d/src/FComponent3d.ts:8
[packages/3d/src/FComponent3d.ts:8](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/FComponent3d.ts#L8)

## Methods

Expand All @@ -65,7 +65,7 @@ FComponent.onFrame

#### Defined in

packages/3d/src/FComponent3d.ts:11
[packages/3d/src/FComponent3d.ts:11](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/FComponent3d.ts#L11)

___

Expand All @@ -91,7 +91,7 @@ Set the position of the component.

#### Defined in

packages/3d/src/FComponent3d.ts:16
[packages/3d/src/FComponent3d.ts:16](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/FComponent3d.ts#L16)

___

Expand All @@ -117,7 +117,7 @@ Set the rotation of the component.

#### Defined in

packages/3d/src/FComponent3d.ts:26
[packages/3d/src/FComponent3d.ts:26](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/FComponent3d.ts#L26)

___

Expand All @@ -143,4 +143,4 @@ Set the scale of the component.

#### Defined in

packages/3d/src/FComponent3d.ts:21
[packages/3d/src/FComponent3d.ts:21](https://github.com/fibbojs/fibbo/blob/ccc6e3847dd911058d63a251d216974de127e8af/packages/3d/src/FComponent3d.ts#L21)
Loading

0 comments on commit b3efc33

Please sign in to comment.