com.luciad.view.lightspeed.services.effects

LuciadLightspeedClass TLspGraphicsEffects

java.lang.Object

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

All Implemented Interfaces:

ILcdCollection<ALspGraphicsEffect>, java.lang.Iterable<ALspGraphicsEffect>, java.util.Collection<ALspGraphicsEffect>

public final class TLspGraphicsEffects
extends java.lang.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 and Description
TLspGraphicsEffects(ILspView aView) Creates a new graphics effects registry.

Method Summary

Modifier and Type	Method and Description
boolean	add(ALspGraphicsEffect e)
boolean	addAll(java.util.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(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
<T extends ALspGraphicsEffect> java.util.Collection<T>	getEffectsByType(java.lang.Class<T> aClass) Returns the subset of effects which extend from the given class.
boolean	isEmpty()
java.util.Iterator<ALspGraphicsEffect>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.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(java.util.Collection<?> aCollection)
int	size()
java.lang.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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

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 Detail

getEffectsByType

public <T extends ALspGraphicsEffect> java.util.Collection<T> getEffectsByType(java.lang.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(java.util.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.

Specified by:

addAll in interface ILcdCollection<ALspGraphicsEffect>

Specified by:

addAll in interface java.util.Collection<ALspGraphicsEffect>

removeAll

public boolean removeAll(java.util.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.

Specified by:

removeAll in interface ILcdCollection<ALspGraphicsEffect>

Specified by:

removeAll in interface java.util.Collection<ALspGraphicsEffect>

retainAll

public boolean retainAll(java.util.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.

Specified by:

retainAll in interface ILcdCollection<ALspGraphicsEffect>

Specified by:

retainAll in interface java.util.Collection<ALspGraphicsEffect>

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.

Specified by:

clear in interface ILcdCollection<ALspGraphicsEffect>

Specified by:

clear in interface java.util.Collection<ALspGraphicsEffect>

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 addCollectionListener 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 java.util.Collection<ALspGraphicsEffect>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<ALspGraphicsEffect>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<ALspGraphicsEffect>

iterator

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

Specified by:

iterator in interface java.lang.Iterable<ALspGraphicsEffect>

Specified by:

iterator in interface java.util.Collection<ALspGraphicsEffect>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<ALspGraphicsEffect>

toArray

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

Specified by:

toArray in interface java.util.Collection<ALspGraphicsEffect>

add

public boolean add(ALspGraphicsEffect e)

Specified by:

add in interface java.util.Collection<ALspGraphicsEffect>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<ALspGraphicsEffect>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<ALspGraphicsEffect>