com.artemis

Class Aspect

java.lang.Object

com.artemis.Aspect

public class Aspect
extends Object

An Aspect is used by systems as a matcher against entities, to check if a system is interested in an entity.

Aspects define what sort of component types an entity must possess, or not possess.

This creates an aspect where an entity must possess A and B and C:
Aspect.all(A.class, B.class, C.class)

This creates an aspect where an entity must possess A and B and C, but must not possess U or V.
Aspect.all(A.class, B.class, C.class).exclude(U.class, V.class)

This creates an aspect where an entity must possess A and B and C, but must not possess U or V, but must possess one of X or Y or Z.
Aspect.all(A.class, B.class, C.class).exclude(U.class, V.class).one(X.class, Y.class, Z.class)

You can create and compose aspects in many ways:
Aspect.one(X.class, Y.class, Z.class).all(A.class, B.class, C.class).exclude(U.class, V.class)
is the same as:
Aspect.all(A.class, B.class, C.class).exclude(U.class, V.class).one(X.class, Y.class, Z.class)

Author:

Arni Arent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Aspect.Builder Constructs instances of Aspect.

Method Summary

Modifier and Type	Method and Description
static Aspect.Builder	all() Returns an aspect that matches all entities.
static Aspect.Builder	all(Class<? extends Component>... types) Returns an aspect where an entity must possess all of the specified component types.
static Aspect.Builder	all(Collection<Class<? extends Component>> types) Returns an aspect where an entity must possess all of the specified component types.
static Aspect.Builder	exclude(Class<? extends Component>... types) Excludes all of the specified component types from the aspect.
static Aspect.Builder	exclude(Collection<Class<? extends Component>> types) Excludes all of the specified component types from the aspect.
BitVector	getAllSet() Get a BitVector containing bits of components the entity must all possess.
BitVector	getExclusionSet() Get a BitVector containing bits of components the entity must not possess.
BitVector	getOneSet() Get a BitVector containing bits of components of which the entity must possess atleast one.
boolean	isInterested(BitVector componentBits) Returns whether this Aspect would accept the given set.
boolean	isInterested(Entity e) Returns whether this Aspect would accept the given Entity.
static Aspect.Builder	one(Class<? extends Component>... types) Returns an aspect where an entity must possess one of the specified component types.
static Aspect.Builder	one(Collection<Class<? extends Component>> types) Returns an aspect where an entity must possess one of the specified component types.

Methods inherited from class java.lang.Object

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

Method Detail

getAllSet

public BitVector getAllSet()

Get a BitVector containing bits of components the entity must all possess.

Returns:

the "all" BitVector

getExclusionSet

public BitVector getExclusionSet()

Get a BitVector containing bits of components the entity must not possess.

Returns:

the "exclusion" BitVector

getOneSet

public BitVector getOneSet()

Get a BitVector containing bits of components of which the entity must possess atleast one.

Returns:

the "one" BitVector

isInterested

public boolean isInterested(Entity e)

Returns whether this Aspect would accept the given Entity.

isInterested

public boolean isInterested(BitVector componentBits)

Returns whether this Aspect would accept the given set.

all

public static Aspect.Builder all()

Returns an aspect that matches all entities.

Returns:

an aspect that can be matched against entities

all

@SafeVarargs
public static Aspect.Builder all(Class<? extends Component>... types)

Returns an aspect where an entity must possess all of the specified component types.

Parameters:

types - a required component type

Returns:

an aspect that can be matched against entities

all

public static Aspect.Builder all(Collection<Class<? extends Component>> types)

Returns an aspect where an entity must possess all of the specified component types.

Parameters:

types - a required component type

Returns:

an aspect that can be matched against entities

exclude

@SafeVarargs
public static Aspect.Builder exclude(Class<? extends Component>... types)

Excludes all of the specified component types from the aspect.

A system will not be interested in an entity that possesses one of the specified exclusion component types.

Parameters:

types - component type to exclude

Returns:

an aspect that can be matched against entities

exclude

public static Aspect.Builder exclude(Collection<Class<? extends Component>> types)

Excludes all of the specified component types from the aspect.

A system will not be interested in an entity that possesses one of the specified exclusion component types.

Parameters:

types - component type to exclude

Returns:

an aspect that can be matched against entities

one

@SafeVarargs
public static Aspect.Builder one(Class<? extends Component>... types)

Returns an aspect where an entity must possess one of the specified component types.

Parameters:

types - one of the types the entity must possess

Returns:

an aspect that can be matched against entities

one

public static Aspect.Builder one(Collection<Class<? extends Component>> types)

Returns an aspect where an entity must possess one of the specified component types.

Parameters:

types - one of the types the entity must possess

Returns:

an aspect that can be matched against entities