heronarts.lx.model

Class LXModelBuilder

java.lang.Object

heronarts.lx.model.LXModelBuilder

public class LXModelBuilder
extends Object

A utility class with a simple interface, used to procedurally construct model objects. Each instance of a builder should only be used to produce one model. After it's been produced, methods cannot be called to modify the contents anymore. This class is significantly simpler than LXModel in the amount of functionality exported, with only the components needed for construction. It is mutable up until the moment it has been converted into a model, at which point no further modifications are allowed.

Constructor Summary

Constructors

Constructor and Description
LXModelBuilder() Construct a model-builder with the default model key
LXModelBuilder(String... keys) Construct a model-builder with the given set of model keys

Method Summary

Modifier and Type	Method and Description
LXModelBuilder	addChild(LXModelBuilder child) Add a child builder to this model.
LXModelBuilder	addKey(String key) Add a key to the list of this model's key types
LXModelBuilder	addOutput(LXOutput output) Add a output to this model
LXModelBuilder	addPoint(LXPoint p) Add a point to the model
LXModelBuilder	addPoints(LXPoint... points) Add a list of points to the model
LXModelBuilder	setKeys(String... keys) Set the model type keys array
int[]	toIndexBuffer() Converts this builder into an index buffer of all its points
LXModel	toModel() Converts the builder into an immutable model

Methods inherited from class java.lang.Object

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

Constructor Detail

LXModelBuilder

public LXModelBuilder()

Construct a model-builder with the default model key

LXModelBuilder

public LXModelBuilder(String... keys)

Construct a model-builder with the given set of model keys

Parameters:

keys - Model type keys

Method Detail

addKey

public LXModelBuilder addKey(String key)

Add a key to the list of this model's key types

Parameters:

key - Model key type

Returns:

this

setKeys

public LXModelBuilder setKeys(String... keys)

Set the model type keys array

Parameters:

keys - Key types

Returns:

this

addPoint

public LXModelBuilder addPoint(LXPoint p)

Add a point to the model

Parameters:

p - Point

Returns:

this

addPoints

public LXModelBuilder addPoints(LXPoint... points)

Add a list of points to the model

Parameters:

points - Points

Returns:

this

addChild

public LXModelBuilder addChild(LXModelBuilder child)

Add a child builder to this model.

Parameters:

child - Child

Returns:

this

addOutput

public LXModelBuilder addOutput(LXOutput output)

Add a output to this model

Parameters:

output - Output object

Returns:

this

toIndexBuffer

public int[] toIndexBuffer()

Converts this builder into an index buffer of all its points

Returns:

Index buffer of points in this model builder

toModel

public LXModel toModel()

Converts the builder into an immutable model

Returns:

LXModel instantiation of this builder