Project

General

Profile

Download (23.4 KB) Statistics
| Branch: | Revision:

library / src / main / java / org / distorted / library / main / DistortedNode.java @ d58b50e7

1 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
2
// Copyright 2016 Leszek Koltunski                                                               //
3
//                                                                                               //
4 46b572b5 Leszek Koltunski
// This file is part of Distorted.                                                               //
5 d333eb6b Leszek Koltunski
//                                                                                               //
6 46b572b5 Leszek Koltunski
// Distorted is free software: you can redistribute it and/or modify                             //
7 d333eb6b Leszek Koltunski
// it under the terms of the GNU General Public License as published by                          //
8
// the Free Software Foundation, either version 2 of the License, or                             //
9
// (at your option) any later version.                                                           //
10
//                                                                                               //
11 46b572b5 Leszek Koltunski
// Distorted is distributed in the hope that it will be useful,                                  //
12 d333eb6b Leszek Koltunski
// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //
13
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //
14
// GNU General Public License for more details.                                                  //
15
//                                                                                               //
16
// You should have received a copy of the GNU General Public License                             //
17 46b572b5 Leszek Koltunski
// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //
18 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
19
20 fe82a979 Leszek Koltunski
package org.distorted.library.main;
21 6a06a912 Leszek Koltunski
22 8dccc3c2 Leszek Koltunski
import android.opengl.GLES31;
23
24 715e7726 Leszek Koltunski
import org.distorted.library.mesh.MeshBase;
25 6c00149d Leszek Koltunski
26 6a06a912 Leszek Koltunski
import java.util.ArrayList;
27 c9f953c2 Leszek Koltunski
import java.util.Collections;
28 6a06a912 Leszek Koltunski
29
///////////////////////////////////////////////////////////////////////////////////////////////////
30
/**
31 a09ada4c Leszek Koltunski
 * Class which represents a Node in a Tree of (InputSurface,Mesh,Effects) triplets.
32 c204c69d leszek
 * <p>
33 a09ada4c Leszek Koltunski
 * Having organized such sets into a Tree, we can then render any Node to any OutputSurface.
34 7b8086eb Leszek Koltunski
 * That recursively renders the set held in the Node and all its children.
35 c204c69d leszek
 * <p>
36
 * The class takes special care to only render identical sub-trees once. Each Node holds a reference
37
 * to sub-class 'NodeData'. Two identical sub-trees attached at different points of the main tree
38 3a70bd6d leszek
 * will point to the same NodeData; only the first of this is rendered (mData.numRender!).
39 6a06a912 Leszek Koltunski
 */
40 7602a827 Leszek Koltunski
public class DistortedNode implements InternalChildrenList.Parent
41 6a06a912 Leszek Koltunski
  {
42 715e7726 Leszek Koltunski
  private MeshBase mMesh;
43 07d8ef09 Leszek Koltunski
  private DistortedEffects mEffects;
44 7602a827 Leszek Koltunski
  private InternalSurface mSurface;
45
  private InternalRenderState mState;
46
  private InternalNodeData mData;
47
  private InternalChildrenList mChildren;
48
  private InternalChildrenList.Parent mParent;
49 11845a9e Leszek Koltunski
50 23eecbd9 Leszek Koltunski
  private int mFboW, mFboH, mFboDepthStencil;
51 11845a9e Leszek Koltunski
  private boolean mRenderWayOIT;
52 bd3da5b2 Leszek Koltunski
53 c43abe6c Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
54
55
  public void markForDeletion()
56
    {
57 8bfefd68 Leszek Koltunski
    if( mData.removeData() )
58 c43abe6c Leszek Koltunski
      {
59 8bfefd68 Leszek Koltunski
      mData.mFBO.markForDeletion();
60
      mData.mFBO = null;
61 c43abe6c Leszek Koltunski
      }
62 d5b709df Leszek Koltunski
    }
63
64
///////////////////////////////////////////////////////////////////////////////////////////////////
65 46b572b5 Leszek Koltunski
// [3] --> the postprocessing queue. See EffectType.
66 c43abe6c Leszek Koltunski
67 d5b709df Leszek Koltunski
  long getBucket()
68
    {
69
    return mEffects.getQueues()[3].getID();
70 c43abe6c Leszek Koltunski
    }
71
72 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
73
74
  private ArrayList<Long> generateIDList()
75
    {
76 9361b337 Leszek Koltunski
    ArrayList<Long> ret = new ArrayList<>();
77 11845a9e Leszek Koltunski
    int numChildren = mChildren.getNumChildren();
78 7691a39f leszek
79 11845a9e Leszek Koltunski
    if( numChildren==0 )
80 7691a39f leszek
      {
81 c9f953c2 Leszek Koltunski
      // add a negative number so this leaf never gets confused with a internal node
82
      // with a single child that happens to have ID identical to some leaf's Effects ID.
83 7691a39f leszek
      ret.add(-mEffects.getID());
84
      }
85 c9f953c2 Leszek Koltunski
    else
86 6a06a912 Leszek Koltunski
      {
87 c9f953c2 Leszek Koltunski
      DistortedNode node;
88 6a06a912 Leszek Koltunski
   
89 11845a9e Leszek Koltunski
      for(int i=0; i<numChildren; i++)
90 c9f953c2 Leszek Koltunski
        {
91 11845a9e Leszek Koltunski
        node = mChildren.getChild(i);
92 c9f953c2 Leszek Koltunski
        ret.add(node.mData.ID);
93
        }
94
95
      // A bit questionable decision here - we are sorting the children IDs, which means
96
      // that order in which we draw the children is going to be undefined (well, this is not
97
      // strictly speaking true - when rendering, if no postprocessing and isomorphism are
98
      // involved, we *DO* render the children in order they were added; if however there
99
      // are two internal nodes with the same list of identical children, just added in a
100
      // different order each time, then we consider them isomorphic, i.e. identical and only
101
      // render the first one. If then two children of such 'pseudo-isomorphic' nodes are at
102
      // exactly the same Z-height this might result in some unexpected sights).
103
      //
104
      // Reason: with the children being sorted by postprocessing buckets, the order is
105
      // undefined anyway (although only when postprocessing is applied).
106
      //
107
      // See the consequences in the 'Olympic' app - remove a few leaves and add them back in
108 d5e053a5 Leszek Koltunski
      // different order. You will see the number of renders go back to the original 15.
109 c9f953c2 Leszek Koltunski
      Collections.sort(ret);
110
      }
111
112
    ret.add( 0, mSurface.getID() );
113
114 6a06a912 Leszek Koltunski
    return ret;
115
    }
116
117 9cae4322 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
118 11845a9e Leszek Koltunski
/**
119
 * This is not really part of the public API. Has to be public only because it is a part of the
120 7602a827 Leszek Koltunski
 * InternalChildrenList.Parent interface.
121 11845a9e Leszek Koltunski
 *
122
 * @y.exclude
123
 */
124
  public void adjustIsomorphism()
125 9cae4322 Leszek Koltunski
    {
126 7602a827 Leszek Koltunski
    InternalNodeData newData = InternalNodeData.returnData(generateIDList());
127 8bfefd68 Leszek Koltunski
    boolean deleteOldFBO = mData.removeData();
128 11845a9e Leszek Koltunski
    boolean createNewFBO = (mChildren.getNumChildren()>0 && newData.mFBO==null);
129 c204c69d leszek
130 f28fffc2 Leszek Koltunski
    if( deleteOldFBO && createNewFBO )
131
      {
132 8bfefd68 Leszek Koltunski
      newData.mFBO = mData.mFBO;
133 f28fffc2 Leszek Koltunski
      }
134
    else if( deleteOldFBO )
135
      {
136
      mData.mFBO.markForDeletion();
137
      mData.mFBO = null;
138
      }
139
    else if( createNewFBO )
140
      {
141 11845a9e Leszek Koltunski
      newData.mFBO = allocateNewFBO();
142 f28fffc2 Leszek Koltunski
      }
143 af27df87 leszek
144 f28fffc2 Leszek Koltunski
    mData = newData;
145 c204c69d leszek
146 f28fffc2 Leszek Koltunski
    if( mParent!=null ) mParent.adjustIsomorphism();
147 fee0865c Leszek Koltunski
    }
148 c204c69d leszek
149 8dccc3c2 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
150
// return the total number of render calls issued
151
152 7602a827 Leszek Koltunski
  int drawNoBlend(long currTime, InternalOutputSurface surface)
153 8dccc3c2 Leszek Koltunski
    {
154 eddf0cb7 Leszek Koltunski
    InternalSurface input = getSurface();
155 8dccc3c2 Leszek Koltunski
156
    if( input.setAsInput() )
157
      {
158
      mState.apply();
159
      GLES31.glDisable(GLES31.GL_BLEND);
160 c90aca24 Leszek Koltunski
      DistortedLibrary.drawPriv(mEffects, mMesh, surface, currTime);
161 8dccc3c2 Leszek Koltunski
      GLES31.glEnable(GLES31.GL_BLEND);
162
      return 1;
163
      }
164 c1a38ba3 Leszek Koltunski
165
    return 0;
166
    }
167
168
///////////////////////////////////////////////////////////////////////////////////////////////////
169
// Use the Order Independent Transparency method to draw a non-postprocessed child.
170
171 7602a827 Leszek Koltunski
  int drawOIT(long currTime, InternalOutputSurface surface)
172 c1a38ba3 Leszek Koltunski
    {
173 eddf0cb7 Leszek Koltunski
    InternalSurface input = getSurface();
174 c1a38ba3 Leszek Koltunski
175
    if( input.setAsInput() )
176
      {
177
      mState.apply();
178 c90aca24 Leszek Koltunski
      DistortedLibrary.drawPrivOIT(mEffects, mMesh, surface, currTime);
179 c1a38ba3 Leszek Koltunski
      return 1;
180
      }
181 8dccc3c2 Leszek Koltunski
182
    return 0;
183
    }
184
185 39086ebb leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
186
// return the total number of render calls issued
187
188 7602a827 Leszek Koltunski
  int draw(long currTime, InternalOutputSurface surface)
189 39086ebb leszek
    {
190 eddf0cb7 Leszek Koltunski
    InternalSurface input = getSurface();
191 39086ebb leszek
192
    if( input.setAsInput() )
193
      {
194
      mState.apply();
195 c90aca24 Leszek Koltunski
      DistortedLibrary.drawPriv(mEffects, mMesh, surface, currTime);
196 39086ebb leszek
      return 1;
197
      }
198
199
    return 0;
200
    }
201
202
///////////////////////////////////////////////////////////////////////////////////////////////////
203
// return the total number of render calls issued
204
205
  int renderRecursive(long currTime)
206
    {
207
    int numRenders = 0;
208 11845a9e Leszek Koltunski
    int numChildren = mChildren.getNumChildren();
209 39086ebb leszek
210 11845a9e Leszek Koltunski
    if( numChildren>0 && mData.notRenderedYetAtThisTime(currTime) )
211 39086ebb leszek
      {
212 d5b709df Leszek Koltunski
      DistortedNode node;
213
      long oldBucket=0, newBucket;
214
215 11845a9e Leszek Koltunski
      for (int i=0; i<numChildren; i++)
216 0c303a2c Leszek Koltunski
        {
217 d5b709df Leszek Koltunski
        node = mChildren.getChild(i);
218
        newBucket = node.getBucket();
219
        numRenders += node.renderRecursive(currTime);
220
        if( newBucket<oldBucket ) mChildren.rearrangeByBuckets(i,newBucket);
221
        else oldBucket=newBucket;
222 0c303a2c Leszek Koltunski
        }
223
224 11845a9e Leszek Koltunski
      if( mData.mFBO==null ) mData.mFBO = allocateNewFBO();
225 95c441a2 leszek
      mData.mFBO.setAsOutput(currTime);
226 39086ebb leszek
227
      if( mSurface.setAsInput() )
228
        {
229
        numRenders++;
230 7602a827 Leszek Koltunski
        DistortedLibrary.blitPriv(mData.mFBO);
231 39086ebb leszek
        }
232
233 11845a9e Leszek Koltunski
      numRenders += mData.mFBO.renderChildren(currTime,numChildren,mChildren,0, mRenderWayOIT);
234 39086ebb leszek
      }
235
236
    return numRenders;
237
    }
238
239 be60d4ff leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
240
241 11845a9e Leszek Koltunski
  private DistortedFramebuffer allocateNewFBO()
242 be60d4ff leszek
    {
243 044b5494 Leszek Koltunski
    int width  = mFboW <= 0 ? (int)mMesh.getStretchX() : mFboW;
244
    int height = mFboH <= 0 ? (int)mMesh.getStretchY() : mFboH;
245 7602a827 Leszek Koltunski
    return new DistortedFramebuffer(1,mFboDepthStencil, InternalSurface.TYPE_TREE, width, height);
246 11845a9e Leszek Koltunski
    }
247
248
///////////////////////////////////////////////////////////////////////////////////////////////////
249
250 7602a827 Leszek Koltunski
  void setParent(InternalChildrenList.Parent parent)
251 11845a9e Leszek Koltunski
    {
252
    mParent = parent;
253 be60d4ff leszek
    }
254
255 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
256
// PUBLIC API
257
///////////////////////////////////////////////////////////////////////////////////////////////////
258
/**
259 a09ada4c Leszek Koltunski
 * Constructs new Node.
260 6a06a912 Leszek Koltunski
 *     
261 c5369f1b leszek
 * @param surface InputSurface to put into the new Node.
262 07d8ef09 Leszek Koltunski
 * @param effects DistortedEffects to put into the new Node.
263 715e7726 Leszek Koltunski
 * @param mesh MeshBase to put into the new Node.
264 6a06a912 Leszek Koltunski
 */
265 7602a827 Leszek Koltunski
  public DistortedNode(InternalSurface surface, DistortedEffects effects, MeshBase mesh)
266 6a06a912 Leszek Koltunski
    {
267 c5369f1b leszek
    mSurface       = surface;
268 8ca9f899 Leszek Koltunski
    mEffects       = effects;
269
    mMesh          = mesh;
270 7602a827 Leszek Koltunski
    mState         = new InternalRenderState();
271
    mChildren      = new InternalChildrenList(this);
272 f28fffc2 Leszek Koltunski
    mParent        = null;
273 406e2f6b Leszek Koltunski
    mRenderWayOIT  = false;
274 f28fffc2 Leszek Koltunski
275 23eecbd9 Leszek Koltunski
    mFboW            = 0;  // i.e. take this from
276 c90aca24 Leszek Koltunski
    mFboH            = 0;  // mEffects's stretch{X,Y}
277 23eecbd9 Leszek Koltunski
    mFboDepthStencil = DistortedFramebuffer.DEPTH_NO_STENCIL;
278
279 7602a827 Leszek Koltunski
    mData = InternalNodeData.returnData(generateIDList());
280 6a06a912 Leszek Koltunski
    }
281
282
///////////////////////////////////////////////////////////////////////////////////////////////////  
283
/**
284 a09ada4c Leszek Koltunski
 * Copy-constructs new Node from another Node.
285 6a06a912 Leszek Koltunski
 *     
286 a09ada4c Leszek Koltunski
 * @param node The DistortedNode to copy data from.
287 6a06a912 Leszek Koltunski
 * @param flags bit field composed of a subset of the following:
288 7602a827 Leszek Koltunski
 *        {@link DistortedLibrary#CLONE_SURFACE},  {@link DistortedLibrary#CLONE_MATRIX}, {@link DistortedLibrary#CLONE_VERTEX},
289
 *        {@link DistortedLibrary#CLONE_FRAGMENT} and {@link DistortedLibrary#CLONE_CHILDREN}.
290 29a06526 Leszek Koltunski
 *        For example flags = CLONE_SURFACE | CLONE_CHILDREN.
291 6a06a912 Leszek Koltunski
 */
292 a09ada4c Leszek Koltunski
  public DistortedNode(DistortedNode node, int flags)
293 6a06a912 Leszek Koltunski
    {
294 be60d4ff leszek
    mEffects      = new DistortedEffects(node.mEffects,flags);
295
    mMesh         = node.mMesh;
296 7602a827 Leszek Koltunski
    mState        = new InternalRenderState();
297 be60d4ff leszek
    mParent       = null;
298 406e2f6b Leszek Koltunski
    mRenderWayOIT = false;
299 9361b337 Leszek Koltunski
300 23eecbd9 Leszek Koltunski
    mFboW            = node.mFboW;
301
    mFboH            = node.mFboH;
302
    mFboDepthStencil = node.mFboDepthStencil;
303
304 7602a827 Leszek Koltunski
    if( (flags & DistortedLibrary.CLONE_SURFACE) != 0 )
305 e7a20702 Leszek Koltunski
      {
306 c5369f1b leszek
      mSurface = node.mSurface;
307 e7a20702 Leszek Koltunski
      }
308
    else
309
      {
310 c5369f1b leszek
      if( node.mSurface instanceof DistortedTexture )
311 8ca9f899 Leszek Koltunski
        {
312 c90aca24 Leszek Koltunski
        mSurface = new DistortedTexture(InternalSurface.TYPE_TREE);
313 8ca9f899 Leszek Koltunski
        }
314 c5369f1b leszek
      else if( node.mSurface instanceof DistortedFramebuffer )
315 8ca9f899 Leszek Koltunski
        {
316 d58b50e7 Leszek Koltunski
        DistortedFramebuffer fbo = (DistortedFramebuffer)node.mSurface;
317
318
        int w = fbo.getWidth();
319
        int h = fbo.getHeight();
320 23eecbd9 Leszek Koltunski
        int depthStencil = DistortedFramebuffer.NO_DEPTH_NO_STENCIL;
321 89de975c leszek
322 d58b50e7 Leszek Koltunski
        if( fbo.hasDepth() )
323 89de975c leszek
          {
324 d58b50e7 Leszek Koltunski
          boolean hasStencil = fbo.hasStencil();
325 89de975c leszek
          depthStencil = (hasStencil ? DistortedFramebuffer.BOTH_DEPTH_STENCIL:DistortedFramebuffer.DEPTH_NO_STENCIL);
326
          }
327
328 7602a827 Leszek Koltunski
        mSurface = new DistortedFramebuffer(1,depthStencil, InternalSurface.TYPE_TREE,w,h);
329 8ca9f899 Leszek Koltunski
        }
330 e7a20702 Leszek Koltunski
      }
331 11845a9e Leszek Koltunski
332 7602a827 Leszek Koltunski
    if( (flags & DistortedLibrary.CLONE_CHILDREN) != 0 )
333 6a06a912 Leszek Koltunski
      {
334
      mChildren = node.mChildren;
335
      }
336
    else
337
      {
338 7602a827 Leszek Koltunski
      mChildren = new InternalChildrenList(this);
339 6a06a912 Leszek Koltunski
      }
340 26a4e5f6 leszek
341 7602a827 Leszek Koltunski
    mData = InternalNodeData.returnData(generateIDList());
342 6a06a912 Leszek Koltunski
    }
343 c204c69d leszek
344 406e2f6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
345
  /**
346
   * When rendering this Node, should we use the Order Independent Transparency render more?
347
   * <p>
348
   * There are two modes of rendering: the fast 'normal' way, which however renders transparent
349
   * fragments in different ways depending on which fragments get rendered first, or the slower
350
   * 'oit' way, which renders transparent fragments correctly regardless of their order.
351
   *
352
   * @param oit True if we want to render more slowly, but in a way which accounts for transparency.
353
   */
354
  public void setOrderIndependentTransparency(boolean oit)
355
    {
356
    mRenderWayOIT = oit;
357
    }
358
359 12f9e4bb Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
360
  /**
361
   * When rendering this Node, should we use the Order Independent Transparency render more?
362
   * <p>
363
   * There are two modes of rendering: the fast 'normal' way, which however renders transparent
364
   * fragments in different ways depending on which fragments get rendered first, or the slower
365
   * 'oit' way, which renders transparent fragments correctly regardless of their order.
366
   *
367
   * @param oit True if we want to render more slowly, but in a way which accounts for transparency.
368
   * @param initialSize Initial number of transparent fragments we expect, in screenfulls.
369 f953bee0 Leszek Koltunski
   *                    I.e '1.0' means 'the scene we are going to render contains dialog_about 1 screen
370 12f9e4bb Leszek Koltunski
   *                    worth of transparent fragments'. Valid values: 0.0 &lt; initialSize &lt; 10.0
371
   *                    Even if you get this wrong, the library will detect that there are more
372
   *                    transparent fragments than it has space for and readjust its internal buffers,
373
   *                    but only after a few frames during which one will probably see missing objects.
374
   */
375
  public void setOrderIndependentTransparency(boolean oit, float initialSize)
376
    {
377
    mRenderWayOIT = oit;
378
379
    if( initialSize>0.0f && initialSize<10.0f )
380 7602a827 Leszek Koltunski
      DistortedLibrary.setSSBOSize(initialSize);
381 12f9e4bb Leszek Koltunski
    }
382
383 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
384
/**
385
 * Adds a new child to the last position in the list of our Node's children.
386 c204c69d leszek
 * <p>
387
 * We cannot do this mid-render - actual attachment will be done just before the next render, by the
388 7602a827 Leszek Koltunski
 * InternalMaster (by calling doWork())
389 c204c69d leszek
 *
390 6a06a912 Leszek Koltunski
 * @param node The new Node to add.
391
 */
392 c204c69d leszek
  public void attach(DistortedNode node)
393 6a06a912 Leszek Koltunski
    {
394 11845a9e Leszek Koltunski
    mChildren.attach(node);
395 6a06a912 Leszek Koltunski
    }
396 c204c69d leszek
397 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
398
/**
399
 * Adds a new child to the last position in the list of our Node's children.
400 c204c69d leszek
 * <p>
401
 * We cannot do this mid-render - actual attachment will be done just before the next render, by the
402 7602a827 Leszek Koltunski
 * InternalMaster (by calling doWork())
403 c204c69d leszek
 *
404 c5369f1b leszek
 * @param surface InputSurface to initialize our child Node with.
405 07d8ef09 Leszek Koltunski
 * @param effects DistortedEffects to initialize our child Node with.
406 715e7726 Leszek Koltunski
 * @param mesh MeshBase to initialize our child Node with.
407 6a06a912 Leszek Koltunski
 * @return the newly constructed child Node, or null if we couldn't allocate resources.
408
 */
409 7602a827 Leszek Koltunski
  public DistortedNode attach(InternalSurface surface, DistortedEffects effects, MeshBase mesh)
410 6a06a912 Leszek Koltunski
    {
411 11845a9e Leszek Koltunski
    return mChildren.attach(surface,effects,mesh);
412 c204c69d leszek
    }
413 f8377ef8 leszek
414 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
415
/**
416
 * Removes the first occurrence of a specified child from the list of children of our Node.
417 c204c69d leszek
 * <p>
418
 * We cannot do this mid-render - actual detachment will be done just before the next render, by the
419 7602a827 Leszek Koltunski
 * InternalMaster (by calling doWork())
420 c204c69d leszek
 *
421 6a06a912 Leszek Koltunski
 * @param node The Node to remove.
422
 */
423 c204c69d leszek
  public void detach(DistortedNode node)
424 6a06a912 Leszek Koltunski
    {
425 11845a9e Leszek Koltunski
    mChildren.detach(node);
426 6a06a912 Leszek Koltunski
    }
427 a09ada4c Leszek Koltunski
428 6a06a912 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
429
/**
430
 * Removes the first occurrence of a specified child from the list of children of our Node.
431 a09ada4c Leszek Koltunski
 * <p>
432
 * A bit questionable method as there can be many different Nodes attached as children, some
433
 * of them having the same Effects but - for instance - different Mesh. Use with care.
434 c204c69d leszek
 * <p>
435
 * We cannot do this mid-render - actual detachment will be done just before the next render, by the
436 7602a827 Leszek Koltunski
 * InternalMaster (by calling doWork())
437 a09ada4c Leszek Koltunski
 *
438 07d8ef09 Leszek Koltunski
 * @param effects DistortedEffects to remove.
439 6a06a912 Leszek Koltunski
 */
440 c204c69d leszek
  public void detach(DistortedEffects effects)
441 6a06a912 Leszek Koltunski
    {
442 11845a9e Leszek Koltunski
    mChildren.detach(effects);
443 c204c69d leszek
    }
444
445
///////////////////////////////////////////////////////////////////////////////////////////////////
446
/**
447
 * Removes all children Nodes.
448
 * <p>
449
 * We cannot do this mid-render - actual detachment will be done just before the next render, by the
450 7602a827 Leszek Koltunski
 * InternalMaster (by calling doWork())
451 c204c69d leszek
 */
452
  public void detachAll()
453
    {
454 11845a9e Leszek Koltunski
    mChildren.detachAll();
455 6a06a912 Leszek Koltunski
    }
456 13687207 leszek
457 27f42cd6 leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
458 6a06a912 Leszek Koltunski
/**
459 421c2728 Leszek Koltunski
 * Returns the DistortedEffects object that's in the Node.
460 6a06a912 Leszek Koltunski
 * 
461 421c2728 Leszek Koltunski
 * @return The DistortedEffects contained in the Node.
462 6a06a912 Leszek Koltunski
 */
463 421c2728 Leszek Koltunski
  public DistortedEffects getEffects()
464 6a06a912 Leszek Koltunski
    {
465 07d8ef09 Leszek Koltunski
    return mEffects;
466 4e2382f3 Leszek Koltunski
    }
467
468 a13dde77 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
469
  /**
470 eddf0cb7 Leszek Koltunski
   * Returns the surface this object gets rendered to.
471 a13dde77 Leszek Koltunski
   *
472 7602a827 Leszek Koltunski
   * @return The InternalSurface contained in the Node (if a leaf), or the FBO (if an internal Node)
473 a13dde77 Leszek Koltunski
   */
474 eddf0cb7 Leszek Koltunski
  public InternalSurface getSurface()
475 a13dde77 Leszek Koltunski
    {
476 11845a9e Leszek Koltunski
    return mChildren.getNumChildren()==0 ? mSurface : mData.mFBO;
477 a13dde77 Leszek Koltunski
    }
478
479 f1a82766 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
480
/**
481
 * Returns the Mesh object that's in the Node.
482
 *
483
 * @return Mesh contained in the Node.
484
 */
485 715e7726 Leszek Koltunski
  public MeshBase getMesh()
486 f1a82766 Leszek Koltunski
    {
487
    return mMesh;
488
    }
489
490 8c327653 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
491
/**
492 23eecbd9 Leszek Koltunski
 * Resizes the DistortedFramebuffer object that we render this Node to.
493 8c327653 Leszek Koltunski
 */
494 23eecbd9 Leszek Koltunski
  public void resize(int width, int height)
495 8c327653 Leszek Koltunski
    {
496 23eecbd9 Leszek Koltunski
    mFboW = width;
497
    mFboH = height;
498
499
    if ( mData.mFBO !=null )
500
      {
501
      // TODO: potentially allocate a new NodeData if we have to
502
      mData.mFBO.resize(width,height);
503
      }
504
    }
505
506
///////////////////////////////////////////////////////////////////////////////////////////////////
507
/**
508
 * Enables/disables DEPTH and STENCIL buffers in the Framebuffer object that we render this Node to.
509
 */
510
  public void enableDepthStencil(int depthStencil)
511
    {
512
    mFboDepthStencil = depthStencil;
513
514
    if ( mData.mFBO !=null )
515
      {
516
      // TODO: potentially allocate a new NodeData if we have to
517
      mData.mFBO.enableDepthStencil(depthStencil);
518
      }
519 8c327653 Leszek Koltunski
    }
520 6a06a912 Leszek Koltunski
521 ad16ed3b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
522
// APIs that control how to set the OpenGL state just before rendering this Node.
523 c834348d leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
524
/**
525
 * When rendering this Node, use ColorMask (r,g,b,a).
526
 *
527
 * @param r Write to the RED color channel when rendering this Node?
528
 * @param g Write to the GREEN color channel when rendering this Node?
529
 * @param b Write to the BLUE color channel when rendering this Node?
530
 * @param a Write to the ALPHA channel when rendering this Node?
531
 */
532 13687207 leszek
  @SuppressWarnings("unused")
533 c834348d leszek
  public void glColorMask(boolean r, boolean g, boolean b, boolean a)
534
    {
535
    mState.glColorMask(r,g,b,a);
536
    }
537
538
///////////////////////////////////////////////////////////////////////////////////////////////////
539
/**
540
 * When rendering this Node, switch on writing to Depth buffer?
541
 *
542
 * @param mask Write to the Depth buffer when rendering this Node?
543
 */
544 13687207 leszek
  @SuppressWarnings("unused")
545 c834348d leszek
  public void glDepthMask(boolean mask)
546
    {
547
    mState.glDepthMask(mask);
548
    }
549
550
///////////////////////////////////////////////////////////////////////////////////////////////////
551
/**
552
 * When rendering this Node, which bits of the Stencil buffer to write to?
553
 *
554
 * @param mask Marks the bits of the Stencil buffer we will write to when rendering this Node.
555
 */
556 13687207 leszek
  @SuppressWarnings("unused")
557 c834348d leszek
  public void glStencilMask(int mask)
558
    {
559
    mState.glStencilMask(mask);
560
    }
561
562
///////////////////////////////////////////////////////////////////////////////////////////////////
563
/**
564
 * When rendering this Node, which Tests to enable?
565
 *
566
 * @param test Valid values: GL_DEPTH_TEST, GL_STENCIL_TEST, GL_BLEND
567
 */
568 13687207 leszek
  @SuppressWarnings("unused")
569 c834348d leszek
  public void glEnable(int test)
570
    {
571
    mState.glEnable(test);
572
    }
573
574
///////////////////////////////////////////////////////////////////////////////////////////////////
575
/**
576
 * When rendering this Node, which Tests to enable?
577
 *
578
 * @param test Valid values: GL_DEPTH_TEST, GL_STENCIL_TEST, GL_BLEND
579
 */
580 13687207 leszek
  @SuppressWarnings("unused")
581 c834348d leszek
  public void glDisable(int test)
582
    {
583
    mState.glDisable(test);
584
    }
585
586
///////////////////////////////////////////////////////////////////////////////////////////////////
587
/**
588
 * When rendering this Node, use the following StencilFunc.
589
 *
590
 * @param func Valid values: GL_NEVER, GL_ALWAYS, GL_LESS, GL_LEQUAL, GL_EQUAL, GL_GEQUAL, GL_GREATER, GL_NOTEQUAL
591
 * @param ref  Reference valut to compare our stencil with.
592
 * @param mask Mask used when comparing.
593
 */
594 13687207 leszek
  @SuppressWarnings("unused")
595 c834348d leszek
  public void glStencilFunc(int func, int ref, int mask)
596
    {
597
    mState.glStencilFunc(func,ref,mask);
598
    }
599
600
///////////////////////////////////////////////////////////////////////////////////////////////////
601
/**
602
 * When rendering this Node, use the following StencilOp.
603
 * <p>
604
 * Valid values of all 3 parameters: GL_KEEP, GL_ZERO, GL_REPLACE, GL_INCR, GL_DECR, GL_INVERT, GL_INCR_WRAP, GL_DECR_WRAP
605
 *
606
 * @param sfail  What to do when Stencil Test fails.
607
 * @param dpfail What to do when Depth Test fails.
608
 * @param dppass What to do when Depth Test passes.
609
 */
610 13687207 leszek
  @SuppressWarnings("unused")
611 c834348d leszek
  public void glStencilOp(int sfail, int dpfail, int dppass)
612
    {
613
    mState.glStencilOp(sfail,dpfail,dppass);
614
    }
615
616
///////////////////////////////////////////////////////////////////////////////////////////////////
617
/**
618
 * When rendering this Node, use the following DepthFunc.
619
 *
620
 * @param func Valid values: GL_NEVER, GL_ALWAYS, GL_LESS, GL_LEQUAL, GL_EQUAL, GL_GEQUAL, GL_GREATER, GL_NOTEQUAL
621
 */
622 13687207 leszek
  @SuppressWarnings("unused")
623 c834348d leszek
  public void glDepthFunc(int func)
624
    {
625
    mState.glDepthFunc(func);
626
    }
627
628
///////////////////////////////////////////////////////////////////////////////////////////////////
629
/**
630
 * When rendering this Node, use the following Blending mode.
631
 * <p>
632
 * Valid values: GL_ZERO, GL_ONE, GL_SRC_COLOR, GL_ONE_MINUS_SRC_COLOR, GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA,
633
 *               GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA, GL_CONSTANT_COLOR, GL_ONE_MINUS_CONSTANT_COLOR,
634
 *               GL_CONSTANT_ALPHA, GL_ONE_MINUS_CONSTANT_ALPHA, GL_SRC_ALPHA_SATURATE
635
 *
636
 * @param src Source Blend function
637
 * @param dst Destination Blend function
638
 */
639 13687207 leszek
  @SuppressWarnings("unused")
640 c834348d leszek
  public void glBlendFunc(int src, int dst)
641
    {
642
    mState.glBlendFunc(src,dst);
643
    }
644 ad16ed3b Leszek Koltunski
645
///////////////////////////////////////////////////////////////////////////////////////////////////
646
/**
647
 * Before rendering this Node, clear the following buffers.
648
 * <p>
649
 * Valid values: 0, or bitwise OR of one or more values from the set GL_COLOR_BUFFER_BIT,
650
 *               GL_DEPTH_BUFFER_BIT, GL_STENCIL_BUFFER_BIT.
651
 * Default: 0
652
 *
653
 * @param mask bitwise OR of BUFFER_BITs to clear.
654
 */
655
  @SuppressWarnings("unused")
656
  public void glClear(int mask)
657
    {
658
    mState.glClear(mask);
659
    }
660 8c327653 Leszek Koltunski
  }