Skip to content

Commit b15d2db

Browse files
GugustinetteGugustinette
committed
fix: doc api reference + packages exports
1 parent ca6e10d commit b15d2db

File tree

91 files changed

+4266
-10894
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+4266
-10894
lines changed

‎apps/playground-3d/pages/rainbowls/main.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ import * as THREE from 'three'
5151
const cameraTarget = new FCuboid(scene)
5252
cameraTarget.setPosition({ x: 0, y: 1, z: 0 })
5353
// Create a camera
54-
const camera = new FOrbitCamera(cameraTarget)
54+
const camera = new FOrbitCamera({
55+
target: cameraTarget,
56+
})
5557
camera.setPosition(14, 12, 14)
5658
camera.lookAt(0, 0, 0)
5759
scene.camera = camera

‎docs/.vitepress/config.ts‎

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export default defineConfig({
4444
{ text: 'Cameras', link: '/guide/core/cameras' },
4545
{ text: 'Lights', link: '/guide/core/lights' },
4646
{ text: 'Assets', link: '/guide/core/assets' },
47+
{ text: 'Controllers', link: '/guide/core/controllers' },
4748
] },
4849
{ text: '2D', collapsed: true, items: [
4950
{ text: 'Container', link: '/guide/2d/container' },
@@ -94,12 +95,13 @@ export default defineConfig({
9495
{ text: 'FFixedCamera', link: '/api/3d/classes/FFixedCamera' },
9596
{ text: 'FFreeCamera', link: '/api/3d/classes/FFreeCamera' },
9697
] },
97-
{ text: 'Character Classes', items: [
98-
{ text: 'FCharacter', link: '/api/2d/classes/FCharacter' },
99-
{ text: 'FCharacterDynamic', link: '/api/2d/classes/FCharacterDynamic' },
100-
{ text: 'FCharacterKinematic', link: '/api/2d/classes/FCharacterKinematic' },
101-
{ text: 'FCharacterKP', link: '/api/2d/classes/FCharacterKP' },
102-
{ text: 'FCharacterKV', link: '/api/2d/classes/FCharacterKV' },
98+
{ text: 'Controller Classes', items: [
99+
{ text: 'FController', link: '/api/2d/classes/FController' },
100+
{ text: 'FCharacterController', link: '/api/2d/classes/FCharacterController' },
101+
{ text: 'FCharacterControllerD', link: '/api/2d/classes/FCharacterControllerD' },
102+
{ text: 'FCharacterControllerK', link: '/api/2d/classes/FCharacterControllerK' },
103+
{ text: 'FCharacterControllerKP', link: '/api/2d/classes/FCharacterControllerKP' },
104+
{ text: 'FCharacterControllerKV', link: '/api/2d/classes/FCharacterControllerKV' },
103105
] },
104106
{ text: 'Core Classes', items: [
105107
{ text: 'FComponent', link: '/api/2d/classes/FComponent' },
@@ -108,6 +110,7 @@ export default defineConfig({
108110
{ text: 'FTransform', link: '/api/2d/classes/FTransform' },
109111
] },
110112
{ text: 'Polygons Classes', items: [
113+
{ text: 'FPolygon', link: '/api/2d/classes/FPolygon' },
111114
{ text: 'FCircle', link: '/api/2d/classes/FCircle' },
112115
{ text: 'FRectangle', link: '/api/2d/classes/FRectangle' },
113116
] },
@@ -119,9 +122,10 @@ export default defineConfig({
119122
] },
120123
{ text: 'Interfaces', items: [
121124
{ text: 'FCameraOptions', link: '/api/2d/interfaces/FCameraOptions' },
122-
{ text: 'FCharacterOptions', link: '/api/2d/interfaces/FCharacterOptions' },
123-
{ text: 'FComponentOptions', link: '/api/2d/interfaces/FComponentOptions' },
125+
{ text: 'FCharacterControllerOptions', link: '/api/2d/interfaces/FCharacterControllerOptions' },
124126
{ text: 'FColliderOptions', link: '/api/2d/interfaces/FColliderOptions' },
127+
{ text: 'FComponentOptions', link: '/api/2d/interfaces/FComponentOptions' },
128+
{ text: 'FControllerOptions', link: '/api/2d/interfaces/FControllerOptions' },
125129
{ text: 'FRigidBodyOptions', link: '/api/2d/interfaces/FRigidBodyOptions' },
126130
{ text: 'FSceneOptions', link: '/api/2d/interfaces/FSceneOptions' },
127131
{ text: 'FTransformOptions', link: '/api/2d/interfaces/FTransformOptions' },
@@ -136,42 +140,58 @@ export default defineConfig({
136140
{ text: 'FOrbitCamera', link: '/api/3d/classes/FOrbitCamera' },
137141
] },
138142
{ text: 'Character Classes', items: [
139-
{ text: 'FCharacter', link: '/api/3d/classes/FCharacter' },
140-
{ text: 'FCharacterDynamic', link: '/api/3d/classes/FCharacterDynamic' },
141-
{ text: 'FCharacterKinematic', link: '/api/3d/classes/FCharacterKinematic' },
142-
{ text: 'FCharacterKP', link: '/api/3d/classes/FCharacterKP' },
143-
{ text: 'FCharacterKV', link: '/api/3d/classes/FCharacterKV' },
143+
{ text: 'FController', link: '/api/3d/classes/FController' },
144+
{ text: 'FCharacterController', link: '/api/3d/classes/FCharacterController' },
145+
{ text: 'FCharacterControllerD', link: '/api/3d/classes/FCharacterControllerD' },
146+
{ text: 'FCharacterControllerK', link: '/api/3d/classes/FCharacterControllerK' },
147+
{ text: 'FCharacterControllerKP', link: '/api/3d/classes/FCharacterControllerKP' },
148+
{ text: 'FCharacterControllerKV', link: '/api/3d/classes/FCharacterControllerKV' },
144149
] },
145150
{ text: 'Core Classes', items: [
146151
{ text: 'FComponent', link: '/api/3d/classes/FComponent' },
147152
{ text: 'FComponentEmpty', link: '/api/3d/classes/FComponentEmpty' },
148153
{ text: 'FScene', link: '/api/3d/classes/FScene' },
149154
{ text: 'FTransform', link: '/api/3d/classes/FTransform' },
150155
] },
151-
{ text: 'Model Classes', items: [
156+
{ text: 'Polyhedrons Classes', items: [
152157
{ text: 'FCapsule', link: '/api/3d/classes/FCapsule' },
153158
{ text: 'FCuboid', link: '/api/3d/classes/FCuboid' },
154-
{ text: 'FGLTF', link: '/api/3d/classes/FGLTF' },
155159
{ text: 'FPolyhedron', link: '/api/3d/classes/FPolyhedron' },
156160
{ text: 'FSphere', link: '/api/3d/classes/FSphere' },
157161
] },
162+
{ text: 'Model Classes', items: [
163+
{ text: 'FModel', link: '/api/3d/classes/FModel' },
164+
{ text: 'FGLTF', link: '/api/3d/classes/FGLTF' },
165+
{ text: 'FGLB', link: '/api/3d/classes/FGLB' },
166+
{ text: 'FOBJ', link: '/api/3d/classes/FOBJ' },
167+
{ text: 'FFBX', link: '/api/3d/classes/FFBX' },
168+
] },
158169
{ text: 'Enumerations', items: [
159170
{ text: 'FShapes', link: '/api/3d/enumerations/FShapes' },
160171
] },
161172
{ text: 'Interfaces', items: [
162-
{ text: 'FCharacterOptions', link: '/api/3d/interfaces/FCharacterOptions' },
163-
{ text: 'FComponentOptions', link: '/api/3d/interfaces/FComponentOptions' },
173+
{ text: 'FAttachedCameraOptions', link: '/api/3d/interfaces/FAttachedCameraOptions' },
174+
{ text: 'FCameraOptions', link: '/api/3d/interfaces/FCameraOptions' },
175+
{ text: 'FCharacterControllerOptions', link: '/api/3d/interfaces/FCharacterControllerOptions' },
164176
{ text: 'FColliderOptions', link: '/api/3d/interfaces/FColliderOptions' },
177+
{ text: 'FComponentOptions', link: '/api/3d/interfaces/FComponentOptions' },
178+
{ text: 'FControllerOptions', link: '/api/3d/interfaces/FControllerOptions' },
165179
{ text: 'FRigidBodyOptions', link: '/api/3d/interfaces/FRigidBodyOptions' },
166180
{ text: 'FSceneOptions', link: '/api/3d/interfaces/FSceneOptions' },
167181
{ text: 'FTransformOptions', link: '/api/3d/interfaces/FTransformOptions' },
168182
] },
169183
] },
170184
{ text: 'core', link: '/api/core/index.md', collapsed: true, items: [
171-
{ text: 'FCamera', link: '/api/core/classes/FCamera' },
172-
{ text: 'FComponent', link: '/api/core/classes/FComponent' },
173-
{ text: 'FGroup', link: '/api/core/classes/FGroup' },
174-
{ text: 'FScene', link: '/api/core/classes/FScene' },
185+
{ text: 'Core Classes', items: [
186+
{ text: 'FCamera', link: '/api/core/classes/FCamera' },
187+
{ text: 'FComponent', link: '/api/core/classes/FComponent' },
188+
{ text: 'FController', link: '/api/core/classes/FController' },
189+
{ text: 'FGroup', link: '/api/core/classes/FGroup' },
190+
{ text: 'FScene', link: '/api/core/classes/FScene' },
191+
] },
192+
{ text: 'Interfaces', items: [
193+
{ text: 'FControllerOptions', link: '/api/core/interfaces/FControllerOptions' },
194+
] },
175195
] },
176196
{ text: 'devtools', link: '/api/devtools/index.md', collapsed: true, items: [
177197
{ text: 'FDebug', link: '/api/devtools/classes/FDebug' },

‎docs/api/2d/classes/FAttachedCamera.md‎

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A camera attached to a given target.
3232

3333
#### Defined in
3434

35-
[packages/2d/src/cameras/FAttachedCamera.ts:20](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FAttachedCamera.ts#L20)
35+
[packages/2d/src/cameras/FAttachedCamera.ts:20](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FAttachedCamera.ts#L20)
3636

3737
## Methods
3838

@@ -50,7 +50,7 @@ A camera attached to a given target.
5050

5151
#### Defined in
5252

53-
[packages/2d/src/cameras/FAttachedCamera.ts:33](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FAttachedCamera.ts#L33)
53+
[packages/2d/src/cameras/FAttachedCamera.ts:33](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FAttachedCamera.ts#L33)
5454

5555
***
5656

@@ -92,7 +92,7 @@ player.emitCollisionWith(enemy)
9292

9393
#### Defined in
9494

95-
packages/core/dist/index.d.ts:70
95+
packages/core/dist/index.d.ts:100
9696

9797
***
9898

@@ -142,7 +142,7 @@ player.onCollisionWith(enemy, () => {
142142

143143
#### Defined in
144144

145-
packages/core/dist/index.d.ts:53
145+
packages/core/dist/index.d.ts:83
146146

147147
***
148148

@@ -160,16 +160,17 @@ packages/core/dist/index.d.ts:53
160160

161161
#### Description
162162

163-
Update the component.
164-
Should be called every frame.
163+
Update the component. Should be called every frame.
164+
The purpose of `onFrame` on FComponent is really to render the component, its mesh/sprite and its properties.
165+
Any changes on its transform should be done on the controller, not here.
165166

166167
#### Overrides
167168

168169
[`FCamera`](FCamera.md).[`onFrame`](FCamera.md#onframe)
169170

170171
#### Defined in
171172

172-
[packages/2d/src/cameras/FAttachedCamera.ts:25](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FAttachedCamera.ts#L25)
173+
[packages/2d/src/cameras/FAttachedCamera.ts:25](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FAttachedCamera.ts#L25)
173174

174175
## Properties
175176

@@ -192,7 +193,7 @@ It is a dictionary where the key is the class name or object id and the value is
192193

193194
#### Defined in
194195

195-
packages/core/dist/index.d.ts:22
196+
packages/core/dist/index.d.ts:47
196197

197198
***
198199

@@ -211,7 +212,7 @@ It is generated automatically.
211212

212213
#### Defined in
213214

214-
packages/core/dist/index.d.ts:17
215+
packages/core/dist/index.d.ts:42
215216

216217
***
217218

@@ -227,7 +228,7 @@ Internal flags
227228

228229
#### Defined in
229230

230-
[packages/2d/src/cameras/FCamera.ts:17](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FCamera.ts#L17)
231+
[packages/2d/src/cameras/FCamera.ts:16](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FCamera.ts#L16)
231232

232233
***
233234

@@ -243,23 +244,47 @@ Internal flags
243244

244245
#### Defined in
245246

246-
packages/core/dist/index.d.ts:11
247+
packages/core/dist/index.d.ts:36
248+
249+
***
250+
251+
### controller?
252+
253+
> `optional` **controller**: `FController`
254+
255+
The controller attached to the component.
256+
257+
#### Inherited from
258+
259+
[`FCamera`](FCamera.md).[`controller`](FCamera.md#controller)
260+
261+
#### Defined in
262+
263+
packages/core/dist/index.d.ts:53
247264

248265
***
249266

250267
### position
251268

252-
> **position**: `PointData`
269+
> **position**: `object`
253270
254271
Position of the camera.
255272

273+
#### x
274+
275+
> **x**: `number`
276+
277+
#### y
278+
279+
> **y**: `number`
280+
256281
#### Inherited from
257282

258283
[`FCamera`](FCamera.md).[`position`](FCamera.md#position)
259284

260285
#### Defined in
261286

262-
[packages/2d/src/cameras/FCamera.ts:28](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FCamera.ts#L28)
287+
[packages/2d/src/cameras/FCamera.ts:27](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FCamera.ts#L27)
263288

264289
***
265290

@@ -277,7 +302,7 @@ The scene the camera is in.
277302

278303
#### Defined in
279304

280-
[packages/2d/src/cameras/FCamera.ts:22](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FCamera.ts#L22)
305+
[packages/2d/src/cameras/FCamera.ts:21](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FCamera.ts#L21)
281306

282307
***
283308

@@ -291,4 +316,4 @@ The target to follow.
291316

292317
#### Defined in
293318

294-
[packages/2d/src/cameras/FAttachedCamera.ts:18](https://github.com/fibbojs/fibbo/blob/ebbfce6158465f6309c7f36dadb4e328deefcf24/packages/2d/src/cameras/FAttachedCamera.ts#L18)
319+
[packages/2d/src/cameras/FAttachedCamera.ts:18](https://github.com/fibbojs/fibbo/blob/ca6e10de1cfed8b8d44a28a82c206333ede11c84/packages/2d/src/cameras/FAttachedCamera.ts#L18)

0 commit comments

Comments
 (0)