Source/System/Window/Foreground/OSGSimpleTextForeground.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4     name="SimpleTextForeground"
   5     parent="Foreground"
   6     library="Window"
   7     pointerfieldtypes="both"
   8     structure="concrete"
   9     systemcomponent="true"
  10     parentsystemcomponent="true"
  11     decoratable="false"
  12     docGroupBase="GrpUtil"
  13     authors="David Kabala (djkabala@gmail.com)"
  14     >
  15     OSG::SimpleTextForeground displays a simple list of text
  16     lines. They are displayed using a compiled-in font that can use an arbitrary
  17     color and that can be arbitrarily resized, with the size per line given in
  18     pixel.
  19
  20     The size and color used for all lines in _sfSize and _sfColor.
  21
  22     The color of the text can be overriden by using a special tag in the text
  23     of the lines.  \{\color=FF0000FF SomeText} will draw the SomeText with a
  24     red color.
  25     <Field
  26         name="Lines"
  27         type="std::string"
  28         cardinality="multi"
  29         visibility="external"
  30         access="public"
  31         >
  32         The lines of text.
  33     </Field>
  34     <Field
  35         name="Size"
  36         type="Real32"
  37         cardinality="single"
  38         visibility="external"
  39         defaultValue="16"
  40         access="public"
  41         >
  42         Height of a single line, in  pixel.
  43     </Field>
  44     <Field
  45         name="Color"
  46         type="Color4f"
  47         cardinality="single"
  48         visibility="external"
  49         defaultValue="1,1,1,1"
  50         access="public"
  51         >
  52         Color of the text.
  53     </Field>
  54     <Field
  55         name="ShadowColor"
  56         type="Color4f"
  57         cardinality="single"
  58         visibility="external"
  59         defaultValue="0,0,0,1"
  60         access="public"
  61         >
  62         Color of the shadow.
  63     </Field>
  64     <Field
  65         name="BgColor"
  66         type="Color4f"
  67         cardinality="single"
  68         visibility="external"
  69         defaultValue="0,0,0,0"
  70         access="public"
  71         >
  72         Color of the background.
  73     </Field>
  74     <Field
  75         name="Family"
  76         type="std::string"
  77         cardinality="single"
  78         visibility="external"
  79         access="public"
  80         >
  81         The font family to be used, e.g. "SANS", default if unset.
  82     </Field>
  83     <Field
  84         name="ShadowOffset"
  85         type="Vec2f"
  86         cardinality="single"
  87         visibility="external"
  88         defaultValue="1,-1"
  89         access="public"
  90         >
  91         Offset of the shadow, in pixels.
  92     </Field>
  93     <Field
  94         name="HorizontalAlign"
  95         type="UInt8"
  96         cardinality="single"
  97         visibility="external"
  98         defaultValue="SimpleTextForeground::Left"
  99         access="public"
 100         >
 101         Simple form of layout management, defaults to SimpleTextForeground::Left.
 102     </Field>
 103     <Field
 104         name="VerticalAlign"
 105         type="UInt8"
 106         cardinality="single"
 107         visibility="external"
 108         defaultValue="SimpleTextForeground::Top"
 109         access="public"
 110         >
 111         Simple form of layout management, defaults to SimpleTextForeground::Top.
 112     </Field>
 113     <Field
 114         name="BorderColor"
 115         type="Color4f"
 116         cardinality="single"
 117         visibility="external"
 118         defaultValue="0,0,0,0"
 119         access="public"
 120         >
 121         Color of the border.
 122     </Field>
 123     <Field
 124         name="BorderOffset"
 125         type="Vec2f"
 126         cardinality="single"
 127         visibility="external"
 128         defaultValue="4,4"
 129         access="public"
 130         >
 131         Offset of the border in pixels.
 132     </Field>
 133     <Field
 134         name="TextMargin"
 135         type="Vec2f"
 136         cardinality="single"
 137         visibility="external"
 138         defaultValue="0,0"
 139         access="public"
 140         >
 141         Text margin in pixels.
 142     </Field>
 143     <Field
 144         name="Tile"
 145         type="bool"
 146         category="data"
 147         cardinality="single"
 148         visibility="external"
 149         defaultValue="false"
 150         access="public"
 151         >
 152         Should this foreground be tilable
 153     </Field>
 154 </FieldContainer>