mr.robotto.scenetree

Class MrSceneTree

java.lang.Object

mr.robotto.scenetree.MrSceneTree

All Implemented Interfaces:

java.lang.Iterable<MrObject>

public class MrSceneTree
extends java.lang.Object
implements java.lang.Iterable<MrObject>

Main class for storing hierarchically, retrieve and traversal scene objects.

Constructor Summary

Constructors

Constructor and Description
MrSceneTree(MrObject root) Creates a new Scene Tree using the given object as root

Method Summary

Modifier and Type	Method and Description
boolean	addChild(MrObject parent, MrObject object)
boolean	addChildByKey(java.lang.String parentKey, MrObject object)
java.util.Iterator<MrObject>	breadthTraversal()
java.util.Iterator<MrObject>	breadthTraversal(MrObject object)
java.util.Iterator<MrObject>	breadthTraversalByKey(java.lang.String key)
void	clear()
boolean	contains(MrObject object)
boolean	containsKey(java.lang.String key)
java.util.Iterator<MrObject>	depthTraversal()
java.util.Iterator<MrObject>	depthTraversal(MrObject object)
java.util.Iterator<MrObject>	depthTraversalByKey(java.lang.String key)
MrObject	findByKey(java.lang.String key)
MrCamera	getActiveCamera()
java.util.List<MrObject>	getByType(MrSceneObjectType type)
java.util.List<MrObject>	getChildrenOf(MrObject object)
java.util.List<MrObject>	getChildrenOfByKey(java.lang.String key)
MrSceneTreeController	getController()
java.util.List<MrLight>	getLights()
java.util.List<MrModel>	getModels()
MrObject	getParentOf(MrObject object)
MrObject	getParentOfByKey(java.lang.String key)
MrRobottoEngine	getRobottoEngine() Gets the RobottoEngine instance this SceneTree is attached to
MrObject	getRoot()
MrScene	getScene()
java.util.Iterator<MrObject>	iterator()
java.util.Collection<java.lang.String>	keys()
java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>>	parentKeyChildValueTraversal()
java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>>	parentKeyChildValueTraversal(MrObject object)
java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>>	parentKeyChildValueTraversalByKey(java.lang.String key)
java.util.Iterator<MrObject>	parentTraversal(MrObject object)
java.util.Iterator<MrObject>	parentTraversalByKey(java.lang.String key)
boolean	remove(MrObject object)
boolean	removeByKey(java.lang.String parentKey)
void	setActiveCamera(MrCamera camera)
void	setRobottoEngine(MrRobottoEngine robottoEngine) Sets the RobottoEngine attached to this SceneTree
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MrSceneTree

public MrSceneTree(MrObject root)

Creates a new Scene Tree using the given object as root

Parameters:

root -

Method Detail

getRobottoEngine

public MrRobottoEngine getRobottoEngine()

Gets the RobottoEngine instance this SceneTree is attached to

Returns:

setRobottoEngine

public void setRobottoEngine(MrRobottoEngine robottoEngine)

Sets the RobottoEngine attached to this SceneTree

Parameters:

robottoEngine -

getController

public MrSceneTreeController getController()

addChildByKey

public boolean addChildByKey(java.lang.String parentKey,
                             MrObject object)

addChild

public boolean addChild(MrObject parent,
                        MrObject object)

removeByKey

public boolean removeByKey(java.lang.String parentKey)

remove

public boolean remove(MrObject object)

getByType

public java.util.List<MrObject> getByType(MrSceneObjectType type)

getRoot

public MrObject getRoot()

findByKey

public MrObject findByKey(java.lang.String key)

containsKey

public boolean containsKey(java.lang.String key)

contains

public boolean contains(MrObject object)

clear

public void clear()

keys

public java.util.Collection<java.lang.String> keys()

size

public int size()

getChildrenOfByKey

public java.util.List<MrObject> getChildrenOfByKey(java.lang.String key)

getParentOf

public MrObject getParentOf(MrObject object)

getParentOfByKey

public MrObject getParentOfByKey(java.lang.String key)

getChildrenOf

public java.util.List<MrObject> getChildrenOf(MrObject object)

parentTraversalByKey

public java.util.Iterator<MrObject> parentTraversalByKey(java.lang.String key)

breadthTraversalByKey

public java.util.Iterator<MrObject> breadthTraversalByKey(java.lang.String key)

depthTraversalByKey

public java.util.Iterator<MrObject> depthTraversalByKey(java.lang.String key)

parentKeyChildValueTraversalByKey

public java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>> parentKeyChildValueTraversalByKey(java.lang.String key)

parentTraversal

public java.util.Iterator<MrObject> parentTraversal(MrObject object)

breadthTraversal

public java.util.Iterator<MrObject> breadthTraversal(MrObject object)

depthTraversal

public java.util.Iterator<MrObject> depthTraversal(MrObject object)

parentKeyChildValueTraversal

public java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>> parentKeyChildValueTraversal(MrObject object)

breadthTraversal

public java.util.Iterator<MrObject> breadthTraversal()

depthTraversal

public java.util.Iterator<MrObject> depthTraversal()

parentKeyChildValueTraversal

public java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>> parentKeyChildValueTraversal()

iterator

public java.util.Iterator<MrObject> iterator()

Specified by:

iterator in interface java.lang.Iterable<MrObject>

getLights

public java.util.List<MrLight> getLights()

getModels

public java.util.List<MrModel> getModels()

getScene

public MrScene getScene()

getActiveCamera

public MrCamera getActiveCamera()

setActiveCamera

public void setActiveCamera(MrCamera camera)