Package com.luciad.view.lightspeed.services.effects

Class TLspGraphicsEffects

java.lang.Object

com.luciad.view.lightspeed.services.effects.TLspGraphicsEffects

All Implemented Interfaces:

ILcdCollection<ALspGraphicsEffect>, Iterable<ALspGraphicsEffect>, Collection<ALspGraphicsEffect>

public final class TLspGraphicsEffects
extends Object
implements ILcdCollection<ALspGraphicsEffect>

A central registry for global graphics effects in an ILspView. Examples of such effects include lighting and fog. This class is a Collection of ALspGraphicsEffect objects. Effects can be added to a view simply by inserting them into this collection.

Although effects are by default considered to be global for the whole view, it is possible to selectively prevent them from being applied to certain objects using ILspEffectsHintStyle.

This class is not thread-safe. Adding, removing or modifying graphics effects should only be done on the event dispatch thread.

Since:

2013.0

Constructor Summary

Constructors

Constructor	Description
TLspGraphicsEffects(ILspView aView)	Creates a new graphics effects registry.

Method Summary

Modifier and Type	Method	Description
boolean	add(ALspGraphicsEffect e)
boolean	addAll(Collection<? extends ALspGraphicsEffect> aCollection)
void	addCollectionListener(ILcdCollectionListener<ALspGraphicsEffect> aCollectionListener)	Register the listener aCollectionListener to be informed about changes in this collection.
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
<T extends ALspGraphicsEffect> Collection<T>	getEffectsByType(Class<T> aClass)	Returns the subset of effects which extend from the given class.
boolean	isEmpty()
Iterator<ALspGraphicsEffect>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> aCollection)
void	removeCollectionListener(ILcdCollectionListener<ALspGraphicsEffect> aCollectionListener)	Unregister the listener aCollectionListener so it will no longer be informed about changes in this collection.
boolean	retainAll(Collection<?> aCollection)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface com.luciad.util.collections.ILcdCollection

add, addAll, clear, fireCollectedChanges, remove, removeAll, retainAll

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

TLspGraphicsEffects

public TLspGraphicsEffects(ILspView aView)

Creates a new graphics effects registry. This constructor should not be called directly: each Lightspeed view creates its own TLspGraphicsEffects automatically and makes it available via TLspViewServices.

Parameters:

aView - the view for which graphics effects are to be managed

Method Details

getEffectsByType

public <T extends ALspGraphicsEffect> Collection<T> getEffectsByType(Class<T> aClass)

Returns the subset of effects which extend from the given class.

Type Parameters:

T - only descendants of ALspGraphicsEffect are accepted

Parameters:

aClass - the type of effect that is being requested

Returns:

list of effects that inherit from T (may be empty)

addAll

public boolean addAll(Collection<? extends ALspGraphicsEffect> aCollection)

Description copied from interface: ILcdCollection

The elements should be added to the Collection one by one, and an TLcdCollectionEvent fired each time an element has been added.

This method immediately fires change events to its registered change listeners. If this collection is protected by a read/write lock, call ILcdCollection.addAll(Collection, int) instead with the ILcdFireEventMode.FIRE_LATER fire event mode, and subsequently call ILcdCollection.fireCollectedChanges() after the lock has been released. This can avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

addAll in interface Collection<ALspGraphicsEffect>

Specified by:

addAll in interface ILcdCollection<ALspGraphicsEffect>

See Also:

• ILcdCollection.addAll(Collection, int)

removeAll

public boolean removeAll(Collection<?> aCollection)

Description copied from interface: ILcdCollection

The elements should be removed from the Collection one by one, and an TLcdCollectionEvent fired each time an element has been removed.

This method immediately fires change events to its registered change listeners. If this collection is protected by a read/write lock, call ILcdCollection.removeAll(Collection, int) instead with the ILcdFireEventMode.FIRE_LATER fire event mode, and subsequently call ILcdCollection.fireCollectedChanges() after the lock has been released. This can avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

removeAll in interface Collection<ALspGraphicsEffect>

Specified by:

removeAll in interface ILcdCollection<ALspGraphicsEffect>

See Also:

• ILcdCollection.removeAll(Collection, int)

retainAll

public boolean retainAll(Collection<?> aCollection)

Description copied from interface: ILcdCollection

The elements should be removed from the Collection one by one, and an TLcdCollectionEvent fired each time an element has been removed.

This method immediately fires change events to its registered change listeners. If this collection is protected by a read/write lock, call ILcdCollection.retainAll(Collection, int) instead with the ILcdFireEventMode.FIRE_LATER fire event mode, and subsequently call ILcdCollection.fireCollectedChanges() after the lock has been released. This can avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

retainAll in interface Collection<ALspGraphicsEffect>

Specified by:

retainAll in interface ILcdCollection<ALspGraphicsEffect>

See Also:

• ILcdCollection.retainAll(Collection, int)

clear

public void clear()

Description copied from interface: ILcdCollection

The elements should be removed from the Collection one by one, and an TLcdCollectionEvent fired each time an element has been removed.

This method immediately fires change events to its registered change listeners. If this collection is protected by a read/write lock, call ILcdCollection.clear(int) instead with the ILcdFireEventMode.FIRE_LATER fire event mode, and subsequently call ILcdCollection.fireCollectedChanges() after the lock has been released. This can avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

clear in interface Collection<ALspGraphicsEffect>

Specified by:

clear in interface ILcdCollection<ALspGraphicsEffect>

See Also:

• ILcdCollection.clear(int)

addCollectionListener

public void addCollectionListener(ILcdCollectionListener<ALspGraphicsEffect> aCollectionListener)

Description copied from interface: ILcdCollection

Register the listener aCollectionListener to be informed about changes in this collection.

Specified by:

addCollectionListener in interface ILcdCollection<ALspGraphicsEffect>

Parameters:

aCollectionListener - the listener

See Also:

• ILcdCollection.removeCollectionListener(ILcdCollectionListener)

removeCollectionListener

public void removeCollectionListener(ILcdCollectionListener<ALspGraphicsEffect> aCollectionListener)

Description copied from interface: ILcdCollection

Unregister the listener aCollectionListener so it will no longer be informed about changes in this collection.

This method should do nothing when aCollectionListener was not registered previously.

Specified by:

removeCollectionListener in interface ILcdCollection<ALspGraphicsEffect>

Parameters:

aCollectionListener - the listener

See Also:

• ILcdCollection.addCollectionListener(ILcdCollectionListener)

size

public int size()

Specified by:

size in interface Collection<ALspGraphicsEffect>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<ALspGraphicsEffect>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<ALspGraphicsEffect>

iterator

public Iterator<ALspGraphicsEffect> iterator()

Specified by:

iterator in interface Collection<ALspGraphicsEffect>

Specified by:

iterator in interface Iterable<ALspGraphicsEffect>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<ALspGraphicsEffect>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<ALspGraphicsEffect>

add

public boolean add(ALspGraphicsEffect e)

Description copied from interface: ILcdCollection

This method immediately fires change events to its registered change listeners. If this collection is protected by a read/write lock, call ILcdCollection.add(Object, int) instead with the ILcdFireEventMode.FIRE_LATER fire event mode, and subsequently call ILcdCollection.fireCollectedChanges() after the lock has been released. This can avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

add in interface Collection<ALspGraphicsEffect>

Specified by:

add in interface ILcdCollection<ALspGraphicsEffect>

See Also:

• ILcdCollection.add(Object, int)

remove

public boolean remove(Object o)

Description copied from interface: ILcdCollection

This method immediately fires change events to its registered change listeners. If this collection is protected by a read/write lock, call ILcdCollection.remove(Object, int) instead with the ILcdFireEventMode.FIRE_LATER fire event mode, and subsequently call ILcdCollection.fireCollectedChanges() after the lock has been released. This can avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

remove in interface Collection<ALspGraphicsEffect>

Specified by:

remove in interface ILcdCollection<ALspGraphicsEffect>

See Also:

• ILcdCollection.remove(Object, int)

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<ALspGraphicsEffect>