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
33package com.jme3.system;
34
35/**
36 * The <code>ContextListener> provides a means for an application
37 * to receive events relating to a context.
38 */
39public interface SystemListener {
40
41    /**
42     * Callback to indicate the application to initialize. This method
43     * is called in the GL/Rendering thread so any GL-dependent resources
44     * can be initialized.
45     */
46    public void initialize();
47
48    /**
49     * Called to notify the application that the resolution has changed.
50     * @param width
51     * @param height
52     */
53    public void reshape(int width, int height);
54
55    /**
56     * Callback to update the application state, and render the scene
57     * to the back buffer.
58     */
59    public void update();
60
61    /**
62     * Called when the user requests to close the application. This
63     * could happen when he clicks the X button on the window, presses
64     * the Alt-F4 combination, attempts to shutdown the process from
65     * the task manager, or presses ESC.
66     * @param esc If true, the user pressed ESC to close the application.
67     */
68    public void requestClose(boolean esc);
69
70    /**
71     * Called when the application gained focus. The display
72     * implementation is not allowed to call this method before
73     * initialize() has been called or after destroy() has been called.
74     */
75    public void gainFocus();
76
77    /**
78     * Called when the application lost focus. The display
79     * implementation is not allowed to call this method before
80     * initialize() has been called or after destroy() has been called.
81     */
82    public void loseFocus();
83
84    /**
85     * Called when an error has occured. This is typically
86     * invoked when an uncought exception is thrown in the render thread.
87     * @param errorMsg The error message, if any, or null.
88     * @param t Throwable object, or null.
89     */
90    public void handleError(String errorMsg, Throwable t);
91
92    /**
93     * Callback to indicate that the context has been destroyed (either
94     * by the user or requested by the application itself). Typically
95     * cleanup of native resources should happen here. This method is called
96     * in the GL/Rendering thread.
97     */
98    public void destroy();
99}
100