Class: FScene
A scene which contains the models, 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(scene)
square.initRigidBody()
scene.addComponent(square)
})()Extends
FScene
Accessors
camera
getcamera():FCamera
Getter for the camera. This is required because the camera is a private property.
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
Defined in
Constructors
new FScene()
new FScene(
options?):FScene
Parameters
• options?: FSceneOptions
Returns
Overrides
FSceneCore.constructor
Defined in
Methods
addComponent()
addComponent(
component):void
Add a component to the scene.
Parameters
• component: FComponent
Returns
void
Overrides
FSceneCore.addComponent
Defined in
addLight()
addLight(
light):void
Add a light to the scene.
Parameters
• light: FLight
Returns
void
Overrides
FSceneCore.addLight
Defined in
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>
Defined in
initPhysics()
initPhysics():
Promise<void>
Returns
Promise<void>
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:269
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:273
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:265
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:282
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:286
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:278
removeComponent()
removeComponent(
component):void
Remove a component from the scene.
Parameters
• component: FComponent
Returns
void
Overrides
FSceneCore.removeComponent
Defined in
removeLight()
removeLight(
light):void
Remove a light from the scene.
Parameters
• light: FLight
Returns
void
Overrides
FSceneCore.removeLight
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. It is an array of functions that take the component as an argument.
Inherited from
FSceneCore.__CALLBACKS_ON_COMPONENT_ADDED__
Defined in
core/dist/index.d.ts:225
__CALLBACKS_ON_COMPONENT_REMOVED__
__CALLBACKS_ON_COMPONENT_REMOVED__: (
component) =>void[]
Callbacks for when a component is remove from the scene. It is an array of functions that take the component as an argument.
Inherited from
FSceneCore.__CALLBACKS_ON_COMPONENT_REMOVED__
Defined in
core/dist/index.d.ts:230
__CALLBACKS_ON_FRAME__
__CALLBACKS_ON_FRAME__: (
delta) =>void[]
Callbacks for when a frame is rendered. It is an array of functions that take the delta time as an argument.
Inherited from
FSceneCore.__CALLBACKS_ON_FRAME__
Defined in
core/dist/index.d.ts:220
__CALLBACKS_ON_LIGHT_ADDED__
__CALLBACKS_ON_LIGHT_ADDED__: (
light) =>void[]
Callbacks for when a light is added to the scene. It is an array of functions that take the light as an argument.
Inherited from
FSceneCore.__CALLBACKS_ON_LIGHT_ADDED__
Defined in
core/dist/index.d.ts:239
__CALLBACKS_ON_LIGHT_REMOVED__
__CALLBACKS_ON_LIGHT_REMOVED__: (
light) =>void[]
Callbacks for when a light is added to the scene. It is an array of functions that take the light as an argument.
Inherited from
FSceneCore.__CALLBACKS_ON_LIGHT_REMOVED__
Defined in
core/dist/index.d.ts:244
__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:234
__CAMERA__
__CAMERA__:
FCamera
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:196
__IS_2D__
__IS_2D__:
boolean=true
Internal flags
Overrides
FSceneCore.__IS_2D__
Defined in
__IS_3D__
__IS_3D__:
boolean
Internal flags
Inherited from
FSceneCore.__IS_3D__
Defined in
core/dist/index.d.ts:191
__RAPIER_TO_COMPONENT__
__RAPIER_TO_COMPONENT__:
Map<number,FComponent>
Overrides
FSceneCore.__RAPIER_TO_COMPONENT__
Defined in
app
app:
Application<Renderer>
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
viewport
viewport:
Viewport
Defined in
world
world:
World
Overrides
FSceneCore.world