org.achtern.AchternEngine.core.scenegraph.scanning

Class EntityRetriever

java.lang.Object

org.achtern.AchternEngine.core.scenegraph.scanning.EntityRetriever

All Implemented Interfaces:

NodeScanner, SceneGraphRetriever<Entity>

Direct Known Subclasses:

FigureRetriever, SingleEntityRetriever

public abstract class EntityRetriever
extends Object
implements SceneGraphRetriever<Entity>

Basic Implementation of the SceneGraphRetriever, valid for all Entities.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Entity>	entities Entites found while scanning
protected List<Node>	nodes Nodes found while scanning

Constructor Summary

Constructors

Constructor and Description
EntityRetriever()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contained() Should return true if at least ONE Entity has been found.
List<Entity>	getAll() Call #scan(Node) first!
<E extends Entity> List<E>	getAll(Class<E> filter) Return all Entities, which life in the scanned node and it's children.
protected List<Entity>	getAll(Node node) This method flattens a scenegraph, NOTE: this method adds all encountered nodes to the object's nodes list.
protected List<Entity>	getAll(Node node, boolean addNodes) This method flattens a scenegraph
List<Node>	getNodes() Call #scan(Node) first!
void	scan(Node node) Performs the search.

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected List<Node> nodes

Nodes found while scanning

entities

protected List<Entity> entities

Entites found while scanning

Constructor Detail

EntityRetriever

public EntityRetriever()

Method Detail

scan

public void scan(Node node)

Performs the search.

Specified by:

scan in interface NodeScanner

Parameters:

node - Node to scan

See Also:

getAll(Node, boolean)

getAll

public List<Entity> getAll()

Call #scan(Node) first! Returns all Entities

Specified by:

getAll in interface SceneGraphRetriever<Entity>

Returns:

flattend List of all Entities

getNodes

public List<Node> getNodes()

Call #scan(Node) first! Returns all Nodes

Specified by:

getNodes in interface SceneGraphRetriever<Entity>

Returns:

flattend List of all Nodes

contained

public boolean contained()

Should return true if at least ONE Entity has been found.

Specified by:

contained in interface SceneGraphRetriever<Entity>

Returns:

Whether the Entity type is contained by the scanned node.

getAll

public <E extends Entity> List<E> getAll(Class<E> filter)

Return all Entities, which life in the scanned node and it's children. In addition to that you can apply another type filter

Specified by:

getAll in interface SceneGraphRetriever<Entity>

Type Parameters:

E - Filtered type

Parameters:

filter - Entity Filter

Returns:

List of filtered entities

getAll

protected List<Entity> getAll(Node node)

This method flattens a scenegraph, NOTE: this method adds all encountered nodes to the object's nodes list.

Parameters:

node - The node to flatten

Returns:

flattened entity list

getAll

protected List<Entity> getAll(Node node,
                  boolean addNodes)

This method flattens a scenegraph

Parameters:

node - The node to flatten

addNodes - Whether to add encountered nodes to the object's node list

Returns:

flattened entity list