org.mini2Dx.ecs.entity

Class Entity

java.lang.Object

org.mini2Dx.ecs.entity.Entity

All Implemented Interfaces:

ComponentStore

Direct Known Subclasses:

GameScreenEntity

public class Entity
extends java.lang.Object
implements ComponentStore

A common interface for Entity implementations within the Entity-Component-System pattern

Constructor Summary

Constructors

Constructor and Description
Entity() Creates a new Entity with a generated ID and a DefaultComponentStore
Entity(ComponentStore componentStore) Creates a new Entity with a generated ID with a specific ComponentStore implementaton
Entity(int id) Creates a new Entity with a specific ID and a DefaultComponentStore
Entity(int id, ComponentStore componentStore) Creates a new Entity with a specific ID and ComponentStore implementation

Method Summary

Modifier and Type	Method and Description
void	addChild(Entity child)
void	addComponent(Component component) Adds a Component to this Entity and notifies any attached EntityListeners of this addition
void	addEntityListener(EntityListener listener) Adds an EntityListener to this Entity
void	destroy() Destroys this Entity and deallocates its ID
java.util.List<Entity>	getChildren()
<T> T	getComponent(java.lang.Class<T> clazz)
<T> T	getComponent(int componentTypeId)
<T extends Component> T	getComponent(java.lang.String name, java.lang.Class<T> clazz)
<T extends Component> T	getComponent(java.lang.String name, int componentTypeId)
<T extends Component> T	getComponentInDescendants(java.lang.Class<T> clazz)
<T extends Component> T	getComponentInDescendants(int componentTypeId)
<T extends Component> T	getComponentInDescendants(java.lang.String name, java.lang.Class<T> clazz)
<T extends Component> T	getComponentInDescendants(java.lang.String name, int componentTypeId)
<T> java.util.SortedSet<T>	getComponents(java.lang.Class<T> clazz) Returns all Components that implement the specified the class or interface
<T> java.util.SortedSet<T>	getComponents(int componentTypeId) Returns all Components that implement the specified the class or interface
<T extends Component> java.util.SortedSet<T>	getComponentsInDescendants(java.lang.Class<T> clazz)
<T extends Component> java.util.SortedSet<T>	getComponentsInDescendants(int componentTypeId)
int	getId()
java.util.UUID	getUUID()
<T extends Component> java.util.SortedSet<T>	removeAllComponentsOfType(java.lang.Class<T> clazz) Removes all Components that implement a specific type
<T extends Component> java.util.SortedSet<T>	removeAllComponentsOfType(int componentTypeId) Removes all Components that implement a specific type
void	removeChild(Entity child)
void	removeComponent(Component component) Removes the specified Component from this Entity
void	removeEntityListener(EntityListener listener) Removes an EntityListener from this Entity

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity()

Creates a new Entity with a generated ID and a DefaultComponentStore

Entity

public Entity(int id)

Creates a new Entity with a specific ID and a DefaultComponentStore

Parameters:

id - The ID to allocate this Entity

Entity

public Entity(ComponentStore componentStore)

Creates a new Entity with a generated ID with a specific ComponentStore implementaton

Parameters:

componentStore - The ComponentStore implementation to use

Entity

public Entity(int id,
              ComponentStore componentStore)

Creates a new Entity with a specific ID and ComponentStore implementation

Parameters:

id - The ID to allocate this Entity

componentStore - The ComponentStore implementation to use

Method Detail

destroy

public void destroy()

Destroys this Entity and deallocates its ID

addChild

public void addChild(Entity child)

removeChild

public void removeChild(Entity child)

getChildren

public java.util.List<Entity> getChildren()

getComponent

public <T> T getComponent(java.lang.Class<T> clazz)

Specified by:

getComponent in interface ComponentStore

getComponent

public <T extends Component> T getComponent(java.lang.String name,
                                            java.lang.Class<T> clazz)

Specified by:

getComponent in interface ComponentStore

getComponent

public <T extends Component> T getComponent(java.lang.String name,
                                            int componentTypeId)

Specified by:

getComponent in interface ComponentStore

addComponent

public void addComponent(Component component)

Adds a Component to this Entity and notifies any attached EntityListeners of this addition

Specified by:

addComponent in interface ComponentStore

Parameters:

component - An instance of Component

getComponents

public <T> java.util.SortedSet<T> getComponents(java.lang.Class<T> clazz)

Returns all Components that implement the specified the class or interface

Specified by:

getComponents in interface ComponentStore

Parameters:

clazz - The Class to search for

Returns:

An empty List if no such Components are attached to this Entity

removeComponent

public void removeComponent(Component component)

Removes the specified Component from this Entity

Specified by:

removeComponent in interface ComponentStore

Parameters:

component - The Component to remove

removeAllComponentsOfType

public <T extends Component> java.util.SortedSet<T> removeAllComponentsOfType(java.lang.Class<T> clazz)

Removes all Components that implement a specific type

Specified by:

removeAllComponentsOfType in interface ComponentStore

Parameters:

clazz - The Class to search for

getComponent

public <T> T getComponent(int componentTypeId)

Specified by:

getComponent in interface ComponentStore

getComponents

public <T> java.util.SortedSet<T> getComponents(int componentTypeId)

Description copied from interface: ComponentStore

Returns all Components that implement the specified the class or interface

Specified by:

getComponents in interface ComponentStore

Parameters:

componentTypeId - The unique identifier of the component type

Returns:

An empty List if no such Components are attached to this Entity

removeAllComponentsOfType

public <T extends Component> java.util.SortedSet<T> removeAllComponentsOfType(int componentTypeId)

Description copied from interface: ComponentStore

Removes all Components that implement a specific type

Specified by:

removeAllComponentsOfType in interface ComponentStore

Parameters:

componentTypeId - The unique identifier of the component type

getComponentInDescendants

public <T extends Component> T getComponentInDescendants(java.lang.Class<T> clazz)

getComponentInDescendants

public <T extends Component> T getComponentInDescendants(int componentTypeId)

getComponentInDescendants

public <T extends Component> T getComponentInDescendants(java.lang.String name,
                                                         java.lang.Class<T> clazz)

getComponentInDescendants

public <T extends Component> T getComponentInDescendants(java.lang.String name,
                                                         int componentTypeId)

getComponentsInDescendants

public <T extends Component> java.util.SortedSet<T> getComponentsInDescendants(java.lang.Class<T> clazz)

getComponentsInDescendants

public <T extends Component> java.util.SortedSet<T> getComponentsInDescendants(int componentTypeId)

addEntityListener

public void addEntityListener(EntityListener listener)

Adds an EntityListener to this Entity

Parameters:

listener - The EntityListener to add

removeEntityListener

public void removeEntityListener(EntityListener listener)

Removes an EntityListener from this Entity

Parameters:

listener - The EntityListener to be removed

getUUID

public java.util.UUID getUUID()

getId

public int getId()