org.achtern.AchternEngine.core.scenegraph

Class Node

java.lang.Object

org.achtern.AchternEngine.core.scenegraph.Node

All Implemented Interfaces:

EngineHolder<CoreEngine>, Renderable, Updatable

Direct Known Subclasses:

AxisDebugger, GridDebugger, ShortLifeNode

public class Node
extends Object
implements EngineHolder<CoreEngine>, Updatable, Renderable

A Node represents a part of the scenegraph. This Node manages a its subnodes (children) and set of Entity (entites).

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Node>	children Maps children's names to children.
protected CoreEngine	engine The active CoreEngine
protected ArrayList<Entity>	entities List of Entities, attached to this Node
protected String	name Node's name
protected Node	parent Parent Node.
protected SingleEntityRetriever	singleEntityRetriever Used in getEntity(Class)
protected Transform	transform Transform of this Node and all the attached Entities

Constructor Summary

Constructors

Constructor and Description
Node() Creates and untitled Node.
Node(String name) Create a new Node.

Method Summary

Methods

Modifier and Type	Method and Description
Node	add(Entity entity) Add an Entity to this Node.
Node	add(Node node) Adds Node as a children.
Node	add(Node node, boolean forceName) Adds Node as a children.
Map<String,Node>	getChildren() Returns List of child-Nodes
CoreEngine	getEngine() Retrieves the stored engine CoreEngine
List<Entity>	getEntities() Returns List of Entities
<T extends Entity> T	getEntity(Class<T> type) Convenience method.
String	getName() The name of this Node
Node	getParent()
Transform	getTransform() Returns the Transform associated with this Node and all it's Child-Entities.
boolean	remove(Entity entity) Remove Entity from this Node.
boolean	remove(Node node) Removes child Node from this Node.
boolean	remove(String nodeName) Remove Node by it's name
void	removed() When this Node has been removed from it's parent, this method will get called and notifies all children and child-entites.
void	render(RenderEngine renderEngine) Trigger an render.
void	setChildren(Map<String,Node> children) Replaces children.
void	setEngine(CoreEngine engine) Inject the engine CoreEngine.
void	setEntities(ArrayList<Entity> entities) Replaces Entities.
void	setName(String name) Set the name of this Node
void	setParent(Node parent)
void	setTransform(Transform transform) Replaces Transform
String	toString()
void	update(float delta) Trigger an update.

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected Node parent

Parent Node. (null if root node)

children

protected Map<String,Node> children

Maps children's names to children.

entities

protected ArrayList<Entity> entities

List of Entities, attached to this Node

transform

protected Transform transform

Transform of this Node and all the attached Entities

engine

protected CoreEngine engine

The active CoreEngine

name

protected String name

Node's name

singleEntityRetriever

protected SingleEntityRetriever singleEntityRetriever

Used in getEntity(Class)

Constructor Detail

Node

public Node(String name)

Create a new Node.

Parameters:

name - The name of the node

Node

public Node()

Creates and untitled Node. The name will be NULL until its getting added as a child to another node. (Then name will be "PARENT-NODE >> Untitled Node X" where X is the number of already existing subnodes.

Method Detail

update

public void update(float delta)

Trigger an update. Do you regular updating of nodes/entities in here.

Specified by:

update in interface Updatable

Parameters:

delta - The delta time

render

public void render(RenderEngine renderEngine)

Trigger an render. Do rendering releated stuff here.

Specified by:

render in interface Renderable

Parameters:

renderEngine - The active RenderEngine

add

public Node add(Node node)

Adds Node as a children. If a node with the same node exists, or the node's name is null a name will be auto generated.

Parameters:

node - New child

Returns:

this

add

public Node add(Node node,
       boolean forceName)

Adds Node as a children. If a node with the same node exists, or the node's name is null a name will be auto generated only if forceName=true

Parameters:

node - New child

forceName - Whether to prevent auto-generation of names

Returns:

this

add

public Node add(Entity entity)

Add an Entity to this Node. All Entites attached to this node, will share the same Transform.

Parameters:

entity - New Entity to add

Returns:

this

remove

public boolean remove(Node node)

Removes child Node from this Node.

Parameters:

node - Node to remove

Returns:

Whether the remove was successful (false if Node did not exist in children List)

remove

public boolean remove(String nodeName)

Remove Node by it's name

Parameters:

nodeName - Node's name

Returns:

Whether the remove was successful (false if Node did not exist in children List)

remove

public boolean remove(Entity entity)

Remove Entity from this Node. The Entity may still have this node as it's parent though. QuickEntity handles this problems and sets parent to null on removal. This will call Entity.removed() on the given Entity

Parameters:

entity - The Entity to remove

Returns:

Whether the remove was successful (false if Entity did not exist in List)

removed

public void removed()

When this Node has been removed from it's parent, this method will get called and notifies all children and child-entites.

getEntity

public <T extends Entity> T getEntity(Class<T> type)

Convenience method. It just wraps a SingleEntityRetriever and scans this node. Returns the first Entity if there were multiple of the given type! NOTE: This wall ALWAYS scan this whole node.

Type Parameters:

T - type of Entity

Parameters:

type - Class of type of Entity

Returns:

Entity | null

toString

public String toString()

Overrides:

toString in class Object

getChildren

public Map<String,Node> getChildren()

Returns List of child-Nodes

Returns:

children

setChildren

public void setChildren(Map<String,Node> children)

Replaces children. Be careful! removed() method won't get called.

Parameters:

children - New children

getEntities

public List<Entity> getEntities()

Returns List of Entities

Returns:

entities

setEntities

public void setEntities(ArrayList<Entity> entities)

Replaces Entities. Be careful! removed() method won't get called.

Parameters:

entities - New Entities

getTransform

public Transform getTransform()

Returns the Transform associated with this Node and all it's Child-Entities.

Returns:

Transform

setTransform

public void setTransform(Transform transform)

Replaces Transform

Parameters:

transform - New Transform

getEngine

public CoreEngine getEngine()

Retrieves the stored engine CoreEngine

Specified by:

getEngine in interface EngineHolder<CoreEngine>

Returns:

The stored engine

setEngine

public void setEngine(CoreEngine engine)

Inject the engine CoreEngine. Passes Engine to the children/entities if diffrent from currently stored.

Specified by:

setEngine in interface EngineHolder<CoreEngine>

Parameters:

engine - The engine to store

getName

public String getName()

The name of this Node

Returns:

name

setName

public void setName(String name)

Set the name of this Node

Parameters:

name - New name

getParent

public Node getParent()

setParent

public void setParent(Node parent)