com.threerings.opengl.effect
Class ColorFunction.Linear

java.lang.Object
  extended by com.threerings.util.DeepObject
      extended by com.threerings.opengl.effect.ColorFunction
          extended by com.threerings.opengl.effect.ColorFunction.Linear
All Implemented Interfaces:
Exportable, com.threerings.io.Streamable, Copyable, Cloneable
Enclosing class:
ColorFunction

public static class ColorFunction.Linear
extends ColorFunction

A color function that blends linearly between two colors.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.threerings.opengl.effect.ColorFunction
ColorFunction.Constant, ColorFunction.InAndOut, ColorFunction.Linear, ColorFunction.Multipoint, ColorFunction.ThreePoint
 
Nested classes/interfaces inherited from interface com.threerings.io.Streamable
com.threerings.io.Streamable.Closure
 
Field Summary
 Easing easing
          The easing function.
 Color4f end
          The final color.
 Color4f start
          The starting color.
 
Constructor Summary
ColorFunction.Linear()
          No-arg constructor for deserialization, etc.
ColorFunction.Linear(ColorFunction function)
          Creates a linear function with the other function's start and end.
 
Method Summary
 ColorFunction copy(ColorFunction result)
          Copies this function.
 Color4f getValue(float t, Color4f result)
          Computes the value at the specified time.
 
Methods inherited from class com.threerings.util.DeepObject
clone, copy, copy, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

start

@Editable(mode="%INHERIT%")
public Color4f start
The starting color.


end

@Editable(mode="%INHERIT%")
public Color4f end
The final color.


easing

@Editable
public Easing easing
The easing function.

Constructor Detail

ColorFunction.Linear

public ColorFunction.Linear(ColorFunction function)
Creates a linear function with the other function's start and end.


ColorFunction.Linear

public ColorFunction.Linear()
No-arg constructor for deserialization, etc.

Method Detail

getValue

public Color4f getValue(float t,
                        Color4f result)
Description copied from class: ColorFunction
Computes the value at the specified time.

Specified by:
getValue in class ColorFunction
Returns:
a reference to the result color, for chaining.

copy

public ColorFunction copy(ColorFunction result)
Description copied from class: ColorFunction
Copies this function.

Specified by:
copy in class ColorFunction
Parameters:
result - an object to repopulate, if possible.
Returns:
either the result object, if it could be repopulated, or a new object containing the result.


Copyright © 2011. All Rights Reserved.