Class: FFreeCamera
A free camera that can be moved around.
Extends
Constructors
new FFreeCamera()
new FFreeCamera(
scene,options?):FFreeCamera
Parameters
• scene: FScene
• options?: FCameraOptions
Returns
Overrides
Defined in
2d/src/cameras/FFreeCamera.ts:10
Methods
__ON_CAMERA_ADDED_TO_SCENE_PLEASE_DO_NOT_CALL_THIS_BY_HAND__()
__ON_CAMERA_ADDED_TO_SCENE_PLEASE_DO_NOT_CALL_THIS_BY_HAND__():
void
Returns
void
Overrides
FCamera.__ON_CAMERA_ADDED_TO_SCENE_PLEASE_DO_NOT_CALL_THIS_BY_HAND__
Defined in
2d/src/cameras/FFreeCamera.ts:14
__SET_POSITION__()
__SET_POSITION__(
position):void
Parameters
• position
• position.x: number
• position.y: number
Returns
void
Inherited from
Defined in
__UPDATE_POSITION__()
__UPDATE_POSITION__():
void
Update the position of the camera according to the transform. This method should be called after updating the transform properties.
Returns
void
Inherited from
Defined in
__UPDATE_ROTATION__()
__UPDATE_ROTATION__():
void
Update the rotation of the camera according to the transform. This method should be called after updating the transform properties.
Returns
void
Inherited from
Defined in
__UPDATE_SCALE__()
__UPDATE_SCALE__():
void
Update the scale of the camera according to the transform. This method should be called after updating the transform properties. This method does not make sense for cameras, but it is implemented for consistency.
Returns
void
Inherited from
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:293
emitOnLoaded()
emitOnLoaded():
void
Emit the onLoaded callbacks.
Returns
void
Inherited from
Defined in
core/dist/index.d.ts:247
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
core/dist/index.d.ts:233
onCollisionWith()
onCollisionWith(
classOrObject,callback): () =>void
Add a callback to be called when a collision occurs.
Parameters
• classOrObject: any
The class or object to add the callback to.
• callback
The callback to add.
Returns
Function
A function to remove the callback.
Returns
void
Examples
const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(Enemy, () => {
console.log('Player collided with an Enemy!')
})const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(enemy, () => {
console.log('Player collided with the enemy!')
})Inherited from
Defined in
core/dist/index.d.ts:270
onFrame()
onFrame(
callback):void
Add a callback to be called every frame.
Parameters
• callback
The callback function.
Returns
void
Inherited from
Defined in
core/dist/index.d.ts:238
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
Defined in
core/dist/index.d.ts:243
setZoom()
setZoom(
zoom):void
Parameters
• zoom: number
Returns
void
Inherited from
Defined in
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
FCamera.__CALLBACKS_ON_COLLISION__
Defined in
core/dist/index.d.ts:216
__CALLBACKS_ON_FRAME__
__CALLBACKS_ON_FRAME__: () =>
void[]
Callbacks for when a frame is rendered.
Inherited from
FCamera.__CALLBACKS_ON_FRAME__
Defined in
core/dist/index.d.ts:207
__CALLBACKS_ON_LOADED__
__CALLBACKS_ON_LOADED__: () =>
void[]
Callbacks for when the component is loaded (could be a texture, a 3D model, etc).
Inherited from
FCamera.__CALLBACKS_ON_LOADED__
Defined in
core/dist/index.d.ts:211
__ID__
__ID__:
number
Unique identifier for the component. It is generated automatically.
Inherited from
Defined in
core/dist/index.d.ts:203
__IS_2D__
__IS_2D__:
boolean=true
Internal flags
Inherited from
Defined in
__IS_3D__
__IS_3D__:
boolean
Internal flags
Inherited from
Defined in
core/dist/index.d.ts:197
controller?
optionalcontroller:FController
The controller attached to the component.
Inherited from
Defined in
core/dist/index.d.ts:226
scene
scene:
FScene
The scene the camera is in.
Inherited from
Defined in
transform
transform:
FTransform
Transform of the camera. It is used to store the position of the camera. The scale and rotation of the transform are not used.