View Javadoc

1   package com.insanityengine.ghia.renderer;
2   
3   //import java.util.Stack;
4   
5   import java.awt.*;
6   
7   import java.applet.Applet;
8   import java.awt.Component;
9   import java.awt.image.ImageObserver;
10  
11  import com.insanityengine.ghia.m3.*;
12  import com.insanityengine.ghia.libograf.*;
13  import com.insanityengine.ghia.pixels.*;
14  import com.insanityengine.ghia.renderer.*;
15  
16  /***
17   *
18   * <P>
19   * Interface for RendererConsumer's 
20   * </P>
21   *
22   * @author BrianHammond
23   *
24   * $Header: /usr/local/cvsroot/ghia/src/java/com/insanityengine/ghia/renderer/RendererConsumerInterface.java,v 1.2 2005/03/19 17:50:02 brian Exp $
25   *
26   */
27  
28  public interface RendererConsumerInterface {
29  
30  	/***
31  	 *
32  	 * Initialize this RendererConsumer
33  	 *
34  	 * @param applet which provides context
35  	 *
36  	 */
37  	public void init( Applet applet );
38  	
39  	/***
40  	 *
41  	 * Initialize this RendererConsumer
42  	 *
43  	 * @param width of the display
44  	 * @param height of the display
45  	 * @param component to use
46  	 *
47  	 */
48  	public void init( int width, int height, java.awt.Component component );
49  
50  	/***
51  	 *
52  	 * Create a renderer with a given size
53  	 *
54  	 * @param width of the renderer to create
55  	 * @param height of the renderer to create
56  	 *
57  	 * @return true on success, false on fail
58  	 *
59  	 */
60  	public boolean createRenderer( int width, int height );
61  
62  	/***
63  	 * 
64  	 * Try to create a renderer given the name of the class 
65  	 * It will be initialized with the values passed into the init
66  	 * method of this LiboGraf instance
67  	 *
68  	 * @param nameOfRenderer to try to use
69  	 *
70  	 * @return true if succeds, else false
71  	 *
72  	 */
73  	public boolean createRenderer( String nameOfRenderer );
74  
75  	/***
76  	 *
77  	 * Create a renderer of the default type using the values from 
78  	 * sent to init
79  	 *
80  	 * @return true if succeds, else false
81  	 *
82  	 */
83  	public boolean createRenderer();
84  	
85  	/***
86  	 *
87  	 * Get the renderer
88  	 *
89  	 * @return the renderer
90  	 *
91  	 */
92  	public RendererInterface getRenderer();
93  
94  	/***
95  	 *
96  	 * Set the renderer
97  	 *
98  	 * @param renderer to use
99  	 *
100 	 */
101 	public void setRenderer( RendererInterface renderer );
102 
103 	/***
104 	 *
105 	 * Render the scene
106 	 *
107 	 */
108 	public void render( LiboGraf gl );
109 
110 	/***
111 	 *
112 	 * Set the graphics to use
113 	 * 
114 	 * @param graphics to use
115 	 *
116 	 */
117 	public void setGraphics( Graphics graphics );
118 	
119 	/***
120 	 *
121 	 * Get the graphics
122 	 *
123 	 */
124 	public Graphics getGraphics();
125 	
126 };
127 
128 /***
129  *
130  * $Log: RendererConsumerInterface.java,v $
131  * Revision 1.2  2005/03/19 17:50:02  brian
132  * repackaging
133  *
134  * Revision 1.1  2004/09/11 14:44:59  brian
135  * each class should have an interface and vice versa...
136  *
137  *
138  */