sub_arctic.lib
Class anim_mover_container

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.base_parent_interactor
                    |
                    +--sub_arctic.lib.shrink_wrap_container
                          |
                          +--sub_arctic.lib.anim_mover_container

public class anim_mover_container
extends shrink_wrap_container
implements animatable, does_callback

A container class to move a collection of objects with under control of an animation transition. See the animation agent for details about how animation transitions work.

See Also:
animation_agent, animatable

Field Summary
protected  callback_object _cback_obj
          This is where we hold our callback object.
static int END_TRANSITION_CALLBACK
          Callback number for callback at end of transition.
static int START_TRANSITION_CALLBACK
          Callback number for callback at start of transition.
 
Fields inherited from class sub_arctic.lib.shrink_wrap_container
_border, DRAW_BORDER
 
Fields inherited from class sub_arctic.lib.base_interactor
_child_index, _child_list, _clip_bounds, _constraint_flags, _enabled_constraint, _flags, _h, _h_constraint, _parent, _part_a_constraint, _part_b_constraint, _user_data, _visible_constraint, _w, _w_constraint, _x, _x_constraint, _y, _y_constraint, default_child_hint
 
Constructor Summary
anim_mover_container(int xpos, int ypos, interactor child)
          Construct a new sprite container.
anim_mover_container(int xpos, int ypos, interactor child, callback_object co)
          Construct a new sprite container with a callback.
 
Method Summary
 callback_object callback_obj()
           
 void end_transition(transition trans, trajectory traj, double start_t, java.lang.Object start_obj, double end_t, java.lang.Object end_obj, event e, java.lang.Object user_info)
          Handle the end of animation transition.
 int first_callback_num()
          First valid callback number
 int last_callback_num()
          Last valid callback number
 void set_callback_obj(callback_object co)
           
 void set_transition(transition t)
          Call this to setup a transition for this object.
 void start_transition(transition trans, trajectory traj, double start_t, java.lang.Object start_obj, event e, java.lang.Object user_info)
          Handle start of animation transition.
 void transition_step(transition trans, trajectory traj, double start_t, java.lang.Object start_obj, double end_t, java.lang.Object end_obj, event e, java.lang.Object user_info)
          Handle an animation step.
 
Methods inherited from class sub_arctic.lib.shrink_wrap_container
border, draw_border, draw_self_local, set_border, set_draw_border, setup_constraints
 
Methods inherited from class sub_arctic.lib.base_interactor
active_constraints, add_child, add_user_datum, attach_dependent, bound, child_index, child, clear_child_list, clear_constraint_flag_bit, clear_flag_bit, configure, constraint_flag_is_set, constraint_flag_string, constraint_on, custom_fun1, custom_fun2, damage_fixed, damage_from_child, damage_self, damage_self, damage_self, damage_self, damage_self, detach_dependent, do_action, do_action, do_callback, do_callback, drag_feature_point, draw_children, draw_self, enabled_constraint, enabled, enter_local_coordinates, eval_enabled, eval_h, eval_part_a, eval_part_b, eval_visible, eval_w, eval_x, eval_y, eval, exit_local_coords, feature_point_enabled, feature_point, filter_pt, find_child, fixed_children, flag_is_set, flag_string, focus_set_enter, focus_set_exit, get_awt_component, get_external_constraint, get_part, get_top_level, get_value, global_to_local, global_to_local, h_constraint, h, handle_cycle, inform_ood, insert_child, inside_bounds, into_local, into_local, into_parent, into_parent, intrinsic_constraints, is_constrained, local_to_global, local_to_global, mark_all_ood, mark_enabled_ood, mark_h_ood, mark_ood, mark_part_a_ood, mark_part_b_ood, mark_reparented_ood, mark_visible_ood, mark_w_ood, mark_x_ood, mark_y_ood, marked_ood, move_child_downward, move_child_downward, move_child_to_bottom, move_child_to_bottom, move_child_to_top, move_child_to_top, move_child_upward, move_child_upward, move_downward, move_to_bottom, move_to_top, move_upward, new_look_configure, next_sibling, num_actions, num_children, num_feature_points, ood_inform_all, parent, part_a_constraint, part_a, part_b_constraint, part_b, pick_within_children, pick, picked_by, pos, prev_sibling, register_resource_names, remove_child, remove_child, remove_user_datum, restyle_look_resources, restyle, set_child_index, set_child, set_constraint_flag_bit, set_constraint_flag_bit, set_constraint, set_constraint, set_enabled_constraint, set_enabled_constraint, set_enabled_constraint, set_enabled, set_flag_bit, set_flag_bit, set_h_constraint, set_h_constraint, set_h_constraint, set_h, set_intrinsic_h, set_intrinsic_size, set_intrinsic_w, set_parent, set_part_a_constraint, set_part_a_constraint, set_part_a_constraint, set_part_a, set_part_b_constraint, set_part_b_constraint, set_part_b_constraint, set_part_b, set_pos, set_pos, set_raw_enabled, set_raw_h, set_raw_part_a, set_raw_part_b, set_raw_visible, set_raw_w, set_raw_x, set_raw_y, set_size, set_style_lock, set_user_info, set_visible_constraint, set_visible_constraint, set_visible_constraint, set_visible, set_w_constraint, set_w_constraint, set_w_constraint, set_w, set_x_constraint, set_x_constraint, set_x_constraint, set_x, set_y_constraint, set_y_constraint, set_y_constraint, set_y, setup_for_children, setup_for_children, setup_for_fixed_children, size, style_change_local, style_change, supports_children, tag_str, toString, traverse_and_collect_children, traverse_and_collect_parent, traverse_and_collect, trivial_reject, trivial_reject, user_data, user_info, value_ood, visible_constraint, visible, w_constraint, w, x_constraint, x_into_local, x_into_parent, x, y_constraint, y_into_local, y_into_parent, y
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

END_TRANSITION_CALLBACK

public static final int END_TRANSITION_CALLBACK
Callback number for callback at end of transition.

START_TRANSITION_CALLBACK

public static final int START_TRANSITION_CALLBACK
Callback number for callback at start of transition.

_cback_obj

protected callback_object _cback_obj
This is where we hold our callback object.
Constructor Detail

anim_mover_container

public anim_mover_container(int xpos,
                            int ypos,
                            interactor child)
Construct a new sprite container. Initially, there is no transition scheduled.
Parameters:
int - xpos initial x position of the container.
int - ypos initial y position of the container.
interactor - child child object to install under this container.

anim_mover_container

public anim_mover_container(int xpos,
                            int ypos,
                            interactor child,
                            callback_object co)
Construct a new sprite container with a callback. Initially, there is no transition scheduled.

The callback object gets the callback with 0 value for start and a 1 value for end. The callback_info in both cases is the transition being started or stopped.

Parameters:
int - xpos initial x position of the container.
int - ypos initial y position of the container.
interactor - child child object to install under this container.
callback_object - co object we make callbacks to.
Method Detail

set_transition

public void set_transition(transition t)
Call this to setup a transition for this object. Note: you may call this more than once... if you do so, it is possible that you could have multiple active transitions. This is useful! However, be aware that previous calls are not cancelled by this call.
Parameters:
transition - t the transition we schedule for this object.

first_callback_num

public int first_callback_num()
First valid callback number
Specified by:
first_callback_num in interface does_callback
Overrides:
first_callback_num in class base_interactor

last_callback_num

public int last_callback_num()
Last valid callback number
Specified by:
last_callback_num in interface does_callback
Overrides:
last_callback_num in class base_interactor

start_transition

public void start_transition(transition trans,
                             trajectory traj,
                             double start_t,
                             java.lang.Object start_obj,
                             event e,
                             java.lang.Object user_info)
Handle start of animation transition. This transition is used to position this object over time. This makes the start of trajectory callback (#0).
Specified by:
start_transition in interface animatable
Parameters:
transition - trans the transition object controlling this.
trajectory - traj the trajectory it is working over.
double - start_t start value along trajectory 0..1.
Object - start_obj first data value out of trajectory (must be a Point object).
event - e event "causing" the animation.
Object - user_info the information associated with then object when the transition was scheduled.

transition_step

public void transition_step(transition trans,
                            trajectory traj,
                            double start_t,
                            java.lang.Object start_obj,
                            double end_t,
                            java.lang.Object end_obj,
                            event e,
                            java.lang.Object user_info)
Handle an animation step. This animation should be along a trajectory of points, and is used to position this object.
Specified by:
transition_step in interface animatable
Parameters:
transition - trans the transition object controlling this.
trajectory - traj the trajectory it is working over.
double - start_t start value of this step (within 0..1 overall)
Object - start_obj start data value for this step (this must be a Point object).
double - end_t end value of this step (within 0..1 overall)
Object - end_obj end data value for this step (this must be a Point object).
event - e event "causing" the animation.
Object - user_info the information associated with then object when the transition was scheduled.

end_transition

public void end_transition(transition trans,
                           trajectory traj,
                           double start_t,
                           java.lang.Object start_obj,
                           double end_t,
                           java.lang.Object end_obj,
                           event e,
                           java.lang.Object user_info)
Handle the end of animation transition. This animation should be along a trajectory of points, and is used to position this object. This makes the end of trajectory callback (#1).
Specified by:
end_transition in interface animatable
Parameters:
transition - trans the transition object controlling this.
trajectory - traj the trajectory it is working over.
double - start_t start value of this step (within 0..1 overall)
Object - start_obj start data value for this step (this must be a Point object).
double - end_t end value of this step (within 0..1 overall)
Object - end_obj end data value for this step (this must be a Point object).
event - e event "causing" the animation.
Object - user_info the information associated with then object when the transition was scheduled.

callback_obj

public callback_object callback_obj()
Specified by:
callback_obj in interface does_callback
Overrides:
callback_obj in class base_interactor

set_callback_obj

public void set_callback_obj(callback_object co)
Specified by:
set_callback_obj in interface does_callback
Overrides:
set_callback_obj in class base_interactor