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.post;
34
35import com.jme3.renderer.RenderManager;
36import com.jme3.renderer.ViewPort;
37import com.jme3.renderer.queue.RenderQueue;
38import com.jme3.texture.FrameBuffer;
39
40/**
41 * Scene processors are used to compute/render things before and after the classic render of the scene.
42 * They have to be added to a viewport and are rendered in the order they've been added
43 *
44 * @author Kirill Vainer
45 */
46public interface SceneProcessor {
47
48    /**
49     * Called in the render thread to initialize the scene processor.
50     *
51     * @param rm The render manager to which the SP was added to
52     * @param vp The viewport to which the SP is assigned
53     */
54    public void initialize(RenderManager rm, ViewPort vp);
55
56    /**
57     * Called when the resolution of the viewport has been changed.
58     * @param vp
59     */
60    public void reshape(ViewPort vp, int w, int h);
61
62    /**
63     * @return True if initialize() has been called on this SceneProcessor,
64     * false if otherwise.
65     */
66    public boolean isInitialized();
67
68    /**
69     * Called before a frame
70     *
71     * @param tpf Time per frame
72     */
73    public void preFrame(float tpf);
74
75    /**
76     * Called after the scene graph has been queued, but before it is flushed.
77     *
78     * @param rq The render queue
79     */
80    public void postQueue(RenderQueue rq);
81
82    /**
83     * Called after a frame has been rendered and the queue flushed.
84     *
85     * @param out The FB to which the scene was rendered.
86     */
87    public void postFrame(FrameBuffer out);
88
89    /**
90     * Called when the SP is removed from the RM.
91     */
92    public void cleanup();
93
94}
95