Package com.inductiveautomation.rm.graphics

Class RMKeyFrame

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.graphics.RMKeyFrame

All Implemented Interfaces:

RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.lang.Comparable<RMKeyFrame>, java.util.EventListener

public class RMKeyFrame
extends RMObject
implements java.beans.PropertyChangeListener, java.lang.Comparable<RMKeyFrame>

An animation object that holds an object key/value for a given time.

Constructor Summary

Constructors

Constructor	Description
RMKeyFrame(int aTime)	Creates a new key frame.

Method Summary

Modifier and Type	Method	Description
void	addKeyValue(RMKeyValue aKeyValue)	Adds a new key value.
void	addKeyValue(RMKeyValue aKeyValue, int anIndex)	Adds a new key value at given index.
RMKeyValue	addKeyValue(java.lang.Object aTarget, java.lang.String aKey, java.lang.Object aValue)	Adds a new key value for given target, key and value.
RMKeyFrame	clone()	Standard clone method.
int	compareTo(RMKeyFrame aKeyFrame)	Standard compare implementation.
RMKeyValue	getKeyValue(int anIndex)	Returns the individual key value at index.
RMKeyValue	getKeyValue(java.lang.Object aTarget, java.lang.String aKey)	Returns the key value for given object and key, if present.
int	getKeyValueCount()	Returns the number of key values.
java.util.List<RMKeyValue>	getKeyValues()	Returns the list of key values.
int	getTime()	Returns the time.
RMTimeline	getTimeline()	Returns the timeline that owns this key frame (if present).
void	propertyChange(java.beans.PropertyChangeEvent anEvent)	Implement to catch key value changes and forward to this key frame's property change listeners.
RMKeyValue	removeKeyValue(int anIndex)	Removes a key value at given index.
int	removeKeyValue(RMKeyValue aKVal)	Removes a key value.
protected void	setTimeline(RMTimeline aTimeline)	Sets the timeline that owns this key frame (if present).
java.lang.String	toString()	Standard to string implementation.

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, animUpdate, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RMKeyFrame

public RMKeyFrame(int aTime)

Creates a new key frame.

Method Detail

getTimeline

public RMTimeline getTimeline()

Returns the timeline that owns this key frame (if present).

setTimeline

protected void setTimeline(RMTimeline aTimeline)

Sets the timeline that owns this key frame (if present).

getTime

public int getTime()

Returns the time.

getKeyValueCount

public int getKeyValueCount()

Returns the number of key values.

getKeyValue

public RMKeyValue getKeyValue(int anIndex)

Returns the individual key value at index.

getKeyValues

public java.util.List<RMKeyValue> getKeyValues()

Returns the list of key values.

addKeyValue

public void addKeyValue(RMKeyValue aKeyValue)

Adds a new key value.

addKeyValue

public void addKeyValue(RMKeyValue aKeyValue,
                        int anIndex)

Adds a new key value at given index.

removeKeyValue

public RMKeyValue removeKeyValue(int anIndex)

Removes a key value at given index.

removeKeyValue

public int removeKeyValue(RMKeyValue aKVal)

Removes a key value.

getKeyValue

public RMKeyValue getKeyValue(java.lang.Object aTarget,
                              java.lang.String aKey)

Returns the key value for given object and key, if present.

addKeyValue

public RMKeyValue addKeyValue(java.lang.Object aTarget,
                              java.lang.String aKey,
                              java.lang.Object aValue)

Adds a new key value for given target, key and value.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent anEvent)

Implement to catch key value changes and forward to this key frame's property change listeners.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

compareTo

public int compareTo(RMKeyFrame aKeyFrame)

Standard compare implementation.

Specified by:

compareTo in interface java.lang.Comparable<RMKeyFrame>

clone

public RMKeyFrame clone()

Standard clone method.

Overrides:

clone in class RMListenerList

toString

public java.lang.String toString()

Standard to string implementation.

Overrides:

toString in class RMObject