Class DataSet2DComponent

Holds a regular 2D grid of sampled scalar values.

Hierarchy (View Summary)

DynamicComponent
- DataSet2DComponent

Index

Constructors

Properties

data isTyped sizeI sizeJ

Accessors

entity name type

Methods

Constructors

constructor

new DataSet2DComponent(type: string): DataSet2DComponent
Component constructor
Parameters
- type: string
  Type-name of the component, e.g. name of sub-class implementing the component. "MyComponent", etc.
Returns DataSet2DComponent
Inherited from DynamicComponent.constructor
- Defined in dist/cogs.esm.d.ts:3469

Properties

data

data: Float32Array

Values of the dataset, should be of size layout.x*layout.y.

isTyped

isTyped: boolean

Internal flag set if component is a Cogs Core component.

sizeI

sizeI: number

2D layout of dataset.

sizeJ

sizeJ: number

2D layout of dataset.

Accessors

entity

get entity(): Entity
Gets the optional owning entity

Returns Entity
Inherited from DynamicComponent.entity
- Defined in dist/cogs.esm.d.ts:3395
set entity(entity: Entity): void
Internal: set owning entity.
Parameters
- entity: Entity
Returns void
Inherited from DynamicComponent.entity
- Defined in dist/cogs.esm.d.ts:3400

name

get name(): string
Component name == type. For compatibility

Returns string
Inherited from DynamicComponent.name
- Defined in dist/cogs.esm.d.ts:3408

type

get type(): string
Gets the type of the component. Ex. "TransformComponent", "SceneComponent" etc.

Returns string
Inherited from DynamicComponent.type
- Defined in dist/cogs.esm.d.ts:3405

Methods

`Static`create

create(type: string): Component
Internal: Creates a new component of the given type (name). Component is wrapped when adding to an entity.
Parameters
- type: string
  Type of the component. Ex. "TransformComponent"
Returns Component
Created Cogs.js component.
Inherited from DynamicComponent.create
- Defined in dist/cogs.esm.d.ts:3427

`Static`wrap

wrap(type: string, entity: Entity): Component
Internal: Creates a new component being wrapped as an existing member of the entity
Parameters
- type: string
  Type of the component. Ex. "TransformComponent"
- entity: Entity
  The owning entity
Returns Component
Created Cogs.js component.
Inherited from DynamicComponent.wrap
- Defined in dist/cogs.esm.d.ts:3419