edu.umd.cfar.lamp.viper.gui.core
Interface PropagateInterpolateModule

All Known Implementing Classes:
PropagateInterpolateImpl

public interface PropagateInterpolateModule

Interface for the propagate/interpolate bean.


Nested Class Summary
static interface PropagateInterpolateModule.PropagateListener
          Listens for changes to the current propagation selection.
 
Method Summary
 void addPropagateListener(PropagateInterpolateModule.PropagateListener pl)
          Adds a listener for changes to the list of items to propagate.
 java.util.Set getPropagatingDescriptors()
          Gets all propagating descriptors.
 void interpolate(Instant start, Instant end)
          Interpolates all items on the propagation list.
 void interpolateAttributes(java.util.Iterator ats, Instant start, Instant stop)
          Interpolates only the given attributes, without reference to or modification of the propagation list.
 void interpolateDescriptors(java.util.Iterator descs, Instant start, Instant stop)
          Interpolates only the given descriptors, without reference to or modification of the propagation list.
 boolean isPropagatingThis(Descriptor d)
          Tests to see if this descriptor is on the propagation list.
 void propagate(Instant start, Instant end)
          Interpolates the value from start to the interval [start, end].
 void propagateAttributes(java.util.Iterator ats, Instant start, Instant end)
          Propagates only the given attributes, without reference to or modification of the propagation list.
 void propagateDescriptors(java.util.Iterator descs, Instant start, Instant end)
          Propagates only the given descriptors, without reference to or modification of the propagation list.
 void removePropagateListener(PropagateInterpolateModule.PropagateListener pl)
          Removes the propagation list listener.
 void startPropagating(Attribute attr)
          Adds the attribute to the propagation list.
 void startPropagating(Descriptor desc)
          Adds a descriptor to the propagate list.
 void stopPropagating()
          Stops all items from propagating.
 void stopPropagating(Attribute attr)
          Removes the attribute from the propagation list.
 void stopPropagating(Descriptor desc)
          Removes the given descriptor from the propagation list.
 

Method Detail

isPropagatingThis

public boolean isPropagatingThis(Descriptor d)
Tests to see if this descriptor is on the propagation list.

Parameters:
d - the descriptor instance
Returns:
if the descriptor is propagating

getPropagatingDescriptors

public java.util.Set getPropagatingDescriptors()
Gets all propagating descriptors.

Returns:
the set of all propagating descriptors

addPropagateListener

public void addPropagateListener(PropagateInterpolateModule.PropagateListener pl)
Adds a listener for changes to the list of items to propagate.

Parameters:
pl - the new listener

removePropagateListener

public void removePropagateListener(PropagateInterpolateModule.PropagateListener pl)
Removes the propagation list listener.

Parameters:
pl - the listener to remove

startPropagating

public void startPropagating(Descriptor desc)
Adds a descriptor to the propagate list.

Parameters:
desc -

stopPropagating

public void stopPropagating()
Stops all items from propagating.


stopPropagating

public void stopPropagating(Descriptor desc)
Removes the given descriptor from the propagation list.

Parameters:
desc - the descriptor to remove

startPropagating

public void startPropagating(Attribute attr)
Adds the attribute to the propagation list.

Parameters:
attr - the attribute to modify

stopPropagating

public void stopPropagating(Attribute attr)
Removes the attribute from the propagation list.

Parameters:
attr - the attribute to remove

propagate

public void propagate(Instant start,
                      Instant end)
Interpolates the value from start to the interval [start, end].

Parameters:
start -
end -

interpolate

public void interpolate(Instant start,
                        Instant end)
Interpolates all items on the propagation list.

Parameters:
start - the frame to use as the start of the interpolation
end - the frame or time to use as the end value of the interpolation

propagateDescriptors

public void propagateDescriptors(java.util.Iterator descs,
                                 Instant start,
                                 Instant end)
Propagates only the given descriptors, without reference to or modification of the propagation list.

Parameters:
descs - the descriptors to propagate
start - the value of the descriptor to use, and one end of the propagation range
end - the last value to change

propagateAttributes

public void propagateAttributes(java.util.Iterator ats,
                                Instant start,
                                Instant end)
Propagates only the given attributes, without reference to or modification of the propagation list.

Parameters:
ats - the attributes to propagate
start - the value of the descriptor to use, and one end of the propagation range
end - the last value to change

interpolateDescriptors

public void interpolateDescriptors(java.util.Iterator descs,
                                   Instant start,
                                   Instant stop)
Interpolates only the given descriptors, without reference to or modification of the propagation list.

Parameters:
descs - the descriptors to interpolate
start - the first value of to use, and one end of the interpolation range
stop - the last value to use, and the end of the interpolation range

interpolateAttributes

public void interpolateAttributes(java.util.Iterator ats,
                                  Instant start,
                                  Instant stop)
Interpolates only the given attributes, without reference to or modification of the propagation list.

Parameters:
ats - the attributes to interpolate
start - the first value of to use, and one end of the interpolation range
stop - the last value to use, and the end of the interpolation range