Class CameraComponent

Handles rendering the camera's transform matrix.

Hierarchy

BaseDrawableComponent
- CameraComponent

Implements

IDrawableComponent

Index

Constructors

Accessors

isVisible transform uuid

Methods

draw getContainer hide setContainer show toJson

Constructors

constructor

new CameraComponent(props?: DrawableComponentProps): CameraComponent
Parameters
- Optionalprops: DrawableComponentProps
Returns CameraComponent
Inherited from BaseDrawableComponent.constructor
- Defined in ecs/components/ BaseDrawableComponent.ts:30

Accessors

isVisible

get isVisible(): boolean
Whether the component is visible or not

Returns boolean
Implementation of IDrawableComponent.isVisible
Inherited from BaseDrawableComponent.isVisible
- Defined in ecs/components/ BaseDrawableComponent.ts:26

transform

get transform(): TransformComponent
When attached to a parent Entity container, it returns its Tranform Component if present. Otherwise it returns the default transform of the Shape

Returns TransformComponent
Implementation of IDrawableComponent.transform
Inherited from BaseDrawableComponent.transform
- Defined in ecs/components/ BaseDrawableComponent.ts:42

uuid

get uuid(): string
Returns string
Implementation of IDrawableComponent.uuid
Inherited from BaseDrawableComponent.uuid
- Defined in ecs/components/BaseComponent.ts:13

Methods

draw

draw(renderer: Renderer): void
Draws the component using the provided renderer and image loader.
Parameters
- renderer: Renderer
  The renderer to use for drawing.
Returns void
Implementation of IDrawableComponent.draw
Overrides BaseDrawableComponent.draw
- Defined in ecs/components/CameraComponent.ts:13

getContainer

getContainer(): IEntity | undefined
Returns IEntity | undefined
Implementation of IDrawableComponent.getContainer
Inherited from BaseDrawableComponent.getContainer
- Defined in ecs/components/BaseComponent.ts:17

hide

hide(): void
Hides the component from rendering.

Returns void
Implementation of IDrawableComponent.hide
Inherited from BaseDrawableComponent.hide
- Defined in ecs/components/ BaseDrawableComponent.ts:46

setContainer

setContainer(container: IEntity): void
Parameters
- container: IEntity
Returns void
Implementation of IDrawableComponent.setContainer
Inherited from BaseDrawableComponent.setContainer
- Defined in ecs/components/BaseComponent.ts:21

show

show(): void
Shows the component for rendering.

Returns void
Implementation of IDrawableComponent.show
Inherited from BaseDrawableComponent.show
- Defined in ecs/components/ BaseDrawableComponent.ts:50

toJson

toJson(): WithType<DrawableComponentProps>
Returns WithType<DrawableComponentProps>
Implementation of IDrawableComponent.toJson
Inherited from BaseDrawableComponent.toJson
- Defined in ecs/components/ BaseDrawableComponent.ts:55