Source/System/Window/Base/OSGWindow.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4     name="Window"
   5     parent="HardwareContext"
   6     library="System"
   7     pointerfieldtypes="both"
   8     structure="abstract"
   9     systemcomponent="true"
  10     parentsystemcomponent="true"
  11     docGroupBase="GrpSystemWindow"
  12     >
  13
  14     Window is the base class for all window management classes.  See \ref
  15     PageSystemWindowWindow for a description.
  16
  17     \ext
  18
  19     To create a new Window the methods that have to be overridden are
  20     init(void), activate(void), deactivate(void) and swap(void).
  21
  22     \endext
  23     <Field
  24         name="width"
  25         type="UInt16"
  26         cardinality="single"
  27         visibility="external"
  28         access="public"
  29     >
  30     </Field>
  31     <Field
  32         name="height"
  33         type="UInt16"
  34         cardinality="single"
  35         visibility="external"
  36         access="public"
  37     >
  38     </Field>
  39     <Field
  40         name="port"
  41         type="Viewport"
  42         cardinality="multi"
  43         category="childpointer"
  44         childParentType="FieldContainer"
  45         visibility="external"
  46         access="public"
  47         pushToFieldAs="addPort"
  48         insertIntoMFieldAs="insertPort"
  49         replaceInMFieldIndexAs="replacePort"
  50         replaceInMFieldObjectAs="replacePortByObj"
  51         removeFromMFieldIndexAs="subPort"
  52         removeFromMFieldObjectAs="subPortByObj"
  53         clearFieldAs="clearPorts"
  54         ptrFieldAccess = "nullCheck"
  55         linkParentField="Parent"
  56     >
  57     </Field>
  58     <Field
  59         name="glObjectEventCounter"
  60         type="UInt32"
  61         cardinality="single"
  62         visibility="internal"
  63         defaultValue="1"
  64         access="protected"
  65         fieldFlags="FClusterLocal, FThreadLocal"
  66     >
  67     Counter for GL object events. Needed for multi-aspect updates.
  68         Is used in glObjectLastRefresh and glObjectLastReinitialize.
  69     </Field>
  70     <Field
  71         name="glObjectLastRefresh"
  72         type="UInt32"
  73         cardinality="multi"
  74         visibility="internal"
  75         access="protected"
  76         fieldFlags="FClusterLocal, FThreadLocal"
  77     >
  78     Indicates the last refresh for the GL object.
  79     </Field>
  80     <Field
  81         name="glObjectLastReinitialize"
  82         type="UInt32"
  83         cardinality="multi"
  84         visibility="internal"
  85         access="protected"
  86         fieldFlags="FClusterLocal, FThreadLocal"
  87     >
  88     Indicates the last reinit for the GL object.
  89     </Field>
  90     <Field
  91         name="drawerId"
  92         type="Int32"
  93         cardinality="single"
  94         visibility="internal"
  95         access="public"
  96         fieldFlags="FClusterLocal"
  97         defaultValue="-1"
  98     >
  99         DrawerId to select window dependent elements (e.g. Distortion filter).
 100         For cluster window this values equals the clusterId (shl chunk)
 101     </Field>
 102     <Field
 103         name="requestMajor"
 104         type="Int32"
 105         cardinality="single"
 106         visibility="internal"
 107         access="public"
 108         fieldFlags=""
 109         defaultValue="-1"
 110     >
 111     </Field>
 112     <Field
 113         name="requestMinor"
 114         type="Int32"
 115         cardinality="single"
 116         visibility="internal"
 117         access="public"
 118         fieldFlags=""
 119         defaultValue="0"
 120     >
 121     </Field>
 122     <Field
 123         name="contextFlags"
 124         type="Int32"
 125         cardinality="single"
 126         visibility="internal"
 127         access="public"
 128         fieldFlags=""
 129         defaultValue="0"
 130     >
 131     </Field>
 132     <Field
 133         name="renderOptions"
 134         type="RenderOptionsPtr"
 135         cardinality="single"
 136         visibility="external"
 137         access="public"
 138         defaultValue="NULL"
 139         >
 140     </Field>
 141     <Field
 142         name="ignoreAllExtensions"
 143         type="bool"
 144         cardinality="single"
 145         visibility="internal"
 146         access="public"
 147         defaultValue="false"
 148     >
 149     </Field>
 150     <Field
 151         name="drawMode"
 152         type="UInt32"
 153         cardinality="single"
 154         visibility="internal"
 155         access="public"
 156         defaultValue="(Window::SequentialPartitionDraw | Window::StdDrawer | Window::ActiveContext)"
 157         >
 158     </Field>
 159     <Field
 160         name="rendererInfo"
 161         type="std::string"
 162         cardinality="single"
 163         visibility="internal"
 164         access="public"
 165         defaultValue='"unknown"'
 166         >
 167     </Field>
 168     <Field
 169         name="drawTasks"
 170         type="DrawTask"
 171         cardinality="multi"
 172         visibility="internal"
 173         access="protected"
 174         category="custompointer"
 175         ptrFieldAccess="custom"
 176         fieldHeader="OSGDrawTask.h"
 177         typeHeader="OSGDrawTask.h"
 178         fieldFlags="FCustomAccess, FClusterLocal"
 179         >
 180     </Field>
 181
 182 </FieldContainer>