Skip to content

@fibbojs / 2d / FRectangle

Class: FRectangle

A simple square in Fibbo.

Example

ts
import { FRectangle, FScene } from '@fibbojs/2d'

const scene = new FScene()

const square = new FRectangle(scene)
scene.addComponent(square)

Extends

Accessors

color

get color(): undefined | number

set color(value): void

Parameters

value: undefined | number

Returns

undefined | number

Inherited from

FPolygon.color

Defined in

2d/src/polygons/FPolygon.ts:63

Constructors

new FRectangle()

new FRectangle(scene, options?): FRectangle

Parameters

scene: FScene

options?: FPolygonOptions

Returns

FRectangle

Overrides

FPolygon.constructor

Defined in

2d/src/polygons/FRectangle.ts:21

Methods

__DRAW_SHAPE__()

__DRAW_SHAPE__(graphics): void

Draw the shape of the polygon. This method should be implemented by the child class.

Parameters

graphics: Graphics

The PIXI.Graphics object to draw the shape on.

Returns

void

Overrides

FPolygon.__DRAW_SHAPE__

Defined in

2d/src/polygons/FRectangle.ts:51


__SET_POSITION__()

__SET_POSITION__(position): void

Parameters

position: FVector2

Returns

void

Inherited from

FPolygon.__SET_POSITION__

Defined in

2d/src/core/FComponent.ts:221


__SET_ROTATION__()

__SET_ROTATION__(rotation): void

Parameters

rotation: number

Returns

void

Inherited from

FPolygon.__SET_ROTATION__

Defined in

2d/src/core/FComponent.ts:228


__SET_SCALE__()

__SET_SCALE__(scale): void

Parameters

scale: FVector2

Returns

void

Overrides

FPolygon.__SET_SCALE__

Defined in

2d/src/polygons/FRectangle.ts:46


__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

FPolygon.__UPDATE_POSITION__

Defined in

2d/src/core/FComponent.ts:113


__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

FPolygon.__UPDATE_ROTATION__

Defined in

2d/src/core/FComponent.ts:153


__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

FPolygon.__UPDATE_SCALE__

Defined in

2d/src/core/FComponent.ts:187


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

typescript
const player = new Player()
const enemy = new Enemy()
player.emitCollisionWith({
  class: Enemy
})
typescript
const player = new Player()
const enemy = new Enemy()
player.emitCollisionWith({
  object: enemy
})

Inherited from

FPolygon.emitCollisionWith

Defined in

core/dist/index.d.ts:293


emitOnLoaded()

emitOnLoaded(): void

Emit the onLoaded callbacks.

Returns

void

Inherited from

FPolygon.emitOnLoaded

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

Returns

void

Inherited from

FPolygon.frame

Defined in

2d/src/core/FComponent.ts:103


initCollider()

initCollider(options?): void

Parameters

options?: FColliderOptions

Returns

void

Inherited from

FPolygon.initCollider

Defined in

2d/src/core/FComponent.ts:253


initRigidBody()

initRigidBody(options?): void

Parameters

options?: FRigidBodyOptions

Returns

void

Inherited from

FPolygon.initRigidBody

Defined in

2d/src/core/FComponent.ts:259


initSensor()

initSensor(options?): void

Parameters

options?: FRigidBodyOptions

Returns

void

Inherited from

FPolygon.initSensor

Defined in

2d/src/core/FComponent.ts:265


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

typescript
const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(Enemy, () => {
  console.log('Player collided with an Enemy!')
})
typescript
const player = new Player()
const enemy = new Enemy()
player.onCollisionWith(enemy, () => {
  console.log('Player collided with the enemy!')
})

Inherited from

FPolygon.onCollisionWith

Defined in

2d/src/core/FComponent.ts:243


onFrame()

onFrame(callback): void

Add a callback to be called every frame.

Parameters

callback

The callback function.

Returns

void

Inherited from

FPolygon.onFrame

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

FPolygon.onLoaded

Defined in

core/dist/index.d.ts:243

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

FPolygon.__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

FPolygon.__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

FPolygon.__CALLBACKS_ON_LOADED__

Defined in

core/dist/index.d.ts:211


__COLOR__?

optional __COLOR__: number

The color of the polygon.

Inherited from

FPolygon.__COLOR__

Defined in

2d/src/polygons/FPolygon.ts:24


__CONTAINER__

__CONTAINER__: Graphics

PIXI container

Inherited from

FPolygon.__CONTAINER__

Defined in

2d/src/polygons/FPolygon.ts:31


__GRADIENT__?

optional __GRADIENT__: GradientStep[]

The gradient of the polygon.

Inherited from

FPolygon.__GRADIENT__

Defined in

2d/src/polygons/FPolygon.ts:28


__ID__

__ID__: number

Unique identifier for the component. It is generated automatically.

Inherited from

FPolygon.__ID__

Defined in

core/dist/index.d.ts:203


__IS_2D__

__IS_2D__: boolean = true

Internal flags

Inherited from

FPolygon.__IS_2D__

Defined in

2d/src/core/FComponent.ts:30


__IS_3D__

__IS_3D__: boolean

Internal flags

Inherited from

FPolygon.__IS_3D__

Defined in

core/dist/index.d.ts:197


collider

collider: FCollider

RAPIER Collider

Inherited from

FPolygon.collider

Defined in

2d/src/core/FComponent.ts:59


controller?

optional controller: FController

The controller attached to the component.

Inherited from

FPolygon.controller

Defined in

2d/src/core/FComponent.ts:39


rigidBody

rigidBody: FRigidBody

RAPIER RigidBody

Inherited from

FPolygon.rigidBody

Defined in

2d/src/core/FComponent.ts:55


scene

scene: FScene

The scene which the component is in.

Inherited from

FPolygon.scene

Defined in

2d/src/core/FComponent.ts:35


sensor

sensor: FRigidBody

Sensor (a collider that doesn't collide with other colliders, but still triggers events)

Inherited from

FPolygon.sensor

Defined in

2d/src/core/FComponent.ts:63


transform

transform: FTransform

Transforms

Inherited from

FPolygon.transform

Defined in

2d/src/core/FComponent.ts:49