Class: FScene
A scene which contains the components, the Pixi.js scene and the Rapier world.
Example
import { FRectangle, FScene } from '@fibbojs/2d'
(async () => {
const scene = new FScene()
await scene.init()
await scene.initPhysics()
const square = new FRectangle()
square.initRigidBody()
})()Extends
FScene
Accessors
camera
getcamera():FCamera
Getter for the camera.
setcamera(camera):void
Setter for the camera. This is required so when the camera is set, its method to defined the viewport behavior is called.
Parameters
• camera: FCamera
Returns
Overrides
FSceneCore.camera
Defined in
Constructors
new FScene()
new FScene(
options?):FScene
Parameters
• options?: FSceneOptions
Returns
Overrides
FSceneCore.constructor
Defined in
Methods
addCollider()
addCollider(
collider):void
Parameters
• collider: FCollider
Returns
void
Defined in
addComponent()
addComponent(
component):void
Add a component to the scene.
Parameters
• component: FComponent
Returns
void
Overrides
FSceneCore.addComponent
Defined in
addHandle()
addHandle(
handle,component):void
Parameters
• handle: number
• component: FComponent
Returns
void
Defined in
addLight()
addLight(
light):void
Add a light to the scene.
Parameters
• light: FLight
Returns
void
Overrides
FSceneCore.addLight
Defined in
addRigidBody()
addRigidBody(
rigidBody):void
Parameters
• rigidBody: FRigidBody
Returns
void
Defined in
frame()
frame(
delta):void
Compute a frame with the given delta time. By default, it is called every frame in the main pipeline, but this behavior can be changed by giving the autoLoop option as false when creating the scene.
Parameters
• delta: number
The time in seconds since the last frame.
Returns
void
Inherited from
FSceneCore.frame
Defined in
core/dist/index.d.ts:307
handleCollision()
handleCollision(
handle1,handle2,start):void
Handle a collision event between two colliders.
Parameters
• handle1: number
The handle of the first collider
• handle2: number
The handle of the second collider
• start: boolean
If the collision has started or ended
Returns
void
Defined in
init()
init():
Promise<void>
Initialize the scene. The application will create a renderer using WebGL, if possible, with a fallback to a canvas render. It will also setup the ticker and the root stage PIXI.Container.
Returns
Promise<void>
Overrides
FSceneCore.init
Defined in
initPhysics()
initPhysics():
Promise<void>
Initialize the physics world.
Returns
Promise<void>
Overrides
FSceneCore.initPhysics
Defined in
onComponentAdded()
onComponentAdded(
callback):void
Add a callback to be called when a component is added to the scene.
Parameters
• callback
Returns
void
Inherited from
FSceneCore.onComponentAdded
Defined in
core/dist/index.d.ts:323
onComponentRemoved()
onComponentRemoved(
callback):void
Add a callback to be called when a component is removed from the scene.
Parameters
• callback
Returns
void
Inherited from
FSceneCore.onComponentRemoved
Defined in
core/dist/index.d.ts:327
onFrame()
onFrame(
callback):void
Add a callback to be called when a frame is rendered.
Parameters
• callback
Returns
void
Inherited from
FSceneCore.onFrame
Defined in
core/dist/index.d.ts:311
onLightAdded()
onLightAdded(
callback):void
Add a callback to be called when a light is added to the scene.
Parameters
• callback
Returns
void
Inherited from
FSceneCore.onLightAdded
Defined in
core/dist/index.d.ts:339
onLightRemoved()
onLightRemoved(
callback):void
Add a callback to be called when a light is removed from the scene.
Parameters
• callback
Returns
void
Inherited from
FSceneCore.onLightRemoved
Defined in
core/dist/index.d.ts:343
onReady()
onReady(
callback):void
Add a callback to be called when the scene is ready. The scene is ready when the init method has finished.
Parameters
• callback
Returns
void
Inherited from
FSceneCore.onReady
Defined in
core/dist/index.d.ts:348
removeCollider()
removeCollider(
collider):void
Parameters
• collider: FCollider
Returns
void
Defined in
removeComponent()
removeComponent(
component):void
Remove a component from the scene.
Parameters
• component: FComponent
Returns
void
Overrides
FSceneCore.removeComponent
Defined in
removeHandle()
removeHandle(
handle):void
Parameters
• handle: number
Returns
void
Defined in
removeLight()
removeLight(
light):void
Remove a light from the scene.
Parameters
• light: FLight
Returns
void
Overrides
FSceneCore.removeLight
Defined in
removeRigidBody()
removeRigidBody(
rigidBody):void
Parameters
• rigidBody: FRigidBody
Returns
void
Defined in
Properties
PIXI
PIXI:
__module
Defined in
__CALLBACKS_ON_COMPONENT_ADDED__
__CALLBACKS_ON_COMPONENT_ADDED__: (
component) =>void[]
Callbacks for when a component is added to the scene.
Inherited from
FSceneCore.__CALLBACKS_ON_COMPONENT_ADDED__
Defined in
core/dist/index.d.ts:276
__CALLBACKS_ON_COMPONENT_REMOVED__
__CALLBACKS_ON_COMPONENT_REMOVED__: (
component) =>void[]
Callbacks for when a component is removed from the scene.
Inherited from
FSceneCore.__CALLBACKS_ON_COMPONENT_REMOVED__
Defined in
core/dist/index.d.ts:280
__CALLBACKS_ON_FRAME__
__CALLBACKS_ON_FRAME__: (
delta) =>void[]
Callbacks for when a frame is rendered.
Inherited from
FSceneCore.__CALLBACKS_ON_FRAME__
Defined in
core/dist/index.d.ts:272
__CALLBACKS_ON_LIGHT_ADDED__
__CALLBACKS_ON_LIGHT_ADDED__: (
light) =>void[]
Callbacks for when a light is added to the scene.
Inherited from
FSceneCore.__CALLBACKS_ON_LIGHT_ADDED__
Defined in
core/dist/index.d.ts:288
__CALLBACKS_ON_LIGHT_REMOVED__
__CALLBACKS_ON_LIGHT_REMOVED__: (
light) =>void[]
Callbacks for when a light is removed from the scene.
Inherited from
FSceneCore.__CALLBACKS_ON_LIGHT_REMOVED__
Defined in
core/dist/index.d.ts:292
__CALLBACKS_ON_READY__
__CALLBACKS_ON_READY__: () =>
void[]
Callbacks for when the scene is ready.
Inherited from
FSceneCore.__CALLBACKS_ON_READY__
Defined in
core/dist/index.d.ts:284
__CAMERA__
__CAMERA__:
FCamera
The camera of the scene.
Overrides
FSceneCore.__CAMERA__
Defined in
__DOM_NODE__
__DOM_NODE__:
HTMLElement
DOM element that the renderer will be appended to
Inherited from
FSceneCore.__DOM_NODE__
Defined in
core/dist/index.d.ts:241
__IS_2D__
__IS_2D__:
boolean=true
Internal flags
Overrides
FSceneCore.__IS_2D__
Defined in
__IS_3D__
__IS_3D__:
boolean
Inherited from
FSceneCore.__IS_3D__
Defined in
core/dist/index.d.ts:226
__PHYSIC_CONTROLLERS__
__PHYSIC_CONTROLLERS__:
FController[]
Controllers that will run in the physic pipeline.
Inherited from
FSceneCore.__PHYSIC_CONTROLLERS__
Defined in
core/dist/index.d.ts:257
__PHYSIC_FRAME_RATE__
__PHYSIC_FRAME_RATE__:
number
Physic frame rate. It is stored here as the initialisation of the physics pipeline is handled by child classes.
Inherited from
FSceneCore.__PHYSIC_FRAME_RATE__
Defined in
core/dist/index.d.ts:237
__PIPELINE_MANAGER__
__PIPELINE_MANAGER__:
PipelineManager
Pipeline manager that manages the pipelines of the scene. By default, it contains the main pipeline.
Inherited from
FSceneCore.__PIPELINE_MANAGER__
Defined in
core/dist/index.d.ts:232
__RAPIER_TO_COMPONENT__
__RAPIER_TO_COMPONENT__:
Map<number,FComponent>
Overrides
FSceneCore.__RAPIER_TO_COMPONENT__
Defined in
app
app:
Application<Renderer>
Defined in
colliders
colliders:
FCollider[]
Defined in
components
components:
FComponent[]
The components in the scene.
Overrides
FSceneCore.components
Defined in
eventQueue
eventQueue:
EventQueue
Overrides
FSceneCore.eventQueue
Defined in
gravity
gravity:
object
x
x:
number
y
y:
number
Overrides
FSceneCore.gravity
Defined in
lights
lights:
FLight[]
The lights in the scene.
Overrides
FSceneCore.lights
Defined in
rigidBodies
rigidBodies:
FRigidBody[]
Defined in
viewport
viewport:
Viewport
Defined in
world
world:
World
Overrides
FSceneCore.world