Source code: com/anotherbigidea/flash/movie/TimeLine.java
1 /****************************************************************
2 * Copyright (c) 2001, David N. Main, All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or
5 * without modification, are permitted provided that the
6 * following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
10 * disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials
15 * provided with the distribution.
16 *
17 * 3. The name of the author may not be used to endorse or
18 * promote products derived from this software without specific
19 * prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
22 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
24 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
31 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
32 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 ****************************************************************/
34 package com.anotherbigidea.flash.movie;
35
36 /**
37 * A Movie or Sprite (Movie Clip) time line (collection of frames)
38 */
39 public interface TimeLine
40 {
41 /**
42 * Get the current number of frames in the timeline.
43 */
44 public int getFrameCount();
45
46 /**
47 * Get the Frame object for the given frame number - or create one if
48 * none exists. If the frame number is larger than the current frame count
49 * then the frame count is increased.
50 *
51 * @param frameNumber must be 1 or larger
52 */
53 public Frame getFrame( int frameNumber );
54
55 /**
56 * Append a frame to the end of the timeline
57 */
58 public Frame appendFrame();
59
60 /**
61 * Get the next available depth in the timeline
62 */
63 public int getAvailableDepth();
64
65 /**
66 * Set the next available depth in the timeline
67 * @param depth must be >= 1
68 */
69 public void setAvailableDepth( int depth );
70 }