heronarts.lx.model

Class LXModel

java.lang.Object

heronarts.lx.model.LXModel

All Implemented Interfaces:

LXSerializable

Direct Known Subclasses:

GridModel, GridModel.Strip, LXFixture.Submodel, StripModel

public class LXModel
extends Object
implements LXSerializable

An LXModel is a representation of a set of points in 3D space. Each LXPoint corresponds to a single point. Though the positions of points may be updated, a model is immutable. Its overall structure, number of points, and hierarchy of submodels may not be changed once it has been created. This class should generally not be used directly to construct model objects. It is heavily preferred to use the LXStructure and LXFixture APIs to dynamically generate a model. In cases where fixed-model programming is preferred, it is recommended to use the LXModelBuilder class to aid in model construction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXModel.Key A collection of helpful pre-defined constants for the most common model key types.
static interface	LXModel.Listener Listener interface for changes to the location of points in a model

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
LXVector	average Average position in the model (weighted by point density)
float	ax Average x point
float	ay Average y point
float	az Average z point
LXVector	center Center position in the model (half-way between extremes)
LXModel[]	children An immutable list of all the children of this model
float	cx Center of the model in x space
float	cy Center of the model in y space
float	cz Center of the model in z space
List<String>	keys A list of String keys by which this model type can be identified.
Map<String,String>	metaData An immutable map of String key/value pairs, metadata on the model object
List<LXOutput>	outputs An ordered list of outputs that should be sent for this model.
LXPoint[]	points An immutable list of all the points in this model
float	rcMax Greatest radius from center of model, this is only valid on the top-level LXModel
float	rcMin Smallest radius from center of model, this is only valid on the top-level LXModel
float	rcRange Range of radial values from center of model, only validd on the top-level LXModel
float	rMax Greatest radius from origin (0, 0)
float	rMin Smallest radius from origin (0, 0)
float	rRange Range of radial values from origin (0, 0)
int	size Total number of points in the model
LXMatrix	transform A transform matrix that represents the positioning of this model in the global space, if part of the structure.
float	xMax Maximum x value
float	xMin Minimum x value
float	xRange Range of x values
float	yMax Maximum y value
float	yMin Minimum y value
float	yRange Range of y values
float	zMax Maximum z value
float	zMin Minimum z value
float	zRange Range of z values

Constructor Summary

Constructors

Modifier	Constructor and Description
	LXModel() Constructs a null model with no points
	LXModel(List<LXPoint> points) Constructs a model from a list of points
	LXModel(List<LXPoint> points, LXModel[] children) Constructs a model with a given set of points and pre-constructed children.
	LXModel(List<LXPoint> points, LXModel[] children, Map<String,String> metaData, String... keys) Constructs a model with a given set of points and pre-constructed submodels.
	LXModel(List<LXPoint> points, LXModel[] children, String... keys) Constructs a model with a given set of points and pre-constructed submodels.
	LXModel(List<LXPoint> points, Map<String,String> metaData, String... keys) Constructs a model from a list of points
	LXModel(List<LXPoint> points, String... keys) Constructs a model from a list of points
	LXModel(LXModel[] children) Constructs a model from the given submodels.
	LXModel(LXModelBuilder builder)
protected	LXModel(LXModelBuilder builder, boolean isRoot)

Method Summary

Modifier and Type	Method and Description
LXModel	addListener(LXModel.Listener listener)
LXModel	bang() Should be invoked when some of the geometry inside a model has been changed, but the total point count and structure is the same.
List<LXModel>	children(String key) Returns a list of all the direct child components by particular key.
void	dispose()
int	getGeneration() Returns an integer identifying the generation of this model.
LXModel	getParent()
String	getPath()
List<LXPoint>	getPoints() Accessor for a list of all points in the model.
void	load(LX lx, JsonObject object) Restores this instance from a JSON object
String	meta(String key) Gets a meta data property
LXModel	normalizePoints() Sets the normalized values of all the points in this model (xn, yn, zn) relative to this model's absolute bounds.
LXModel	reindexPoints() Reindexes all the points in this model from 0 up to the number of points.
LXModel	removeListener(LXModel.Listener listener)
void	save(LX lx, JsonObject object) Serializes this instance into the JSON object
List<LXModel>	sub(String key) Returns a list of all the submodel components by particular key, at any level of depth, may be many levels of descendants contained here
int[]	toIndexBuffer() Creates an index buffer of all the point indices in this model.
int[]	toIndexBuffer(int offset, int length) Creates an index buffer of a subset of points in this model.
LXModel	update() Update the meta-values in this model.
LXModel	update(boolean normalize) Update the averages and mins/maxes of the model.
LXModel	update(boolean normalize, boolean recurse) Updates the averages and min/maxes of the model

Methods inherited from class java.lang.Object

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

Field Detail

transform

public final LXMatrix transform

A transform matrix that represents the positioning of this model in the global space, if part of the structure. For manually constructed models this value is undefined.

points

public final LXPoint[] points

An immutable list of all the points in this model

metaData

public final Map<String,String> metaData

An immutable map of String key/value pairs, metadata on the model object

children

public final LXModel[] children

An immutable list of all the children of this model

outputs

public final List<LXOutput> outputs

An ordered list of outputs that should be sent for this model.

keys

public final List<String> keys

A list of String keys by which this model type can be identified. Keys are non-empty strings. These keys can be used with the children(String) and sub(String) methods to dynamically navigate this model's hierarchy.

size

public final int size

Total number of points in the model

center

public final LXVector center

Center position in the model (half-way between extremes)

average

public final LXVector average

Average position in the model (weighted by point density)

cx

public float cx

Center of the model in x space

cy

public float cy

Center of the model in y space

cz

public float cz

Center of the model in z space

ax

public float ax

Average x point

ay

public float ay

Average y point

az

public float az

Average z point

xMin

public float xMin

Minimum x value

xMax

public float xMax

Maximum x value

xRange

public float xRange

Range of x values

yMin

public float yMin

Minimum y value

yMax

public float yMax

Maximum y value

yRange

public float yRange

Range of y values

zMin

public float zMin

Minimum z value

zMax

public float zMax

Maximum z value

zRange

public float zRange

Range of z values

rMin

public float rMin

Smallest radius from origin (0, 0)

rMax

public float rMax

Greatest radius from origin (0, 0)

rRange

public float rRange

Range of radial values from origin (0, 0)

rcMin

public float rcMin

Smallest radius from center of model, this is only valid on the top-level LXModel

rcMax

public float rcMax

Greatest radius from center of model, this is only valid on the top-level LXModel

rcRange

public float rcRange

Range of radial values from center of model, only validd on the top-level LXModel

Constructor Detail

LXModel

public LXModel()

Constructs a null model with no points

LXModel

public LXModel(List<LXPoint> points)

Constructs a model from a list of points

Parameters:

points - Points in the model

LXModel

public LXModel(List<LXPoint> points,
               String... keys)

Constructs a model from a list of points

Parameters:

points - Points in the model

keys - Key identifiers for the model type

LXModel

public LXModel(List<LXPoint> points,
               Map<String,String> metaData,
               String... keys)

Constructs a model from a list of points

Parameters:

points - Points in the model

metaData - Metadata for the model

keys - Key identifiers for the model type

LXModel

public LXModel(List<LXPoint> points,
               LXModel[] children)

Constructs a model with a given set of points and pre-constructed children. In this case, points from the children are not added to the points array, they are assumed to already be contained by the points list.

Parameters:

points - Points in this model

children - Pre-built direct child model array

LXModel

public LXModel(List<LXPoint> points,
               LXModel[] children,
               String... keys)

Constructs a model with a given set of points and pre-constructed submodels. In this case, points from the submodels are not added to the points array, they are assumed to already be contained by the points list.

Parameters:

points - Points in this model

children - Pre-built direct submodel child array

keys - Key identifier for this model

LXModel

public LXModel(List<LXPoint> points,
               LXModel[] children,
               Map<String,String> metaData,
               String... keys)

Constructs a model with a given set of points and pre-constructed submodels. In this case, points from the submodels are not added to the points array, they are assumed to already be contained by the points list.

Parameters:

points - Points in this model

children - Pre-built direct submodel child array

metaData - Metadata map

keys - Key identifier for this model

LXModel

public LXModel(LXModel[] children)

Constructs a model from the given submodels. The point list is generated from all points in the submodels, on the assumption that they have not yet been added.

Parameters:

children - Sub-models

LXModel

public LXModel(LXModelBuilder builder)

LXModel

protected LXModel(LXModelBuilder builder,
                  boolean isRoot)

Method Detail

getParent

public LXModel getParent()

getPath

public String getPath()

reindexPoints

public LXModel reindexPoints()

Reindexes all the points in this model from 0 up to the number of points.

Returns:

this

children

public List<LXModel> children(String key)

Returns a list of all the direct child components by particular key. Children are only one-level deep.

Parameters:

key - Child key type

Returns:

List of direct children by type

sub

public List<LXModel> sub(String key)

Returns a list of all the submodel components by particular key, at any level of depth, may be many levels of descendants contained here

Parameters:

key - Submodel key

Returns:

List of all descendant submodels

meta

public String meta(String key)

Gets a meta data property

Parameters:

key - Meta data key

Returns:

Value if there is one, otherwise null

addListener

public final LXModel addListener(LXModel.Listener listener)

removeListener

public final LXModel removeListener(LXModel.Listener listener)

update

public LXModel update()

Update the meta-values in this model. Re-normalizes the points relative to this model and recomputes its averages.

Returns:

this

update

public LXModel update(boolean normalize)

Update the averages and mins/maxes of the model.

Parameters:

normalize - If true, normalize the points relative to this model

Returns:

this

update

public LXModel update(boolean normalize,
                      boolean recurse)

Updates the averages and min/maxes of the model

Parameters:

normalize - If true, normalize the points relative to this model

recurse - If true, compute averages for sub-models as well

Returns:

this

bang

public LXModel bang()

Should be invoked when some of the geometry inside a model has been changed, but the total point count and structure is the same. Will increment a sentinel value and notify listeners of the change.

Returns:

this

getGeneration

public int getGeneration()

Returns an integer identifying the generation of this model. Each time geometry in the model is changed, this value is incremented;

Returns:

Monotonically increasing integer verson number of the geometry revision

toIndexBuffer

public int[] toIndexBuffer()

Creates an index buffer of all the point indices in this model.

Returns:

Index buffer of all points in this model, containing their global color indices

toIndexBuffer

public int[] toIndexBuffer(int offset,
                           int length)

Creates an index buffer of a subset of points in this model.

Parameters:

offset - Initial offset into this model's points

length - Length of the index buffer

Returns:

Array that contains the global color buffer indices for the specified points in this model

normalizePoints

public LXModel normalizePoints()

Sets the normalized values of all the points in this model (xn, yn, zn) relative to this model's absolute bounds.

Returns:

this

getPoints

public List<LXPoint> getPoints()

Accessor for a list of all points in the model. Generally preferable to directly access the points array when iterating over a full buffer, but this is useful for situations where a container is needed.

Returns:

List of all points

save

public void save(LX lx,
                 JsonObject object)

Description copied from interface: LXSerializable

Serializes this instance into the JSON object

Specified by:

save in interface LXSerializable

Parameters:

lx - LX instance

object - Object to serialize into

load

public void load(LX lx,
                 JsonObject object)

Description copied from interface: LXSerializable

Restores this instance from a JSON object

Specified by:

load in interface LXSerializable

Parameters:

lx - LX instance

object - Object to deserialize

dispose

public void dispose()