• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2009-2010 jMonkeyEngine
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  *   notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in the
14  *   documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
17  *   may be used to endorse or promote products derived from this software
18  *   without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 package com.jme3.animation;
34 
35 /**
36  * <code>AnimEventListener</code> allows user code to receive various
37  * events regarding an AnimControl. For example, when an animation cycle is done.
38  *
39  * @author Kirill Vainer
40  */
41 public interface AnimEventListener {
42 
43     /**
44      * Invoked when an animation "cycle" is done. For non-looping animations,
45      * this event is invoked when the animation is finished playing. For
46      * looping animations, this even is invoked each time the animation is restarted.
47      *
48      * @param control The control to which the listener is assigned.
49      * @param channel The channel being altered
50      * @param animName The new animation that is done.
51      */
onAnimCycleDone(AnimControl control, AnimChannel channel, String animName)52     public void onAnimCycleDone(AnimControl control, AnimChannel channel, String animName);
53 
54     /**
55      * Invoked when a animation is set to play by the user on the given channel.
56      *
57      * @param control The control to which the listener is assigned.
58      * @param channel The channel being altered
59      * @param animName The new animation name set.
60      */
onAnimChange(AnimControl control, AnimChannel channel, String animName)61     public void onAnimChange(AnimControl control, AnimChannel channel, String animName);
62 
63 }
64