Package com.tenio.engine.ecs.base

Class Context<TEntity extends Entity>

java.lang.Object

com.tenio.engine.ecs.base.Context<TEntity>

All Implemented Interfaces:

IContext<TEntity>

public class Context<TEntity extends Entity>
extends java.lang.Object
implements IContext<TEntity>

A context manages the life-cycle of entities and groups. You can create and destroy entities and get groups of entities.

Author:

kong

See Also:

IContext

Constructor Summary

Constructors

Constructor	Description
Context(ContextInfo contextInfo, java.lang.Class<TEntity> clazz)

Method Summary

Modifier and Type	Method	Description
TEntity	createEntity()	Create new entity
void	destroyAllEntities()	Remove all context's entities
void	destroyEntity(TEntity entity)	Remove this entity from the current context
ContextInfo	getContextInfo()	Retrieves the context information
int	getEntitesCount()	Retrieves the number of entities
java.util.Map<java.lang.String,TEntity>	getEntities()	Retrieves all entities of the current context
TEntity	getEntity(java.lang.String entityId)	Retrieves an entity by entity id
boolean	hasEntity(TEntity entity)	Check if the entity is existed by entity id
void	reset()	Reset the current context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Context

public Context(ContextInfo contextInfo,
               java.lang.Class<TEntity> clazz)

Method Detail

createEntity

public TEntity createEntity()

Description copied from interface: IContext

Create new entity

Specified by:

createEntity in interface IContext<TEntity extends Entity>

Returns:

the entity by the corresponding entity template

getEntity

public TEntity getEntity(java.lang.String entityId)

Description copied from interface: IContext

Retrieves an entity by entity id

Specified by:

getEntity in interface IContext<TEntity extends Entity>

Parameters:

entityId - the entity id

Returns:

the corresponding entity

destroyEntity

public void destroyEntity(TEntity entity)

Description copied from interface: IContext

Remove this entity from the current context

Specified by:

destroyEntity in interface IContext<TEntity extends Entity>

Parameters:

entity - the corresponding entity

hasEntity

public boolean hasEntity(TEntity entity)

Description copied from interface: IContext

Check if the entity is existed by entity id

Specified by:

hasEntity in interface IContext<TEntity extends Entity>

Parameters:

entity - the entity

Returns:

true if this entity is existed in the current context, false otherwise

getEntities

public java.util.Map<java.lang.String,TEntity> getEntities()

Description copied from interface: IContext

Retrieves all entities of the current context

Specified by:

getEntities in interface IContext<TEntity extends Entity>

Returns:

the map of entities

getContextInfo

public ContextInfo getContextInfo()

Description copied from interface: IContext

Retrieves the context information

Specified by:

getContextInfo in interface IContext<TEntity extends Entity>

Returns:

see ContextInfo

getEntitesCount

public int getEntitesCount()

Description copied from interface: IContext

Retrieves the number of entities

Specified by:

getEntitesCount in interface IContext<TEntity extends Entity>

Returns:

the entities count

destroyAllEntities

public void destroyAllEntities()

Description copied from interface: IContext

Remove all context's entities

Specified by:

destroyAllEntities in interface IContext<TEntity extends Entity>

reset

public void reset()

Description copied from interface: IContext

Reset the current context

Specified by:

reset in interface IContext<TEntity extends Entity>