Package com.simsilica.lemur.effect

Class EffectControl<T extends Spatial>

java.lang.Object

com.jme3.scene.control.AbstractControl

com.simsilica.lemur.effect.EffectControl<T>

All Implemented Interfaces:

Savable, Control, JmeCloneable, Cloneable

public class EffectControl<T extends Spatial>
extends AbstractControl

Manages the available named Effects for a Spatial and keeps track of the existing effects run for a particular channel. Callers can run any of the configured effects by name.

Field Summary

Fields inherited from class com.jme3.scene.control.AbstractControl

enabled, spatial

Constructor Summary

Constructors

Constructor	Description
EffectControl()	Creates an effect control that will run animations using the default animation state returned by AnimationState.getDefaultInstance().
EffectControl(AnimationState anim)	Creates an effect control that will use the specified AnimationState for running its effects.

Method Summary

Modifier and Type	Method	Description
void	addEffect(String name, Effect<? super T> effect)
protected AnimationState	anim()
protected void	controlRender(RenderManager rm, ViewPort vp)	To be implemented in subclass.
protected void	controlUpdate(float tpf)	To be implemented in subclass.
Map<String,Effect<? super T>>	getEffects()
T	getSpatial()	Type-parameter safe version of getSpatial().
boolean	hasEffect(String name)
Effect<? super T>	removeEffect(String name)
EffectInfo	runEffect(String name)
EffectInfo	runEffect(String name, boolean fastForward)

Methods inherited from class com.jme3.scene.control.AbstractControl

cloneFields, cloneForSpatial, isEnabled, jmeClone, read, render, setEnabled, setSpatial, update, write

Methods inherited from class java.lang.Object

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

Constructor Details

EffectControl

public EffectControl(AnimationState anim)

Creates an effect control that will use the specified AnimationState for running its effects. Normally an application will only have one AnimationState but it's possible to have multiple states depending on need. For example, the UI might be run by one AnimationState while certain in-game controls run by a different AnimationState so that they can be paused without affecting the UI.

EffectControl

public EffectControl()

Creates an effect control that will run animations using the default animation state returned by AnimationState.getDefaultInstance().

Method Details

getSpatial

public T getSpatial()

Type-parameter safe version of getSpatial().

Overrides:

getSpatial in class AbstractControl

anim

protected AnimationState anim()

addEffect

public void addEffect(String name,
 Effect<? super T> effect)

hasEffect

public boolean hasEffect(String name)

removeEffect

public Effect<? super T> removeEffect(String name)

getEffects

public Map<String,Effect<? super T>> getEffects()

runEffect

public EffectInfo runEffect(String name)

runEffect

public EffectInfo runEffect(String name,
 boolean fastForward)

controlUpdate

protected void controlUpdate(float tpf)

Description copied from class: AbstractControl

To be implemented in subclass.

Specified by:

controlUpdate in class AbstractControl

Parameters:

tpf - time per frame (in seconds)

controlRender

protected void controlRender(RenderManager rm,
 ViewPort vp)

Description copied from class: AbstractControl

To be implemented in subclass.

Specified by:

controlRender in class AbstractControl

Parameters:

rm - the RenderManager rendering the controlled Spatial (not null)

vp - the ViewPort being rendered (not null)