Class EntityBuilder

Index

Constructors

Methods

addEntity addEntityByName getEntities setGraph

Constructors

constructor

new EntityBuilder(): EntityBuilder
Returns EntityBuilder

Methods

addEntity

addEntity(entity, startTime?, duration?): EntityBuilder
Adds an entity to the builder with a specified start time and duration.
Parameters
- entity: IEntity
  The entity to add.
- OptionalstartTime: number
  The start time of the entity within the scene (in milliseconds).
- Optionalduration: number
  The duration of the entity within the scene (in milliseconds).
Returns EntityBuilder
The EntityBuilder instance for chaining.
- Defined in Helpers/EntityBuilder.ts:15

addEntityByName

addEntityByName(entityName, startTime?, duration?): EntityBuilder
Adds an entity from the graph by its name.
Parameters
- entityName: string
  The name of the entity in the graph.
- OptionalstartTime: number
  The start time of the entity within the scene (in milliseconds).
- Optionalduration: number
  The duration of the entity within the scene (in milliseconds).
Returns EntityBuilder
The EntityBuilder instance for chaining.
- Defined in Helpers/EntityBuilder.ts:40

getEntities

getEntities(): IEntity[]
Gets the array of entities with their timing configured.

Returns IEntity[]
The array of IEntity objects.
- Defined in Helpers/EntityBuilder.ts:55

setGraph

setGraph(graph): EntityBuilder
Sets the graph object to be used for adding entities by name.
Parameters
- graph: Record<string, IEntity>
  An object containing entities accessible by name.
Returns EntityBuilder
The EntityBuilder instance for chaining.
- Defined in Helpers/EntityBuilder.ts:28