Source/System/Window/Base/OSGViewarea.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="Viewarea"
   5    parent="AttachmentContainer"
   6    library="System"
   7    pointerfieldtypes="both"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    childFields="multi"
  12    docGroupBase="GrpSystemWindow"
  13    >
  14
  15   A Viewport is a part of the Window it is attached to used for rendering. See
  16   \ref PageSystemWindowViewports for a description.
  17
  18   The size of the viewport is defined by the _sfLeft, _sfRight, _sfBottom and
  19   _sfTop Fields. The Window this Viewport is attached is stored in _sfWindow.
  20   _sfBackground defines the background clearing method, the
  21   _sfRoot and _sfCamera Fields the scene being rendered and the camera used to
  22   view it. The optional _mfForegrounds define which information are added or
  23   actions are executed after the Viewport has been rendered.
  24
  25   \ext
  26
  27   To create a new Viewport the draw and render methods should be overridden.
  28
  29   \endext
  30
  31   \dev
  32
  33   When adding fields to the Viewport, make sure to add the code to copy them to
  34   all the different ClusterWindows!
  35
  36   \enddev
  37   <Field
  38       name="left"
  39       type="Real32"
  40       cardinality="single"
  41       visibility="external"
  42       access="public"
  43       defaultValue="0.f"
  44       >
  45     The left edge of the viewport. Values between 0 and 1 are relative to the
  46     size of the Window, values &gt; 1 are absolute pixel coordinates.
  47     All other values are illegal.
  48   </Field>
  49   <Field
  50       name="right"
  51       type="Real32"
  52       cardinality="single"
  53       visibility="external"
  54       access="public"
  55       defaultValue="1.f"
  56       >
  57     The right edge of the viewport. Values between 0 and 1 are relative to the
  58     size of   the Window, values &gt; 1 are absolute pixel coordinates.
  59     All other values are illegal.
  60   </Field>
  61   <Field
  62       name="bottom"
  63       type="Real32"
  64       cardinality="single"
  65       visibility="external"
  66       access="public"
  67       defaultValue="0.f"
  68       >
  69     The bottom edge of the viewport. Values between 0 and 1 are relative to
  70     the size of the Window, values &gt; 1 are absolute pixel coordinates.
  71     All other values are illegal.
  72   </Field>
  73   <Field
  74       name="top"
  75       type="Real32"
  76       cardinality="single"
  77       visibility="external"
  78       access="public"
  79       defaultValue="1.f"
  80       >
  81     The top edge of the viewport. Values between 0 and 1 are relative to the
  82     size of the Window, values &gt; 1 are absolute pixel coordinates.
  83     All other values are illegal.
  84   </Field>
  85   <Field
  86       name="travMask"
  87       type="UInt32"
  88       cardinality="single"
  89       visibility="external"
  90       access="public"
  91       defaultHeader="OSGNode.h"
  92       defaultValue="TypeTraits&lt;UInt32&gt;::getMax() &amp; ~TraversalMasks::FindNamedComponentTraversal"
  93       >
  94     The foreground additions to the rendered image.
  95   </Field>
  96   <Field
  97       name="enabled"
  98       type="bool"
  99       cardinality="single"
 100       visibility="external"
 101       access="public"
 102       defaultValue="true"
 103       >
 104     Enabled is used to turn drawing on and off of a viewport.
 105   </Field>
 106   <Field
 107       name="drawTime"
 108       type="Real32"
 109       cardinality="single"
 110       visibility="internal"
 111       defaultValue="0.0f"
 112       access="public"
 113       >
 114     Drawtime of the last frame using this viewport.
 115   </Field>
 116   <Field
 117       name="drawableId"
 118       type="Int32"
 119       cardinality="single"
 120       visibility="internal"
 121       access="public"
 122       defaultValue="-1"
 123       >
 124     DrawableId to select viewport dependent elements (e.g. Distortion filter).
 125   </Field>
 126   <Field
 127       name="renderOptions"
 128       type="RenderOptionsPtr"
 129       cardinality="single"
 130       visibility="external"
 131       access="public"
 132       defaultValue="NULL"
 133       >
 134   </Field>
 135 </FieldContainer>