sub_arctic.input
Class pick_collector

java.lang.Object
  |
  +--sub_arctic.input.pick_collector

public class pick_collector
extends java.lang.Object

Object for building and holding a set of interactor objects picked by a point. This class maintains an ordered list of "user_info_holder" objects each of which represents an interactor object along with optional user information that interactor has saved about the details of the pick. This user information is passed back to object when input is delivered to them.


Field Summary
protected  java.util.Vector _pick_list
          Internal Vector to hold our picked objects.
 
Constructor Summary
pick_collector()
          Simple constructor
 
Method Summary
 int num_picks()
          Total number of picks we currently have.
 user_info_holder pick(int indx)
          Retrieve the ith user_info_holder object from the current collection of picks.
 void report_pick(interactor in_obj)
          Add the given object to the end of the current pick collection.
 void report_pick(interactor in_obj, java.lang.Object user_info)
          Add the given object (with optional additional information) to the end of the current pick collection.
 void reset()
          Reset the pick collection to empty.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_pick_list

protected java.util.Vector _pick_list
Internal Vector to hold our picked objects. This holds user_info_holder objects.
Constructor Detail

pick_collector

public pick_collector()
Simple constructor
Method Detail

num_picks

public int num_picks()
Total number of picks we currently have.

pick

public user_info_holder pick(int indx)
Retrieve the ith user_info_holder object from the current collection of picks.
Parameters:
int - indx index of object we want.
Returns:
user_info_holder the object at that index.

report_pick

public void report_pick(interactor in_obj,
                        java.lang.Object user_info)
Add the given object (with optional additional information) to the end of the current pick collection.
Parameters:
interactor - in_obj the object being added as a pick.
Object - user_info uninterpreted user information to be associated with that object and returned to it when input associated with this pick is delivered to it.

report_pick

public void report_pick(interactor in_obj)
Add the given object to the end of the current pick collection. The optional user information associated with the pick will be set to null.
Parameters:
interactor - in_obj the object being added as a pick.

reset

public void reset()
Reset the pick collection to empty.