com.threerings.opengl.effect
Class FloatFunction.InAndOut

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.opengl.effect.FloatFunction
          com.threerings.opengl.effect.FloatFunction.InAndOut

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Enclosing class:

FloatFunction

public static class FloatFunction.InAndOut
extends FloatFunction

A float function that blends linearly from a start value to an end value, then back to the start value.

Nested Class Summary

Nested classes/interfaces inherited from class com.threerings.opengl.effect.FloatFunction

FloatFunction.Constant, FloatFunction.InAndOut, FloatFunction.Linear, FloatFunction.Multipoint, FloatFunction.ThreePoint

Field Summary

float	end The target value.
float	in The proportional time to spend blending into the target value.
float	out The proportional time to spend blending back to the start value.
float	start The starting and ending values.

Constructor Summary

FloatFunction.InAndOut()
No-arg constructor for deserialization, etc.

FloatFunction.InAndOut(FloatFunction.ThreePoint function)
Creates an in-and-out function with the other function's parameters.

FloatFunction.InAndOut(FloatFunction function)
Creates an in-and-out function with the other function's start and end.

Method Summary

FloatFunction	copy(FloatFunction result) Copies this function.
float	getValue(float t) 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(min=-1d/0d,
          max=-1d/0d,
          step=-1d/0d,
          scale=-1d/0d)
public float start

The starting and ending values.

end

@Editable(min=-1d/0d,
          max=-1d/0d,
          step=-1d/0d,
          scale=-1d/0d)
public float end

The target value.

in

@Editable(min=0.0,
          max=1.0,
          step=0.01)
public float in

The proportional time to spend blending into the target value.

out

@Editable(min=0.0,
          max=1.0,
          step=0.01)
public float out

The proportional time to spend blending back to the start value.

Constructor Detail

FloatFunction.InAndOut

public FloatFunction.InAndOut(FloatFunction function)

Creates an in-and-out function with the other function's start and end.

FloatFunction.InAndOut

public FloatFunction.InAndOut(FloatFunction.ThreePoint function)

Creates an in-and-out function with the other function's parameters.

FloatFunction.InAndOut

public FloatFunction.InAndOut()

No-arg constructor for deserialization, etc.

Method Detail

getValue

public float getValue(float t)

Description copied from class: FloatFunction

Computes the value at the specified time.

Specified by:

getValue in class FloatFunction

copy

public FloatFunction copy(FloatFunction result)

Description copied from class: FloatFunction

Copies this function.

Specified by:

copy in class FloatFunction

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.