Source/System/Window/Foreground/OSGPolygonForeground.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="PolygonForeground"
   5    parent="Foreground"
   6    library="Window"
   7    pointerfieldtypes="both"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    decoratable="false"
  12    useLocalIncludes="false"
  13    docGroupBase="GrpWindowForeground"
  14    >
  15   A foreground that renders a single polygon used the specified material,
  16   see \ref PageSystemPolygonForeground for a
  17   description.
  18
  19   The polygon material is defined by _sfMaterial, the positions by _mfPositions,
  20   the texture coordinates by _mfTexCoords (there must be as many texture
  21   coordinates as positions). The interpretation of the positions is
  22   controlled by _sfNormalizedX and _sfNormalizedY.
  23   <Field
  24          name="material"
  25          type="PrimeMaterialPtr"
  26          cardinality="single"
  27          visibility="external"
  28          access="public"
  29          >
  30         The material used to display.
  31   </Field>
  32   <Field
  33          name="positions"
  34          type="Pnt2f"
  35          cardinality="multi"
  36          visibility="external"
  37          access="public"
  38          >
  39         The vertices of the geometry to display.
  40   </Field>
  41   <Field
  42          name="texCoords"
  43          type="Vec3f"
  44          cardinality="multi"
  45          visibility="external"
  46          access="public"
  47          >
  48         The texture coordinates of the geometry to display.
  49   </Field>
  50   <Field
  51          name="normalizedX"
  52          type="bool"
  53          cardinality="single"
  54          visibility="external"
  55          defaultValue="true"
  56          access="public"
  57          >
  58         Define whether the x coordinates are normalized (0-1) or pixel-based.
  59   </Field>
  60   <Field
  61          name="normalizedY"
  62          type="bool"
  63          cardinality="single"
  64          visibility="external"
  65          defaultValue="true"
  66          access="public"
  67          >
  68         Define whether the y coordinates are normalized (0-1) or pixel-based.
  69   </Field>
  70   <Field
  71          name="aspectHeight"
  72          type="UInt16"
  73          cardinality="single"
  74          visibility="external"
  75          defaultValue="0"
  76          access="public"
  77          >
  78         Useful for keeping aspect ratio when rendering things like images.
  79   </Field>
  80   <Field
  81          name="aspectWidth"
  82          type="UInt16"
  83          cardinality="single"
  84          visibility="external"
  85          defaultValue="0"
  86          access="public"
  87          >
  88         Useful for keeping aspect ratio when rendering things like images.
  89   </Field>
  90   <Field
  91          name="scale"
  92          type="Real32"
  93          cardinality="single"
  94          visibility="external"
  95          defaultValue="1.0"
  96          access="public"
  97          >
  98         Scale factor for zooming.
  99   </Field>
 100   <Field
 101          name="tile"
 102          type="bool"
 103          cardinality="single"
 104          visibility="external"
 105          defaultValue="true"
 106          access="public"
 107          >
 108         If true the image tiles in multi window settings.
 109   </Field>
 110 </FieldContainer>