|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--sub_arctic.new_lib.navigator_base | +--sub_arctic.new_lib.halo_navigator | +--sub_arctic.new_lib.audio_navigator
This class implements an audio based navigator (which also does visual halo feedback at the same time). It works both with audio aware interactors (implementing audio_navigation_aware) which provide their own translation into audio, or by using a generic_audio_xlation object it creates internally to do a translation. In addition to feedback from the interactor at the current location in the tree, the navigator also provides generic navigation feedback (such as hitting the top, bottom, left, or right, etc.).
Field Summary | |
protected java.util.Vector |
_cur_audio
A description of the audio segments currently playing. |
protected static audio_renderer |
_hit_bottom_sound
Description of sound for hitting the bottom of the tree |
protected static audio_renderer |
_hit_left_sound
Description of sound for hitting the left most child |
protected static audio_renderer |
_hit_right_sound
Description of sound for hitting the right most child |
protected static audio_renderer |
_hit_top_sound
Description of sound for hitting the top of the tree |
protected static audio_renderer |
_text_mode_entry_sound
Description of sound for entering text entry mode |
protected static audio_renderer |
_text_mode_exit_sound
Description of sound for exiting text entry mode |
protected generic_audio_xlation |
_xlator
Audio translator we use to convert interactors to audio |
Fields inherited from class sub_arctic.new_lib.halo_navigator |
_feedback_halo |
Fields inherited from class sub_arctic.new_lib.navigator_base |
_current_location |
Constructor Summary | |
audio_navigator(halo_container feedback_halo,
interactor cur_loc)
Construct an audio navigator based on an initial position in the tree. |
Method Summary | |
void |
arrive(interactor at_interactor)
Provide feedback and/or actions associated with arriving at a particular interactor node. |
void |
depart(interactor from_interactor)
Provide feedback and/or actions associated with leaving a particular interactor node. |
boolean |
enter_text_entry_mode(event evt,
java.lang.Object user_info)
Request to enter text entry mode. |
boolean |
exit_text_entry_mode(event evt,
java.lang.Object user_info)
Indicate that we are leaving text entry mode and returning to navigation mode. |
protected interactor |
find_down(interactor from_loc)
Find the next node moving down, returning null if we hit the top. |
protected interactor |
find_left(interactor from_loc)
Find the next node moving left, returning null if we go past the first child. |
protected interactor |
find_right(interactor from_loc)
Find the next node moving right, returning null if we go past the last child. |
protected interactor |
find_up(interactor from_loc)
Find the next node moving up, returning null if we hit the top. |
static audio_renderer |
get_audio_renderer(java.lang.String name)
Load an audio_renderer by name. |
protected static audio_renderer |
hit_bottom_sound()
Description of sound for hitting the bottom of the tree |
void |
hit_bottom()
Provide feedback for attempting to move down past a leaf. |
protected static audio_renderer |
hit_left_sound()
Description of sound for hitting the left most child |
void |
hit_left()
Provide feedback for attempting to move left past the first sibling. |
protected static audio_renderer |
hit_right_sound()
Description of sound for hitting the right most child |
void |
hit_right()
Provide feedback for attempting to move right past the last sibling. |
protected static audio_renderer |
hit_top_sound()
Description of sound for hitting the top of the tree |
void |
hit_top()
Provide feedback for attempting to move up past the root. |
boolean |
perform_action(int act_num,
event evt,
java.lang.Object user_info)
Perform an action associated with the interactor at the current location (e.g., if this is a button, push it). |
protected void |
play(audio_renderer sound_desc)
Start playing a particular audio segment keeping the bookkeeping we need to stop this early if necessary. |
void |
preview_arrive(interactor at_interactor)
Provide preview feedback associated with arriving at a particular interactor node. |
void |
preview_depart(interactor from_interactor)
Provide preview feedback associated with leaving a particular interactor node. |
void |
preview_hit_bottom()
Provide preview feedback for attempting to move down past a leaf. |
void |
preview_hit_left()
Provide preview feedback for attempting to move left past the first sibling. |
void |
preview_hit_right()
Provide preview feedback for attempting to move right past the last sibling. |
void |
preview_hit_top()
Provide preview feedback for attempting to move up past the root. |
protected void |
stop_all()
Stop all currently playing audio segments |
protected static audio_renderer |
text_mode_entry_sound()
Description of sound for entering text entry mode |
protected static audio_renderer |
text_mode_exit_sound()
Description of sound for entering text entry mode |
Methods inherited from class sub_arctic.new_lib.halo_navigator |
feedback_halo,
feedback_halo,
navigate_up,
preview_to_top |
Methods inherited from class sub_arctic.new_lib.navigator_base |
current_location,
do_move,
do_preview,
focus_set_enter,
focus_set_exit,
navigate_down,
navigate_left,
navigate_right,
navigate_to_top,
navigate_to,
preview_down,
preview_left,
preview_right,
preview_to,
preview_up |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected generic_audio_xlation _xlator
protected java.util.Vector _cur_audio
protected static audio_renderer _text_mode_entry_sound
protected static audio_renderer _text_mode_exit_sound
protected static audio_renderer _hit_top_sound
protected static audio_renderer _hit_bottom_sound
protected static audio_renderer _hit_left_sound
protected static audio_renderer _hit_right_sound
Constructor Detail |
public audio_navigator(halo_container feedback_halo, interactor cur_loc)
halo_container
- feedback_halo object that does visual feedback for
us.interactor
- cur_loc initial location for the navigatorMethod Detail |
protected interactor find_up(interactor from_loc)
interactor
- from_loc the interactor we are moving up fromprotected interactor find_down(interactor from_loc)
interactor
- from_loc the interactor we are moving down fromprotected interactor find_left(interactor from_loc)
interactor
- from_loc the interactor we are moving left fromprotected interactor find_right(interactor from_loc)
interactor
- from_loc the interactor we are moving left frompublic static audio_renderer get_audio_renderer(java.lang.String name)
String
- name name of the sound file we useprotected static audio_renderer text_mode_entry_sound()
protected static audio_renderer text_mode_exit_sound()
protected static audio_renderer hit_top_sound()
protected static audio_renderer hit_bottom_sound()
protected static audio_renderer hit_left_sound()
protected static audio_renderer hit_right_sound()
protected void play(audio_renderer sound_desc)
audio_renderer
- soud_desc the sound to playprotected void stop_all()
public boolean enter_text_entry_mode(event evt, java.lang.Object user_info)
event
- evt the event causing this inputObject
- user_info information supplied at focus timepublic boolean exit_text_entry_mode(event evt, java.lang.Object user_info)
event
- evt the event causing this inputObject
- user_info information supplied at focus timepublic boolean perform_action(int act_num, event evt, java.lang.Object user_info)
int
- act_num the number of the action to perform (0 will be the
primary or default action)event
- evt the event causing this inputObject
- user_info information supplied at focus timepublic void hit_top()
public void hit_bottom()
public void hit_left()
public void hit_right()
public void preview_hit_top()
public void preview_hit_bottom()
public void preview_hit_left()
public void preview_hit_right()
public void depart(interactor from_interactor)
interactor
- from_interactorpublic void arrive(interactor at_interactor)
interactor
- at_interactorpublic void preview_depart(interactor from_interactor)
interactor
- from_interactorpublic void preview_arrive(interactor at_interactor)
interactor
- at_interactor
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |