Class ShapeComponent

Represents a primitive Shape like rectangle, circle, etc

Hierarchy

BaseDrawableComponent
- ShapeComponent

Implements

IDrawableComponent
ShapeComponentProps

Index

Constructors

Properties

isWireframe shapeType uuid

Accessors

isVisible material transform

Methods

draw getContainer hide setContainer show toJson

Constructors

constructor

new ShapeComponent(props?: ShapeComponentProps): ShapeComponent
Parameters
- Optionalprops: ShapeComponentProps
Returns ShapeComponent
Overrides BaseDrawableComponent.constructor
- Defined in ecs/components/ShapeComponent.ts:39

Properties

isWireframe

isWireframe: boolean = false

Whether to render the primitive mesh as a Wireframe or as a full mesh

shapeType

shapeType: Rectangle = PrimitiveType.Rectangle

The primitive type of the shape

`Readonly`uuid

uuid: string = ...

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

material

get material(): MaterialComponent
Returns MaterialComponent
- Defined in ecs/components/ShapeComponent.ts:35

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

Methods

draw

draw(renderer: Renderer, imageLoader: DOMImageLoader): void
Put a draw call in the renderer taking into account the component data
Parameters
- renderer: Renderer
- imageLoader: DOMImageLoader
Returns void
Implementation of IDrawableComponent.draw
Overrides BaseDrawableComponent.draw
- Defined in ecs/components/ShapeComponent.ts:50

getContainer

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

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:19

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<ShapeComponentProps>
Returns WithType<ShapeComponentProps>
Implementation of IDrawableComponent.toJson
Overrides BaseDrawableComponent.toJson
- Defined in ecs/components/ShapeComponent.ts:75