simgear/scene/util/RenderConstants.hxx

   1 /* -*-c++-*-
   2  *
   3  * Copyright (C) 2006-2007 Tim Moore
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  18  * MA 02110-1301, USA.
  19  *
  20  */
  21
  22 #ifndef SIMGEAR_RENDER_CONSTANTS_HXX
  23 #define SIMGEAR_RENDER_CONSTANTS_HXX
  24 // Constants used in the scene graph, both node masks and render bins.
  25 namespace simgear {
  26
  27 enum NodeMask {
  28     TERRAIN_BIT = (1 << 0),
  29     MAINMODEL_BIT = (1 << 1),
  30     CASTSHADOW_BIT = (1 << 2),
  31     RECEIVESHADOW_BIT = (1 << 3),
  32     GUI_BIT = (1 << 4),
  33     PANEL2D_BIT = (1 << 5),
  34     PICK_BIT = (1 << 6),
  35     // Different classes of lights turned on by node masks
  36     GROUNDLIGHTS0_BIT = (1 << 7),
  37     GROUNDLIGHTS1_BIT = (1 << 8),
  38     GROUNDLIGHTS2_BIT = (1 << 9),
  39     RUNWAYLIGHTS_BIT = (1 << 10),
  40     LIGHTS_BITS = (GROUNDLIGHTS0_BIT | GROUNDLIGHTS1_BIT | GROUNDLIGHTS2_BIT
  41                    | RUNWAYLIGHTS_BIT),
  42     // Sky parts
  43     BACKGROUND_BIT = (1 << 11),
  44     // Everything else that isn't terrain. Initially for clouds;
  45     // eventually for other models?
  46     MODEL_BIT = (1 << 12),
  47     MODELLIGHT_BIT = (1 << 13),
  48     PERMANENTLIGHT_BIT = (1 << 14)
  49 };
  50
  51 // Theory of bin numbering:
  52 //
  53 // Normal opaque objects are assigned bin 0.
  54 //
  55 // Random objects like trees may have transparency, but there are too
  56 // many to depth sort individually. By drawing them after the terrain
  57 // we can at least keep the sky under the ground from poking through.
  58 //
  59 // Point lights blend with the terrain to simulate attenuation but
  60 // should completely obscure any transparent geometry behind
  61 // them. Also, they should be visible through semi-transparent cloud
  62 // layers, so they are rendered before the cloud layers.
  63 //
  64 // Clouds layers can't be depth sorted because they are too big, so
  65 // they are rendered before other transparent objects. The layer
  66 // partial ordering is handled in the clouds code.
  67 //
  68 // OSG and its file loaders throw all transparent objects into bin 10.
  69
  70 enum RenderBin {
  71     RANDOM_OBJECTS_BIN = 2,
  72     POINT_LIGHTS_BIN = 8,
  73     CLOUDS_BIN = 9,
  74     TRANSPARENT_BIN = 10        // assigned by OSG
  75 };
  76 }
  77 #endif