de.lessvoid.nifty.effects
Class Effect

java.lang.Object
  extended by de.lessvoid.nifty.effects.Effect

public class Effect
extends Object

An effect can be active or not and is always attached to one element. It has a TimeInterpolator that manages the life time of the effect. The actual effect implementation is done be EffectImpl implementations.

Author:
void

Constructor Summary
Effect(Nifty niftyParam, boolean inheritParam, boolean postParam, boolean overlayParam, String alternateEnableParam, String alternateDisableParam, String customKeyParam, boolean neverStopRenderingParam, EffectEventId effectEventIdParam)
           
 
Method Summary
 boolean customKeyMatches(String customKeyToCheck)
           
 void deactivate()
           
 void enableHover(Falloff falloffParameter)
           
 void enableInfinite()
           
 void execute(NiftyRenderEngine r)
           
 String getAlternate()
           
 boolean getCustomFlag()
           
 String getCustomKey()
           
<T extends EffectImpl>
T
getEffectImpl(Class<T> requestedClass)
           
 EffectProperties getParameters()
           
 String getStateString()
           
 void hoverDistance(int x, int y)
           
 void init(Element elementParam, EffectImpl effectImplParam, EffectProperties parameterParam, TimeProvider timeParam, LinkedList<Object> controllers)
           
 boolean isActive()
           
 boolean isAlternateDisable()
           
 boolean isHoverEffect()
           
 boolean isInherit()
           
 boolean isInsideFalloff(int x, int y)
           
 boolean isNeverStopRendering()
           
 boolean isOverlay()
           
 boolean isPost()
           
 void setCustomFlag(boolean customFlag)
           
 boolean start(String alternate, String customKey)
           
 void update()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Effect

public Effect(Nifty niftyParam,
              boolean inheritParam,
              boolean postParam,
              boolean overlayParam,
              String alternateEnableParam,
              String alternateDisableParam,
              String customKeyParam,
              boolean neverStopRenderingParam,
              EffectEventId effectEventIdParam)
Method Detail

enableHover

public void enableHover(Falloff falloffParameter)

enableInfinite

public void enableInfinite()

init

public void init(Element elementParam,
                 EffectImpl effectImplParam,
                 EffectProperties parameterParam,
                 TimeProvider timeParam,
                 LinkedList<Object> controllers)

start

public boolean start(String alternate,
                     String customKey)

update

public void update()

execute

public void execute(NiftyRenderEngine r)

isActive

public boolean isActive()

deactivate

public void deactivate()

isPost

public boolean isPost()

isAlternateDisable

public boolean isAlternateDisable()

customKeyMatches

public boolean customKeyMatches(String customKeyToCheck)

getStateString

public String getStateString()

getEffectImpl

public <T extends EffectImpl> T getEffectImpl(Class<T> requestedClass)

isInherit

public boolean isInherit()

isHoverEffect

public boolean isHoverEffect()

hoverDistance

public void hoverDistance(int x,
                          int y)

isInsideFalloff

public boolean isInsideFalloff(int x,
                               int y)

isOverlay

public boolean isOverlay()

isNeverStopRendering

public boolean isNeverStopRendering()

getParameters

public EffectProperties getParameters()

getAlternate

public String getAlternate()

getCustomKey

public String getCustomKey()

getCustomFlag

public boolean getCustomFlag()

setCustomFlag

public void setCustomFlag(boolean customFlag)


Copyright © 2012. All Rights Reserved.