com.reportmill.graphics

Class RMPeriodicInterpolator

java.lang.Object

com.reportmill.graphics.RMInterpolator

com.reportmill.graphics.RMPeriodicInterpolator

All Implemented Interfaces:

java.lang.Cloneable

public class RMPeriodicInterpolator
extends RMInterpolator

An Interpolator subclass that can be used for periodic (ie looping) motion. The different type values are (where n is the frequency): LOOP : start -> end, n times BACKANDFORTH - start -> end -> start, n times SINUSOIDAL - start -> end -> start, n times along a smooth sin wave

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RMPeriodicInterpolator.PeriodType

Nested classes/interfaces inherited from class com.reportmill.graphics.RMInterpolator

RMInterpolator.Bounce

Field Summary

Fields

Modifier and Type	Field and Description
float	_frequency
RMInterpolator	_parent
float	_phase
RMPeriodicInterpolator.PeriodType	_type

Fields inherited from class com.reportmill.graphics.RMInterpolator

BOUNCE, DIR_BOTH, DIR_IN, DIR_OUT, EASE_BOTH, EASE_BOTH_CUBIC, EASE_IN, EASE_IN_CUBIC, EASE_OUT, EASE_OUT_CUBIC, LINEAR, ONE_SHOT, RANDOM

Constructor Summary

Constructors

Constructor and Description
RMPeriodicInterpolator() Create a default periodic interpolator

Method Summary

Methods

Modifier and Type	Method and Description
RMPeriodicInterpolator	clone() Standard clone implementation.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival
float	getFrequency()
java.lang.String	getName() Returns the name of this interpolator.
RMInterpolator	getParent()
float	getPhase()
RMPeriodicInterpolator.PeriodType	getType()
double	getValue(double aRatio, double aStart, double anEnd) The main entry point.
boolean	isShared() Returns false, since periodic interpolators have parameters
void	setFrequency(float aFrequency)
void	setParent(RMInterpolator aParent)
void	setPhase(float aPhase)
void	setType(RMPeriodicInterpolator.PeriodType aType)
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML Archival

Methods inherited from class com.reportmill.graphics.RMInterpolator

addInterpolator, getDirection, getInterpolator, getInterpolator, getInterpolatorCount, getNewInterpolator, getRatio, getValue, interpolate, interpolateBoth, interpolateOut, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_parent

public RMInterpolator _parent

_type

public RMPeriodicInterpolator.PeriodType _type

_frequency

public float _frequency

_phase

public float _phase

Constructor Detail

RMPeriodicInterpolator

public RMPeriodicInterpolator()

Create a default periodic interpolator

Method Detail

getName

public java.lang.String getName()

Description copied from class: RMInterpolator

Returns the name of this interpolator.

Overrides:

getName in class RMInterpolator

isShared

public boolean isShared()

Returns false, since periodic interpolators have parameters

Overrides:

isShared in class RMInterpolator

getValue

public double getValue(double aRatio,
              double aStart,
              double anEnd)

The main entry point.

Overrides:

getValue in class RMInterpolator

getFrequency

public float getFrequency()

getParent

public RMInterpolator getParent()

getPhase

public float getPhase()

getType

public RMPeriodicInterpolator.PeriodType getType()

setFrequency

public void setFrequency(float aFrequency)

setParent

public void setParent(RMInterpolator aParent)

setPhase

public void setPhase(float aPhase)

setType

public void setType(RMPeriodicInterpolator.PeriodType aType)

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver,
                                      java.lang.Object anOwner)

XML Archival

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                       com.reportmill.archiver.RXElement anElement,
                       java.lang.Object anOwner)

XML unarchival

clone

public RMPeriodicInterpolator clone()

Description copied from class: RMInterpolator

Standard clone implementation.

Overrides:

clone in class RMInterpolator