Class GraphicsEngine

GraphicsEngine-Component

This component will do the following tasks for you:

manage a FatRenderer instance
manage a LUIManager instance
manage the canvas (HTMLCanvasElement)
manages touch/mouse input
observes keyboard-input (keyDown, keyUp etc.)

You use this to:

add graphics objects to the world
add UI elements to the GUI
configure how your canvas get's scaled (or tell it that you like to do that yourself)

See

FatRenderer
LUIManager

Hierarchy

Component
- GraphicsEngine

Index

Constructors

constructor

Accessors

actualPixelSize debugZoom gameLayer gui guiBehind height width world

Constructors

constructor

new GraphicsEngine(): GraphicsEngine
Returns GraphicsEngine
Inherited from Component.constructor
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:85

Properties

`Private` _debugZoom

_debugZoom: number = 0

`Private` _game

_game: RenderElement

`Private` _gui

_gui: LUILayer

`Private` _guiBehind

_guiBehind: LUILayer

`Private` _height

_height: number = 1

`Private` _keyDown

_keyDown: Record<string, boolean> = {}

`Private` _overlayCanvasList

_overlayCanvasList: OverlayCanvas[] = []

`Private` _pixelSize

_pixelSize: number

`Private` _rootMatrix

_rootMatrix: AffineMatrix = ...

`Private` _width

_width: number = 1

`Private` canvas

canvas: HTMLCanvasElement

clearColor

clearColor: Color

`Private` clientRect

clientRect: DOMRect

`Private` clientToGameX

clientToGameX: number = 1

`Private` clientToGameY

clientToGameY: number = 1

engineContext

engineContext: EngineContext

entity

entity: Entity = null

frame

frame: number = 0

`Private` idMatrix

idMatrix: AffineMatrix = ...

`Private` isMouseDown

isMouseDown: boolean = false

`Private` lastTouchX

lastTouchX: number = 0

`Private` lastTouchY

lastTouchY: number = 0

lui

lui: LUIManager

`Private` pixelSize

pixelSize: number

renderer

renderer: FatRenderer

`Private` scaleMode

scaleMode: string

Accessors

actualPixelSize

get actualPixelSize(): number
This is the pixel size the GraphicEngine is using. It is either window.devicePixelRatio or overwritten by the config.

Returns number
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:152

Methods

appendOverlayCanvas

appendOverlayCanvas(factor?: number): OverlayCanvas
Parameters
- factor: number = 1
Returns OverlayCanvas
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:445

`Private` calcClientToGameCoords

calcClientToGameCoords(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:297

createComponentRef

createComponentRef<T>(cmpName: string, activesOnly?: boolean, entityName?: string): ComponentRef<T>
A reference to another entity's component.

It'll internally search the current world for the given entity + component and keep and check the reference.

The idea is to keep the reference as a variable. This avoids ugly search code in the component space.
Type Parameters
- T extends Component<T>
Parameters
- cmpName: string
- Optional activesOnly: boolean
- Optional entityName: string
Returns ComponentRef<T>
Inherited from Component.createComponentRef
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:133

disableDebugZoom

disableDebugZoom(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:194

enableDebugZoom

enableDebugZoom(zoom: number): void
Parameters
- zoom: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:190

findComponent

findComponent(cmpName: any): any
Finds a component within this entitiy.
Parameters
- cmpName: any
  
  Class-Name of the component
Returns any
Inherited from Component.findComponent
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:163

`Private` handleKeydown

handleKeydown(k: any): void
Parameters
- k: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:283

`Private` handleKeyup

handleKeyup(k: any): void
Parameters
- k: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:290

`Private` handleMouseDown

handleMouseDown(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:347

`Private` handleMouseLeave

handleMouseLeave(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:379

`Private` handleMouseMove

handleMouseMove(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:359

`Private` handleMouseOut

handleMouseOut(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:389

`Private` handleMouseUp

handleMouseUp(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:368

`Private` handleTouchend

handleTouchend(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:420

`Private` handleTouchmove

handleTouchmove(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:411

`Private` handleTouchstart

handleTouchstart(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:399

`Private` handleWindowResize

handleWindowResize(e: any): void
Parameters
- e: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:307

isKeyDown

isKeyDown(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:156

onActivate

onActivate(): void
Returns void
Overrides Component.onActivate
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:172

onDeactivate

onDeactivate(): void
Returns void
Overrides Component.onDeactivate
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:177

onDispose

onDispose(): void
Returns void
Overrides Component.onDispose
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:182

`Private` onDown

onDown(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:427

onInit

onInit(): void
Returns void
Overrides Component.onInit
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:92

onMessage_DebugZoom

onMessage_DebugZoom(zoomVal: any): void
Parameters
- zoomVal: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:198

`Private` onMove

onMove(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:433

onRender

onRender(elasped: number): void
Overwrite this if you need to listen to render events.

It only works if you also register the outer entity to receive render events:
```
onInit() {
    this.world.requestRenderEvents(this.entity); // REQUIRED!!
}
```
Parameters
- elasped: number
Returns void
Overrides Component.onRender
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:207

`Private` onUp

onUp(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:439

onUpdate

onUpdate(elapsed: number): void
Parameters
- elapsed: number
Returns void
Overrides Component.onUpdate
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:186

`Private` registerInputEvents

registerInputEvents(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:239

requireComponent

requireComponent<T>(cmpType: string): T
Type Parameters
- T extends Component<T>
Parameters
- cmpType: string
Returns T
Inherited from Component.requireComponent
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:110

requireProperty

requireProperty<T>(propName: string): T
Type Parameters
- T
Parameters
- propName: string
Returns T
Inherited from Component.requireProperty
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:94

requireResource

requireResource<T>(resourceName: string, urlProp: string): T
Type Parameters
- T
Parameters
- resourceName: string
- urlProp: string
Returns T
Inherited from Component.requireResource
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:102

sendMessageToActive

sendMessageToActive(name: string, params?: any): void
Send a message to all active entities
Parameters
- name: string
- Optional params: any
Returns void
Inherited from Component.sendMessageToActive
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:144

sendMessageToAll

sendMessageToAll(name: string, params: any): void
Send a message to all entities.

This should be used with caution as there may be thousends of entities to crawl.
Parameters
- name: string
- params: any
Returns void
Inherited from Component.sendMessageToAll
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:154

sendMessageToEntity

sendMessageToEntity(name: string, params?: any): any
Send a message to all entity components
Parameters
- name: string
- Optional params: any
Returns any
Inherited from Component.sendMessageToEntity
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:139

`Private` unregisterInputEvents

unregisterInputEvents(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:262

`Private` windowResize

windowResize(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/GraphicsEngine.ts:322

Class GraphicsEngine

GraphicsEngine-Component

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GraphicsEngine

Properties

Private _debugZoom

Private _game

Private _gui

Private _guiBehind

Private _height

Private _keyDown

Private _overlayCanvasList

Private _pixelSize

Private _rootMatrix

Private _width

Private canvas

clearColor

Private clientRect

Private clientToGameX

Private clientToGameY

engineContext

entity

frame

Private idMatrix

Private isMouseDown

Private lastTouchX

Private lastTouchY

lui

Private pixelSize

renderer

Private scaleMode

Accessors

actualPixelSize

Returns number

debugZoom

Returns number

gameLayer

Returns RenderElement

gui

Returns LUILayer

guiBehind

Returns LUILayer

height

Returns number

width

Returns number

world

Returns World

Methods

appendOverlayCanvas

Parameters

factor: number = 1

Returns OverlayCanvas

Private calcClientToGameCoords

Returns void

createComponentRef

Type Parameters

T extends Component<T>

Parameters

cmpName: string

Optional activesOnly: boolean

Optional entityName: string

Returns ComponentRef<T>

disableDebugZoom

Returns void

enableDebugZoom

Parameters

zoom: number

Returns void

findComponent

Parameters

cmpName: any

`Private` _debugZoom

`Private` _game

`Private` _gui

`Private` _guiBehind

`Private` _height

`Private` _keyDown

`Private` _overlayCanvasList

`Private` _pixelSize

`Private` _rootMatrix

`Private` _width

`Private` canvas

`Private` clientRect

`Private` clientToGameX

`Private` clientToGameY

`Private` idMatrix

`Private` isMouseDown

`Private` lastTouchX

`Private` lastTouchY

`Private` pixelSize

`Private` scaleMode

`Private` calcClientToGameCoords

`Optional` activesOnly: boolean

`Optional` entityName: string

`Private` handleKeydown

`Private` handleKeyup

`Private` handleMouseDown

`Private` handleMouseLeave

`Private` handleMouseMove

`Private` handleMouseOut

`Private` handleMouseUp

`Private` handleTouchend

`Private` handleTouchmove

`Private` handleTouchstart

`Private` handleWindowResize

`Private` onDown

`Private` onMove