Source/System/Window/Background/OSGSkyBackground.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="SkyBackground"
   5    parent="Background"
   6    library="Window"
   7    pointerfieldtypes="multi"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    decoratable="false"
  12    useLocalIncludes="false"
  13    docGroupBase="GrpWindowBackground"
  14    >
  15   A Sky/Ground/Skybox background, inspired by VRML, see \ref
  16   PageSystemWindowBackgroundSky for a description.
  17
  18   The sky is defined by the _mfSkyAngle and _mfSkyColor fields, the ground by
  19   the _mfGroundAngle and _mfGround Color fields. The resolution of the sky
  20   sphere can be influenced by the _sfSphereRes field. The sky box is defined
  21   by the _sfBackTexture, _sfFrontTexture, _sfLeftTexture, _sfRightTexture,
  22   _sfTopTexture and _sfBottomTexture fields.
  23   <Field
  24          name="skyColor"
  25          type="Color4f"
  26          cardinality="multi"
  27          visibility="external"
  28          access="public"
  29          >
  30         The colors for the sky gradient bands. Corresponds to the skyAngle
  31     angles.  The first value is for the apex (i.e. straight up), which
  32     doesn't need an angle, thus there  should be one more color than
  33     angles. If no angles are given color[0] is used, or black if none are
  34     given.
  35   </Field>
  36   <Field
  37          name="skyAngle"
  38          type="Real32"
  39          cardinality="multi"
  40          visibility="external"
  41          access="public"
  42          >
  43         The angles for the sky gradient bands. Corresponds to the skyColor colors,
  44     with the exception of the apex. Values should be between 0 and PI.
  45   </Field>
  46   <Field
  47          name="groundColor"
  48          type="Color4f"
  49          cardinality="multi"
  50          visibility="external"
  51          access="public"
  52          >
  53         The colors of the ground sphere-part. Interpretation is similar to the sky.
  54   </Field>
  55   <Field
  56          name="groundAngle"
  57          type="Real32"
  58          cardinality="multi"
  59          visibility="external"
  60          access="public"
  61          >
  62         The angles of the ground sphere-part. Interpretation is similar to the sky, with
  63     0 being straight down.
  64   </Field>
  65   <Field
  66          name="sphereRes"
  67          type="UInt32"
  68          cardinality="single"
  69          visibility="external"
  70          defaultValue="8"
  71          access="public"
  72          >
  73         The polygonal resolution of the sky/ground sphere.
  74   </Field>
  75   <Field
  76          name="backTexture"
  77          type="TextureBaseChunkPtr"
  78          cardinality="single"
  79          visibility="external"
  80          defaultValue="NULL"
  81          access="public"
  82          >
  83         Texture for the back (+Z) side of the sky cube.
  84   </Field>
  85   <Field
  86          name="bottomTexture"
  87          type="TextureBaseChunkPtr"
  88          cardinality="single"
  89          visibility="external"
  90          defaultValue="NULL"
  91          access="public"
  92          >
  93         Texture for the bottom (-Y) side of the sky cube.
  94   </Field>
  95   <Field
  96          name="frontTexture"
  97          type="TextureBaseChunkPtr"
  98          cardinality="single"
  99          visibility="external"
 100          defaultValue="NULL"
 101          access="public"
 102          >
 103         Texture for the front (-Z) side of the sky cube.
 104   </Field>
 105   <Field
 106          name="leftTexture"
 107          type="TextureBaseChunkPtr"
 108          cardinality="single"
 109          visibility="external"
 110          defaultValue="NULL"
 111          access="public"
 112          >
 113         Texture for the left (-X) side of the sky cube.
 114   </Field>
 115   <Field
 116          name="rightTexture"
 117          type="TextureBaseChunkPtr"
 118          cardinality="single"
 119          visibility="external"
 120          defaultValue="NULL"
 121          access="public"
 122          >
 123         Texture for the right (+X) side of the sky cube.
 124   </Field>
 125   <Field
 126          name="topTexture"
 127          type="TextureBaseChunkPtr"
 128          cardinality="single"
 129          visibility="external"
 130          defaultValue="NULL"
 131          access="public"
 132          >
 133         Texture for the top (+Y) side of the sky cube.
 134   </Field>
 135   <Field
 136          name="boxInside"
 137          type="bool"
 138          cardinality="single"
 139          visibility="external"
 140          defaultValue="true"
 141          access="public"
 142          >
 143         Flag to draw the box inside or outside of the sphere
 144   </Field>
 145   <Field
 146          name="topTexCoord"
 147          type="Vec3f"
 148          cardinality="multi"
 149          visibility="external"
 150          access="public"
 151          >
 152         Texture coordinates for the top face
 153   </Field>
 154   <Field
 155          name="bottomTexCoord"
 156          type="Vec3f"
 157          cardinality="multi"
 158          visibility="external"
 159          access="public"
 160          >
 161         Bottom texture coordinates.
 162   </Field>
 163   <Field
 164          name="rightTexCoord"
 165          type="Vec3f"
 166          cardinality="multi"
 167          visibility="external"
 168          access="public"
 169          >
 170         Right texture coordinates.
 171   </Field>
 172   <Field
 173          name="leftTexCoord"
 174          type="Vec3f"
 175          cardinality="multi"
 176          visibility="external"
 177          access="public"
 178          >
 179         Left texture coordinates.
 180   </Field>
 181   <Field
 182          name="frontTexCoord"
 183          type="Vec3f"
 184          cardinality="multi"
 185          visibility="external"
 186          access="public"
 187          >
 188         Front texture coordinates.
 189   </Field>
 190   <Field
 191          name="backTexCoord"
 192          type="Vec3f"
 193          cardinality="multi"
 194          visibility="external"
 195          access="public"
 196          >
 197         Back texture coordinates.
 198   </Field>
 199   <Field
 200          name="beacon"
 201          type="Node"
 202      category="weakpointer"
 203          cardinality="single"
 204          visibility="external"
 205          access="public"
 206          >
 207         The object that defines the orientation of the background, i.e. the
 208         local coordinate system it is drawn in.
 209   </Field>
 210   <Field
 211      name="useVRMLCubeTextureSemantics"
 212      type="bool"
 213      cardinality="single"
 214      visibility="external"
 215      defaultValue="false"
 216      access="public"
 217      >
 218     Whether to use VRML Semantics for the orientation of cube texture sides or
 219     the default OpenGL semantics.
 220     Note: OpenSG 1.x always used VRML Semantics.
 221   </Field>
 222 </FieldContainer>