Source/System/State/Base/OSGPolygonChunk.fcd

   1 <?xml version="1.0" ?>
   2
   3 <FieldContainer
   4    name="PolygonChunk"
   5    parent="StateChunk"
   6    library="System"
   7    structure="concrete"
   8    pointerfieldtypes="both"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    docGroupBase="GrpSystemState"
  12 ><![CDATA[
  13
  14 See \ref PageSystemPolygonChunk for details.
  15
  16 The parameters of the following functions are wrapped here:
  17 <ul>
  18 <li>glCullFace() (OSG::PolygonChunk::_sfCullFace),</li>
  19 <li>glFrontFace()(OSG::PolygonChunk::_sfFrontFace),</li>
  20 <li>glPolygonMode() (OSG::PolygonChunk::_sfFrontMode, OSG::PolygonChunk::_sfBackMode),</li>
  21 <li>glEnable(GL_POLYGON_SMOOTH) (OSG::PolygonChunk::_sfSmooth),</li>
  22 <li>glPolygonOffset() (OSG::PolygonChunk::_sfOffsetFactor, OSG::PolygonChunk::_sfOffsetBias),</li>
  23 <li>glEnable(GL_POLYGON_OFFSET_POINT) (OSG::PolygonChunk::_sfOffsetPoint),</li>
  24 <li>glEnable(GL_POLYGON_OFFSET_LINE) (OSG::PolygonChunk::_sfOffsetLine),</li>
  25 <li>glEnable(GL_POLYGON_OFFSET_FILL) (OSG::PolygonChunk::_sfOffsetFill),</li>
  26 <li>glStipplePattern() and glEnable(GL_POLYGON_STIPPLE) (OSG::PolygonChunk::_sfStipple).</li>
  27 </ul>]]>
  28         <Field
  29                 name="cullFace"
  30                 type="GLenum"
  31                 cardinality="single"
  32                 visibility="external"
  33                 defaultValue="GL_NONE"
  34                 defaultHeader="&quot;OSGGL.h&quot;"
  35                 potential_values="GL_NONE,GL_FRONT,GL_BACK,GL_FRONT_AND_BACK"
  36         >
  37         Defines which side of the polygon is invisible. Set to GL_NONE to not cull anything. See glCullFace.
  38         </Field>
  39         <Field
  40                 name="frontFace"
  41                 type="GLenum"
  42                 cardinality="single"
  43                 visibility="external"
  44                 defaultValue="GL_CCW"
  45                 defaultHeader="&quot;OSGGL.h&quot;"
  46                 potential_values="GL_CCW,GL_CW"
  47         >
  48         Defines which side of the polygon is considered the front side base on vertex ordering
  49         of clockwise (CW) of counter clockwise (CCW). defaults to GL_CCW.  See glFrontFace.
  50         </Field>
  51         <Field
  52                 name="frontMode"
  53                 type="GLenum"
  54                 cardinality="single"
  55                 visibility="external"
  56                 defaultValue="GL_FILL"
  57                 defaultHeader="&quot;OSGGL.h&quot;"
  58                 potential_values="GL_FILL,GL_LINE,GL_POINT"
  59         >
  60         Defines if polygon front sides are rendered filled (default), outlined or as points.  See glPolygonMode.
  61         </Field>
  62         <Field
  63                 name="backMode"
  64                 type="GLenum"
  65                 cardinality="single"
  66                 visibility="external"
  67                 defaultValue="GL_FILL"
  68                 defaultHeader="&quot;OSGGL.h&quot;"
  69                 potential_values="GL_FILL,GL_LINE,GL_POINT"
  70         >
  71         Defines if polygon front sides are rendered filled (default), outlined or as points. See glPolygonMode.
  72         </Field>
  73         <Field
  74                 name="smooth"
  75                 type="bool"
  76                 cardinality="single"
  77                 visibility="external"
  78                 defaultValue="GL_FALSE"
  79                 defaultHeader="&quot;OSGGL.h&quot;"
  80         >
  81         Defines if polygon antialiasing is used.  See GL_POLYGON_SMOOTH.
  82         </Field>
  83         <Field
  84                 name="offsetFactor"
  85                 type="Real32"
  86                 cardinality="single"
  87                 visibility="external"
  88                 defaultValue="0"
  89         >
  90         Defines the offset factor.  See glPolygonOffset.
  91         </Field>
  92         <Field
  93                 name="offsetBias"
  94                 type="Real32"
  95                 cardinality="single"
  96                 visibility="external"
  97                 defaultValue="0"
  98         >
  99         Defines the offset bias.  See glPolygonOffset.
 100         </Field>
 101         <Field
 102                 name="offsetPoint"
 103                 type="bool"
 104                 cardinality="single"
 105                 visibility="external"
 106                 defaultValue="GL_FALSE"
 107                 defaultHeader="&quot;OSGGL.h&quot;"
 108         >
 109         Enables offsetting for points.
 110         </Field>
 111         <Field
 112                 name="offsetLine"
 113                 type="bool"
 114                 cardinality="single"
 115                 visibility="external"
 116                 defaultValue="GL_FALSE"
 117                 defaultHeader="&quot;OSGGL.h&quot;"
 118         >
 119         Enables offsetting for lines.
 120         </Field>
 121         <Field
 122                 name="offsetFill"
 123                 type="bool"
 124                 cardinality="single"
 125                 visibility="external"
 126                 defaultValue="GL_FALSE"
 127                 defaultHeader="&quot;OSGGL.h&quot;"
 128         >
 129         Enables offsetting for polygons.
 130         </Field>
 131         <Field
 132                 name="stipple"
 133                 type="Int32"
 134                 cardinality="multi"
 135                 visibility="external"
 136                 defaultValue=""
 137         >
 138         Defines the stipple pattern. Is only valid and used if it contains
 139         32 elements.
 140         </Field>
 141 </FieldContainer>