Source/System/Window/Base/OSGViewport.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="Viewport"
   5    parent="Viewarea"
   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
  38   <Field
  39       name="parent"
  40       type="FieldContainer"
  41       cardinality="single"
  42       visibility="external"
  43       access="none"
  44       category="parentpointer"
  45        >
  46     The Window this viewport is contained in.
  47   </Field>
  48   <Field
  49       name="camera"
  50       type="CameraPtr"
  51       cardinality="single"
  52       visibility="external"
  53       access="public"
  54       >
  55     The Camera used to render the viewport.
  56   </Field>
  57   <Field
  58       name="root"
  59       type="NodePtr"
  60       cardinality="single"
  61       visibility="external"
  62       access="public"
  63       >
  64     The root of the tree that is displayed in this viewport.
  65   </Field>
  66   <Field
  67       name="background"
  68       type="BackgroundPtr"
  69       cardinality="single"
  70       visibility="external"
  71       access="public"
  72       >
  73     The background used to clear this viewport.
  74   </Field>
  75   <Field
  76       name="foregrounds"
  77       type="ForegroundPtr"
  78       cardinality="multi"
  79       visibility="external"
  80       access="public"
  81       pushToFieldAs="addForeground"
  82       >
  83     The foreground additions to the rendered image.
  84   </Field>
  85 </FieldContainer>