Skip to content

Commit

Permalink
Improve API, code quality and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gugustinette committed Aug 1, 2024
1 parent 3bfecee commit 86cb287
Show file tree
Hide file tree
Showing 37 changed files with 495 additions and 647 deletions.
13 changes: 0 additions & 13 deletions apps/playground-3d/src/cameras/MyAttachedCamera.ts

This file was deleted.

13 changes: 0 additions & 13 deletions apps/playground-3d/src/cameras/MyCamera.ts

This file was deleted.

13 changes: 0 additions & 13 deletions apps/playground-3d/src/cameras/MyGameCamera.ts

This file was deleted.

12 changes: 0 additions & 12 deletions apps/playground-3d/src/cameras/MyOrbitCamera.ts

This file was deleted.

63 changes: 10 additions & 53 deletions apps/playground-3d/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,68 +1,25 @@
import './style.css'
import { FCube, FScene3d } from '@fibbojs/3d'
import MyCube from './classes/MyCube'
import MySphere from './classes/MySphere'
import Duck from './classes/Duck'
import GltfCube from './classes/GltfCube'
import MyGameCamera from './cameras/MyGameCamera'
import { FCube, FGameCamera, FScene3d } from '@fibbojs/3d'

(async () => {
const scene = new FScene3d({ debug: true })
scene.init()
// Initialize the scene
const scene = new FScene3d()
await scene.init()
await scene.initPhysics()

// Create a ground
const ground = new FCube(scene)
ground.setScale(15, 0.1, 15)
ground.setPosition(0, -0.1, 0)
ground.initCollider()
ground.setColor(0x1F1F1F)
scene.addComponent(ground)

const cube = new MyCube(scene)
// Create a cube
const cube = new FCube(scene)
cube.initRigidBody()
scene.addComponent(cube)

const sphere = new MySphere(scene)
scene.addComponent(sphere)

const duck = new Duck(scene)
scene.addComponent(duck)

const gltfCube = new GltfCube(scene)
scene.addComponent(gltfCube)

// Create 8 cubes dynamically in circle from 0 to 2PI
for (let i = 0; i < 8; i++) {
const angle = i * Math.PI / 4
const x = Math.cos(angle) * 4
const z = Math.sin(angle) * 4
const cube = new FCube(scene)
cube.setPosition(x, 1, z)
cube.initRigidBody()
scene.addComponent(cube)
}

scene.camera = new MyGameCamera(gltfCube, scene)

// Detect inputs to move the cube
document.addEventListener('keydown', (event) => {
const impulse = { x: 0, y: 0, z: 0 }
switch (event.key) {
case 'ArrowUp':
impulse.z = -1
break
case 'ArrowDown':
impulse.z = 1
break
case 'ArrowLeft':
impulse.x = -1
break
case 'ArrowRight':
impulse.x = 1
break
case ' ':
gltfCube.rigidBody?.applyImpulse({ x: 0, y: 5, z: 0 }, true)
break
}
gltfCube.rigidBody?.applyImpulse(impulse, true)
})
// Attach a camera to the cube
scene.camera = new FGameCamera(cube, scene)
})()
40 changes: 20 additions & 20 deletions docs/api/2d/classes/FCircle.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Description

A simple square in FibboJS.
A simple circle in FibboJS.

## Example

Expand All @@ -13,8 +13,8 @@ import { FScene2d, FCircle } from '@fibbojs/2d'

const scene = new FScene2d()

const square = new FCircle(scene)
scene.addComponent(square)
const circle = new FCircle(scene)
scene.addComponent(circle)
```

## Extends
Expand All @@ -41,7 +41,7 @@ scene.addComponent(square)

#### Defined in

[packages/2d/src/polygons/FCircle.ts:20](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L20)
[packages/2d/src/polygons/FCircle.ts:20](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/polygons/FCircle.ts#L20)

## Methods

Expand All @@ -63,7 +63,7 @@ The scale of the collider.

The rotation of the collider.

**shape?**: [`F2dShapes`](../enumerations/F2dShapes.md)
**shape?**: [`F2dShapes`](../enumerations/F2dShapes.md) = `F2dShapes.CIRCLE`

The shape of the collider.

Expand Down Expand Up @@ -93,7 +93,7 @@ component.initCollider(

#### Defined in

[packages/2d/src/polygons/FCircle.ts:43](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L43)
[packages/2d/src/polygons/FCircle.ts:41](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/polygons/FCircle.ts#L41)

***

Expand All @@ -115,7 +115,7 @@ The scale of the rigid body.

The rotation of the rigid body.

**shape?**: [`F2dShapes`](../enumerations/F2dShapes.md)
**shape?**: [`F2dShapes`](../enumerations/F2dShapes.md) = `F2dShapes.CIRCLE`

The shape of the rigid body.

Expand Down Expand Up @@ -143,7 +143,7 @@ component.initRigidBody(

#### Defined in

[packages/2d/src/polygons/FCircle.ts:32](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L32)
[packages/2d/src/polygons/FCircle.ts:32](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/polygons/FCircle.ts#L32)

***

Expand All @@ -170,7 +170,7 @@ Should be called every frame.

#### Defined in

[packages/2d/src/polygons/FCircle.ts:28](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L28)
[packages/2d/src/polygons/FCircle.ts:28](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/polygons/FCircle.ts#L28)

***

Expand Down Expand Up @@ -208,7 +208,7 @@ component.setPosition(0, 0)

#### Defined in

[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L100)
[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L100)

***

Expand Down Expand Up @@ -242,7 +242,7 @@ component.setRotation(Math.PI / 2)

#### Defined in

[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L131)
[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L131)

***

Expand Down Expand Up @@ -276,7 +276,7 @@ component.setRotationDegree(90)

#### Defined in

[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L144)
[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L144)

***

Expand Down Expand Up @@ -314,7 +314,7 @@ component.setScale(1, 1)

#### Defined in

[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L114)
[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L114)

## Properties

Expand All @@ -330,7 +330,7 @@ RAPIER Collider

#### Defined in

[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L46)
[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L46)

***

Expand All @@ -346,7 +346,7 @@ PIXI container

#### Defined in

[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L22)
[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L22)

***

Expand All @@ -362,7 +362,7 @@ Position of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L28)
[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L28)

***

Expand All @@ -378,7 +378,7 @@ RAPIER RigidBody

#### Defined in

[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L42)
[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L42)

***

Expand All @@ -394,7 +394,7 @@ Rotation of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L36)
[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L36)

***

Expand All @@ -410,7 +410,7 @@ Scale of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L32)
[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L32)

***

Expand All @@ -426,4 +426,4 @@ The scene which the component is in.

#### Defined in

[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L17)
[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/3bfecee9c2a4f3f6d193d8bfdda5d3ae6585b4f9/packages/2d/src/FComponent2d.ts#L17)
Loading

0 comments on commit 86cb287

Please sign in to comment.