Class: abstract FModel
An abstract 3D Model base class.
Extends
Extended by
Constructors
new FModel()
new FModel(
options):FModel
Parameters
• options: FModelOptions
The options for the component (inherits from FComponent).
Returns
Overrides
Defined in
Methods
__SET_POSITION__()
__SET_POSITION__(
position):void
Parameters
• position: FVector3
Returns
void
Inherited from
Defined in
__SET_ROTATION__()
__SET_ROTATION__(
rotation):void
Parameters
• rotation: FVector3
Returns
void
Inherited from
Defined in
__SET_SCALE__()
__SET_SCALE__(
scale):void
Parameters
• scale: FVector3
Returns
void
Inherited from
Defined in
__UPDATE_POSITION__()
__UPDATE_POSITION__(
initiator):void
Update the position of the component according to the transform. This method should be called after updating the transform properties.
Parameters
• initiator: boolean = false
By default (false), the component won't be considered as the initiator of the position update. Set this to true to propagate the position update to the rigidBody, collider and sensor.
Returns
void
Inherited from
FComponent.__UPDATE_POSITION__
Defined in
__UPDATE_ROTATION__()
__UPDATE_ROTATION__(
initiator):void
Update the rotation of the component according to the transform. This method should be called after updating the transform properties.
Parameters
• initiator: boolean = false
By default (false), the component won't be considered as the initiator of the rotation update. Set this to true to propagate the rotation update to the rigidBody, collider and sensor.
Returns
void
Inherited from
FComponent.__UPDATE_ROTATION__
Defined in
__UPDATE_SCALE__()
__UPDATE_SCALE__(
initiator):void
Update the scale of the component according to the transform. This method should be called after updating the transform properties.
Parameters
• initiator: boolean = false
By default (false), the component won't be considered as the initiator of the scale update. Set this to true to propagate the scale update to the rigidBody, collider and sensor.
Returns
void
Inherited from
Defined in
addController()
addController(
controller):void
Add a controller to the component.
Parameters
• controller: FController
The controller to add.
Returns
void
Inherited from
Defined in
core/dist/index.d.ts:418
defineMeshTransforms()
defineMeshTransforms():
void
Define mesh transforms (used after loading the model).
Returns
void
Defined in
emitCollisionWith()
emitCollisionWith(
options):void
Emit a collision event with a given class or object.
Parameters
• options
The options for the collision event.
• options.class?: any
The class to emit the collision event with.
• options.component?: FComponent
The component to emit the collision event with.
Returns
void
Examples
const player = new Player()
const enemy = new Enemy()
player.emitCollisionWith({
class: Enemy
})const player = new Player()
const enemy = new Enemy()
player.emitCollisionWith({
object: enemy
})Inherited from
Defined in
core/dist/index.d.ts:499
emitOnLoaded()
emitOnLoaded():
void
Emit the onLoaded callbacks. It was overridden to add shadow support.
Returns
void
Overrides
Defined in
frame()
frame(
delta):void
Update the component. Should be called every frame. The purpose of this method is to render the component, its mesh/sprite, and its properties.
Parameters
• delta: number
The time since the last frame.
Returns
void
Inherited from
Defined in
initCollider()
initCollider(
options?):void
Parameters
• options?: FColliderOptions
Returns
void
Inherited from
Defined in
initRigidBody()
initRigidBody(
options?):void
Parameters
• options?: FRigidBodyOptions
Returns
void
Inherited from
Defined in
initSensor()
initSensor(
options?):void
Parameters
• options?: FRigidBodyOptions
Returns
void
Inherited from
Defined in
loadTextureForMesh()
loadTextureForMesh(
mesh):void
Load the texture for a given mesh.
Parameters
• mesh: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
The mesh to load the texture for.
Returns
void
Example
model.loadTextureFor(mesh)Defined in
onCollisionWith()
onCollisionWith(
classOrObject,callback): () =>void
Add a callback to be called when a collision occurs.
Parameters
• classOrObject: any
The class or object to observe for collisions. Should inherit from FComponent.
• callback
The callback to add to the collision event.
Returns
Function
A function to remove the callback.
Returns
void
Examples
const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(Enemy, ({ component }) => {
console.log('Player collided with an Enemy!')
console.log('The enemy is:', component)
})const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(enemy, () => {
console.log('Player collided with the enemy!')
})const player = new Player()
const enemy = new Enemy()
const removeThisCallback = player.onCollisionWith(enemy, () => {
console.log('Player collided with the enemy!')
})
// To remove the callback, call the function returned by onCollisionWith
removeThisCallback()
#### Inherited from
[`FComponent`](FComponent.md).[`onCollisionWith`](FComponent.md#oncollisionwith)
#### Defined in
[3d/src/core/FComponent.ts:318](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L318)
***
### onFrame()
> **onFrame**(`callback`): `void`
Add a callback to be called every frame.
#### Parameters
• **callback**
The callback function.
#### Returns
`void`
#### Inherited from
[`FComponent`](FComponent.md).[`onFrame`](FComponent.md#onframe)
#### Defined in
core/dist/index.d.ts:434
***
### onLoaded()
> **onLoaded**(`callback`): `void`
Add a callback to be called when the component is loaded (could be a texture, a 3D model, etc).
#### Parameters
• **callback**
The callback function.
#### Returns
`void`
#### Inherited from
[`FComponent`](FComponent.md).[`onLoaded`](FComponent.md#onloaded)
#### Defined in
core/dist/index.d.ts:439
***
### removeController()
> **removeController**(`controller`): `void`
Remove a controller from the component.
#### Parameters
• **controller**: `FController`
The controller to remove.
#### Returns
`void`
#### Inherited from
[`FComponent`](FComponent.md).[`removeController`](FComponent.md#removecontroller)
#### Defined in
core/dist/index.d.ts:423
***
### render()
> **render**(`delta`): `void`
#### Parameters
• **delta**: `number`
#### Returns
`void`
#### Inherited from
[`FComponent`](FComponent.md).[`render`](FComponent.md#render)
#### Defined in
[3d/src/core/FComponent.ts:114](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L114)
## Properties
### \_\_CALLBACKS\_ON\_COLLISION\_\_
> **\_\_CALLBACKS\_ON\_COLLISION\_\_**: `object`
Callbacks for when a collision occurs with a given class or object.
It is a dictionary where the key is the class name or object id and the value is an array of callbacks.
#### Index Signature
\[`key`: `string`\]: (`data`) => `void`[]
#### Inherited from
[`FComponent`](FComponent.md).[`__CALLBACKS_ON_COLLISION__`](FComponent.md#__callbacks_on_collision__)
#### Defined in
core/dist/index.d.ts:402
***
### \_\_CALLBACKS\_ON\_FRAME\_\_
> **\_\_CALLBACKS\_ON\_FRAME\_\_**: () => `void`[]
Callbacks for when a frame is rendered.
#### Inherited from
[`FComponent`](FComponent.md).[`__CALLBACKS_ON_FRAME__`](FComponent.md#__callbacks_on_frame__)
#### Defined in
core/dist/index.d.ts:393
***
### \_\_CALLBACKS\_ON\_LOADED\_\_
> **\_\_CALLBACKS\_ON\_LOADED\_\_**: () => `void`[]
Callbacks for when the component is loaded (could be a texture, a 3D model, etc).
#### Inherited from
[`FComponent`](FComponent.md).[`__CALLBACKS_ON_LOADED__`](FComponent.md#__callbacks_on_loaded__)
#### Defined in
core/dist/index.d.ts:397
***
### \_\_ID\_\_
> **\_\_ID\_\_**: `number`
Unique identifier for the component.
It is generated automatically.
#### Inherited from
[`FComponent`](FComponent.md).[`__ID__`](FComponent.md#__id__)
#### Defined in
core/dist/index.d.ts:389
***
### \_\_IS\_2D\_\_
> **\_\_IS\_2D\_\_**: `boolean`
#### Inherited from
[`FComponent`](FComponent.md).[`__IS_2D__`](FComponent.md#__is_2d__)
#### Defined in
core/dist/index.d.ts:384
***
### \_\_IS\_3D\_\_
> **\_\_IS\_3D\_\_**: `boolean` = `true`
Internal flags
#### Inherited from
[`FComponent`](FComponent.md).[`__IS_3D__`](FComponent.md#__is_3d__)
#### Defined in
[3d/src/core/FComponent.ts:30](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L30)
***
### \_\_MESH\_\_?
> `optional` **\_\_MESH\_\_**: `Mesh`\<`BufferGeometry`\<`NormalBufferAttributes`\>, `Material` \| `Material`[], `Object3DEventMap`\> \| `Group`\<`Object3DEventMap`\>
Mesh
#### Inherited from
[`FComponent`](FComponent.md).[`__MESH__`](FComponent.md#__mesh__)
#### Defined in
[3d/src/core/FComponent.ts:43](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L43)
***
### collider?
> `optional` **collider**: [`FCollider`](FCollider.md)
Collider
#### Inherited from
[`FComponent`](FComponent.md).[`collider`](FComponent.md#collider)
#### Defined in
[3d/src/core/FComponent.ts:58](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L58)
***
### controllers
> **controllers**: [`FController`](FController.md)[]
The controllers attached to the component.
#### Inherited from
[`FComponent`](FComponent.md).[`controllers`](FComponent.md#controllers)
#### Defined in
[3d/src/core/FComponent.ts:38](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L38)
***
### fileExtension
> **fileExtension**: `string`
The file extension of the model.
Default is 'obj'.
#### Defined in
[3d/src/model/FModel.ts:47](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/model/FModel.ts#L47)
***
### name
> **name**: `string`
The name of the model.
Shouldn't contain file extensions.
#### Defined in
[3d/src/model/FModel.ts:22](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/model/FModel.ts#L22)
***
### path
> **path**: `string`
The path to the model file.
Will be interpreted as a URL if it starts with http.
Will be interpreted as an absolute path if it starts with /.
Otherwise, it will be treated as a relative path to the models folder.
#### Defined in
[3d/src/model/FModel.ts:30](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/model/FModel.ts#L30)
***
### rigidBody?
> `optional` **rigidBody**: [`FRigidBody`](FRigidBody.md)
RigidBody
#### Inherited from
[`FComponent`](FComponent.md).[`rigidBody`](FComponent.md#rigidbody)
#### Defined in
[3d/src/core/FComponent.ts:54](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L54)
***
### scene
> **scene**: [`FScene`](FScene.md)
The scene the component is attached to.
#### Inherited from
[`FComponent`](FComponent.md).[`scene`](FComponent.md#scene)
#### Defined in
[3d/src/core/FComponent.ts:34](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L34)
***
### sensor?
> `optional` **sensor**: [`FRigidBody`](FRigidBody.md)
Sensor (a collider that doesn't collide with other colliders, but still triggers events)
#### Inherited from
[`FComponent`](FComponent.md).[`sensor`](FComponent.md#sensor)
#### Defined in
[3d/src/core/FComponent.ts:62](https://github.com/fibbojs/fibbo/blob/65626b456ab47d7e61b23a8dd1be9f399238b0f1/packages/3d/src/core/FComponent.ts#L62)
***
### textures
> **textures**: `Record`\<`string`, `string`\>
A record containing texture path for each material.
#### Example
```json
{
"default": "/models/my-model/my-model.png"
}Defined in
transform
transform:
FTransform
Transforms