All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.Alpha

java.lang.Object
   |
   +----java.media.j3d.Alpha

public class Alpha

extends Object

DECREASING_ENABLE

Specifies that the decreasing component of the alpha is used

INCREASING_ENABLE

Specifies that the increasing component of the alpha is used.

Alpha(int, int, long, long, long, long, long, long, long, long)

Constructs a new Alpha object using the specified parameters.

finished()

Query to test if this alpha object is past its activity window--- if it has finished all its looping activity.

getAlphaAtOneDuration()

Retrieves this alpha's alphaAtOneDuration.

getAlphaAtZeroDuration()

Retrieves this alpha's alphaAtZeroDuration.

getDecreasingAlphaDuration()

Retrieves this alpha's decreasingAlphaDuration.

getDecreasingAlphaRampDuration()

Retrieves this alpha's decreasingAlphaRampDuration.

getIncreasingAlphaDuration()

Retrieves this alpha's increasingAlphaDuration.

getIncreasingAlphaRampDuration()

Retrieves this alpha's increasingAlphaRampDuration.

getLoopCount()

Retrieves this alpha's loopCount.

getMode()

Retrieves this alpha's mode.

getPhaseDelayDuration()

Retrieves this alpha's phaseDelayDuration.

getStartTime()

Retrieves this alpha's startTime, the base for all relative time specifications.

getTriggerTime()

Retrieves this alpha's triggerTime.

setAlphAtOneDuration(long)

Set this alpha's alphaAtOneDuration to that specified in the argument.

setAlphAtZeroDuration(long)

Set this alpha's alphaAtZeroDuration to that specified in the argument.

setDecreasingAlphaDuration(long)

Set this alpha's decreasingAlphaDuration to that specified in the argument.

setDecreasingAlphaRampDuration(long)

Set this alpha's decreasingAlphaRampDuration to that specified in the argument.

setIncreasingAlphaDuration(long)

Set this alpha's increasingAlphaDuration to that specified in the argument.

setIncreasingAlphaRampDuration(long)

Set this alpha's increasingAlphaRampDuration to that specified in the argument.

setLoopCount(int)

Set this alpha's loopCount to that specified in the argument.

setMode(int)

Set this alpha's mode to that specified in the argument.

setPhaseDelayDuration(long)

Set this alpha's phaseDelayDuration to that specified in the argument.

setStartTime(long)

Set this alpha's startTime to that specified in the argument.

setTriggerTime(long)

Set this alpha's triggerTime to that specified in the argument.

value()

This function returns a value between 0.0 and 1.0 inclusive, based on the current time and the time-to-alpha parameters established for this interpolator

value(long)

This function returns a value between 0.0 and 1.0 inclusive, based on the specified time and the time-to-alpha parameters established for this interpolator

 public static final int INCREASING_ENABLE

Specifies that the increasing component of the alpha is used.

 public static final int DECREASING_ENABLE

Specifies that the decreasing component of the alpha is used

 public Alpha(int loopCount,
              int mode,
              long triggerTime,
              long phaseDelayDuration,
              long increasingAlphaDuration,
              long increasingAlphaRampDuration,
              long alphaAtOneDuration,
              long decreasingAlphaDuration,
              long decreasingAlphaRampDuration,
              long alphaAtZeroDuration)

Constructs a new Alpha object using the specified parameters.

Parameters:

loopCount - number of times to run this alpha; a value of -1 specifies that the alpha loops indefinitely.

mode - indicates whether the increasing alpha parameters or the decreasing alpha parameters or both are active. This parameter accepts the following values, INCREASING_ENABLE or DECREASING_ENABLE, which may be ORed together to specify that both are active. The increasing alpha parameters are increasingAlphaDuration, increasingAlphaRampDuration, and alphaAtOneDuration. The decreasing alpha parameters are decreasingAlphaDuration, decreasingAlphaRampDuration, and alphaAtZeroDuration.

triggerTime - time in milliseconds since the epoch (January 1, 1970 00:00:00 GMT) that this alpha triggers

phaseDelayDuration - number of milliseconds to wait after triggerTime before actually starting this alpha

increasingAlphaDuration - period of time during which alpha goes from zero to one

increasingAlphaRampDuration - period of time during which the alpha step size increases at the beginning of the increasingAlphaDuration and, correspondingly, decreases at the end of the increasingAlphaDuration. This value is clamped to half of increasingAlphaDuration. NOTE: a value of zero means that the alpha step size remains constant during the entire increasingAlphaDuration.

alphaAtOneDuration - period of time that alpha stays at one

decreasingAlphaDuration - period of time during which alpha goes from one to zero

decreasingAlphaRampDuration - period of time during which the alpha step size increases at the beginning of the decreasingAlphaDuration and, correspondingly, decreases at the end of the decreasingAlphaDuration. This value is clamped to half of decreasingAlphaDuration. NOTE: a value of zero means that the alpha step size remains constant during the entire decreasingAlphaDuration.

alphaAtZeroDuration - period of time that alpha stays at zero

Returns:

an alpha object or null, if user specified a alpha object that never generates a value (No mode specified).

 public float value()

This function returns a value between 0.0 and 1.0 inclusive, based on the current time and the time-to-alpha parameters established for this interpolator

Returns:

a value between 0.0 and 1.0 based on the current time

 public float value(long atTime)

This function returns a value between 0.0 and 1.0 inclusive, based on the specified time and the time-to-alpha parameters established for this interpolator

Parameters:

atTime - The time for which we wish to compute alpha

Returns:

a value between 0.0 and 1.0 based on the current time

 public long getStartTime()

Retrieves this alpha's startTime, the base for all relative time specifications.

Returns:

this alpha's startTime.

 public void setStartTime(long startTime)

Set this alpha's startTime to that specified in the argument. This sets the base (or zero) for all relative time computations

Parameters:

startTime - the new startTime value.

 public int getLoopCount()

Retrieves this alpha's loopCount.

Returns:

this alpha's loopCount.

 public void setLoopCount(int loopCount)

Set this alpha's loopCount to that specified in the argument.

Parameters:

loopCount - the new loopCount value.

 public int getMode()

Retrieves this alpha's mode.

Returns:

this alpha's mode: any combination of INCREASING_ENABLE and DECREASING_ENABLE

 public void setMode(int mode)

Set this alpha's mode to that specified in the argument.

Parameters:

mode - indicates whether the increasing alpha parameters or the decreasing alpha parameters or both are active. This parameter accepts the following values, INCREASING_ENABLE or DECREASING_ENABLE, which may be ORed together to specify that both are active. The increasing alpha parameters are increasingAlphaDuration, increasingAlphaRampDuration, and alphaAtOneDuration. The decreasing alpha parameters are decreasingAlphaDuration, decreasingAlphaRampDuration, and alphaAtZeroDuration.

 public long getTriggerTime()

Retrieves this alpha's triggerTime.

Returns:

this alpha's triggerTime.

 public void setTriggerTime(long triggerTime)

Set this alpha's triggerTime to that specified in the argument.

Parameters:

triggerTime - the new triggerTime

 public long getPhaseDelayDuration()

Retrieves this alpha's phaseDelayDuration.

Returns:

this alpha's phaseDelayDuration.

 public void setPhaseDelayDuration(long phaseDelayDuration)

Set this alpha's phaseDelayDuration to that specified in the argument.

Parameters:

phaseDelayDuration - the new phaseDelayDuration

 public long getIncreasingAlphaDuration()

Retrieves this alpha's increasingAlphaDuration.

Returns:

this alpha's increasingAlphaDuration.

 public void setIncreasingAlphaDuration(long increasingAlphaDuration)

Set this alpha's increasingAlphaDuration to that specified in the argument.

Parameters:

increasingAlphaDuration - the new increasingAlphaDuration

 public long getIncreasingAlphaRampDuration()

Retrieves this alpha's increasingAlphaRampDuration.

Returns:

this alpha's increasingAlphaRampDuration.

 public void setIncreasingAlphaRampDuration(long increasingAlphaRampDuration)

Set this alpha's increasingAlphaRampDuration to that specified in the argument.

Parameters:

increasingAlphaRampDuration - the new increasingAlphaRampDuration

 public long getAlphaAtOneDuration()

Retrieves this alpha's alphaAtOneDuration.

Returns:

this alpha's alphaAtOneDuration.

 public void setAlphAtOneDuration(long alphaAtOneDuration)

Set this alpha's alphaAtOneDuration to that specified in the argument.

Parameters:

alphaAtOneDuration - the new alphaAtOneDuration

 public long getDecreasingAlphaDuration()

Retrieves this alpha's decreasingAlphaDuration.

Returns:

this alpha's decreasingAlphaDuration.

 public void setDecreasingAlphaDuration(long decreasingAlphaDuration)

Set this alpha's decreasingAlphaDuration to that specified in the argument.

Parameters:

decreasingAlphaDuration - the new decreasingAlphaDuration

 public long getDecreasingAlphaRampDuration()

Retrieves this alpha's decreasingAlphaRampDuration.

Returns:

this alpha's decreasingAlphaRampDuration.

 public void setDecreasingAlphaRampDuration(long decreasingAlphaRampDuration)

Set this alpha's decreasingAlphaRampDuration to that specified in the argument.

Parameters:

decreasingAlphaRampDuration - the new decreasingAlphaRampDuration

 public long getAlphaAtZeroDuration()

Retrieves this alpha's alphaAtZeroDuration.

Returns:

this alpha's alphaAtZeroDuration.

 public void setAlphAtZeroDuration(long alphaAtZeroDuration)

Set this alpha's alphaAtZeroDuration to that specified in the argument.

Parameters:

alphaAtZeroDuration - the new alphaAtZeroDuration

 public boolean finished()

Query to test if this alpha object is past its activity window--- if it has finished all its looping activity.

Returns:

true if no longer looping, false otherwise

All Packages  Class Hierarchy  This Package  Previous  Next  Index