com.jme3.light

Class LightList

java.lang.Object

com.jme3.light.LightList

All Implemented Interfaces:

Savable, JmeCloneable, java.lang.Cloneable, java.lang.Iterable<Light>

public final class LightList
extends java.lang.Object
implements java.lang.Iterable<Light>, Savable, java.lang.Cloneable, JmeCloneable

LightList is used internally by Spatials to manage lights that are attached to them.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LightList() constructor for serialization.
	LightList(Spatial owner) Creates a LightList for the given Spatial.

Method Summary

Modifier and Type	Method and Description
void	add(Light l) Adds a light to the list.
void	clear() Resets list size to 0.
LightList	clone()
void	cloneFields(Cloner cloner, java.lang.Object original) Implemented to perform deep cloning for this object, resolving local cloned references using the specified cloner.
Light	get(int num)
java.util.Iterator<Light>	iterator() Returns an iterator that can be used to iterate over this LightList.
LightList	jmeClone() Performs a regular shallow clone of the object.
void	read(JmeImporter im)
void	remove(int index) Remove the light at the given index.
void	remove(Light l) Removes the given light from the LightList.
void	setOwner(Spatial owner) Set the owner of the LightList.
int	size()
void	sort(boolean transformChanged) Sorts the elements in the list according to their Comparator.
void	update(LightList local, LightList parent) Updates a "world-space" light list, using the spatial's local-space light list and its parent's world-space light list.
void	write(JmeExporter ex)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LightList

protected LightList()

constructor for serialization. Do not use

LightList

public LightList(Spatial owner)

Creates a LightList for the given Spatial.

Parameters:

owner - The spatial owner

Method Detail

setOwner

public void setOwner(Spatial owner)

Set the owner of the LightList. Only used for cloning.

Parameters:

owner - the desired owner (alias created)

add

public void add(Light l)

Adds a light to the list. List size is doubled if there is no room.

Parameters:

l - The light to add.

remove

public void remove(int index)

Remove the light at the given index.

Parameters:

index - the zero-based index of the Light to be removed (≥0)

remove

public void remove(Light l)

Removes the given light from the LightList.

Parameters:

l - the light to remove

size

public int size()

Returns:

The size of the list.

get

public Light get(int num)

Parameters:

num - the zero-based index of the light to be accessed (≥0)

Returns:

the light at the given index.

Throws:

java.lang.IndexOutOfBoundsException - If the given index is outside bounds.

clear

public void clear()

Resets list size to 0.

sort

public void sort(boolean transformChanged)

Sorts the elements in the list according to their Comparator. There are two reasons why lights should be resorted. First, if the lights have moved, that means their distance to the spatial changed. Second, if the spatial itself moved, it means the distance from it to the individual lights might have changed.

Parameters:

transformChanged - Whether the spatial's transform has changed

update

public void update(LightList local,
                   LightList parent)

Updates a "world-space" light list, using the spatial's local-space light list and its parent's world-space light list.

Parameters:

local - the local-space LightList (not null)

parent - the parent's world-space LightList

iterator

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

Returns an iterator that can be used to iterate over this LightList.

Specified by:

iterator in interface java.lang.Iterable<Light>

Returns:

an iterator that can be used to iterate over this LightList.

clone

public LightList clone()

Overrides:

clone in class java.lang.Object

jmeClone

public LightList jmeClone()

Description copied from interface: JmeCloneable

Performs a regular shallow clone of the object. Some fields may also be cloned but generally only if they will never be shared with other objects. (For example, local Vector3fs and so on.)

This method is separate from the regular clone() method so that objects might still maintain their own regular java clone() semantics (perhaps even using Cloner for those methods). However, because Java's clone() has specific features in the sense of Object's clone() implementation, it's usually best to have some path for subclasses to bypass the public clone() method that might be cloning fields and instead get at the superclass protected clone() methods. For example, through super.jmeClone() or another protected clone method that some base class eventually calls super.clone() in.

Specified by:

jmeClone in interface JmeCloneable

Returns:

a new instance

cloneFields

public void cloneFields(Cloner cloner,
                        java.lang.Object original)

Description copied from interface: JmeCloneable

Implemented to perform deep cloning for this object, resolving local cloned references using the specified cloner. The object can call cloner.clone(fieldValue) to deep clone any of its fields.

Note: during normal clone operations the original object will not be needed as the clone has already had all of the fields shallow copied.

Specified by:

cloneFields in interface JmeCloneable

Parameters:

cloner - The cloner that is performing the cloning operation. The cloneFields method can call back into the cloner to make clones of its subordinate fields.

original - The original object from which this object was cloned. This is provided for the very rare case that this object needs to refer to its original for some reason. In general, all of the relevant values should have been transferred during the shallow clone, and this object need only clone what it wants.

write

public void write(JmeExporter ex)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

read

public void read(JmeImporter im)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException