org.achtern.AchternEngine.core.util

Class FigureProvider

java.lang.Object

org.achtern.AchternEngine.core.util.FigureProvider

All Implemented Interfaces:

NodeProvider

public class FigureProvider
extends Object
implements NodeProvider

A FigureProvider can be used to quickly add a lot of Figures to a scene, from [figure].json files. Exceptions thrown from the ResourceLoader will get catched and rethrown as RuntimeException.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected List<String>	names

Constructor Summary

Constructors

Constructor and Description
FigureProvider(String name, List<String> names) Construct a new FigureProvider...
FigureProvider(String name, String... names) Construct a new FigureProvider...

Method Summary

Modifier and Type	Method and Description
Node	get() Returns the following Node Structure: FigureProvider f = new FigureProvider("name", "floor", "another"); f.get(); | Node(name) | | -> | Node(floor) | | -> Figure(floor) | | -> | Node(another) | | -> Figure(another)
Node	inject(Node target) The figure names were given in the constructor.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

names

protected List<String> names

Constructor Detail

FigureProvider

public FigureProvider(String name,
                      List<String> names)

Construct a new FigureProvider...

Parameters:

name - Name of the root Node returned

names - Names of json figure declarations

FigureProvider

public FigureProvider(String name,
                      String... names)

Construct a new FigureProvider... The first name parameter can be ignored, if one is using inject(Node) exclusively.

Parameters:

name - Name of the root Node returned

names - Names of json figure declarations

Method Detail

get

public Node get()

Returns the following Node Structure:
FigureProvider f = new FigureProvider("name", "floor", "another"); f.get();

 
 | Node(name)
 |
 | -> | Node(floor)
 |    | -> Figure(floor)
 |
 | -> | Node(another)
 |    | -> Figure(another)


 
 

Specified by:

get in interface NodeProvider

Returns:

Node Tree

Throws:

RuntimeException - when an exception is thrown from the ResourceLoader

inject

public Node inject(Node target)

The figure names were given in the constructor. This method will load all the given figures and inject them into the target node:
target.add(ResourceLoader.getFigure(name).boxed()); This method just returns the given target, for easier method chaining.

Parameters:

target - all loaded boxed figures will be added to the target's children

Returns:

target parameter

Throws:

RuntimeException - when an exception is thrown from the ResourceLoader