Source/System/NodeCores/Drawables/Particles/OSGParticles.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="Particles"
   5    parent="MaterialDrawable"
   6    library="Drawable"
   7    pointerfieldtypes="both"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    docGroupBase="GrpDrawablesParticles"
  12
  13    >
  14   See \ref PageSystemParticles for details.
  15   <Field
  16          name="mode"
  17          type="UInt32"
  18          cardinality="single"
  19          visibility="external"
  20          defaultValue="2"
  21          access="public"
  22          >
  23         The particle mode, see OSG::Particles::modeE for options.
  24   </Field>
  25   <Field
  26          name="positions"
  27          type="GeoVectorProperty"
  28          cardinality="single"
  29          visibility="external"
  30          access="public"
  31      category="childpointer"
  32      childParentType="FieldContainer"
  33      linkParentField="Parents"
  34          >
  35     The positions of the particles. This is the primary defining
  36     information for a particle.
  37   </Field>
  38   <Field
  39          name="sizes"
  40          type="Vec3f"
  41          cardinality="multi"
  42          visibility="external"
  43          access="public"
  44          >
  45     The particle sizes. If not set (1,1,1) will be used, if only one entry
  46     is set, it will be used for all particles. If the number of sizes if
  47     equal to the number of positions every particle will get its own size.
  48     Most modes only use the X coordinate of the vector. Particles with
  49     size[0] == 0 are ignored.
  50   </Field>
  51   <Field
  52          name="secPositions"
  53          type="GeoVectorProperty"
  54          cardinality="single"
  55          visibility="external"
  56          access="public"
  57      category="childpointer"
  58      childParentType="FieldContainer"
  59      linkParentField="Parents"
  60          >
  61     The secondary position of the particle. This information is only used
  62     by a few rendering modes, e.g. the streak mode. Usually it represents
  63     the particle's last position.
  64   </Field>
  65   <Field
  66          name="colors"
  67          type="GeoVectorProperty"
  68          cardinality="single"
  69          visibility="external"
  70          access="public"
  71      category="childpointer"
  72      childParentType="FieldContainer"
  73      linkParentField="Parents"
  74          >
  75         The particle colors (optional).
  76   </Field>
  77   <Field
  78          name="normals"
  79          type="GeoVectorProperty"
  80          cardinality="single"
  81          visibility="external"
  82          access="public"
  83      category="childpointer"
  84      childParentType="FieldContainer"
  85      linkParentField="Parents"
  86          >
  87     Most particles will be automatically aligned to the view
  88     direction. If normals are set they will be used to define the
  89     direction the particles are facing.
  90   </Field>
  91   <Field
  92          name="indices"
  93          type="Int32"
  94          cardinality="multi"
  95          visibility="external"
  96          access="public"
  97          >
  98     Indices for the particles. Useful to select subsets of all particles for
  99     rendering.
 100   </Field>
 101   <Field
 102          name="textureZs"
 103          type="Real32"
 104          cardinality="multi"
 105          visibility="external"
 106          access="public"
 107          >
 108     The texture z coordinate of the particles. Useful in conjunction with 3D
 109     textures to use different texture images on different particles.
 110   </Field>
 111   <Field
 112          name="drawOrder"
 113          type="UInt32"
 114          cardinality="single"
 115          visibility="external"
 116          defaultValue="0"
 117          access="public"
 118          >
 119     Define an optional sorting on the particles, see OSG::Particles::DrawOrderE
 120     for variants. Default is unordered.
 121   </Field>
 122   <Field
 123          name="dynamic"
 124          type="bool"
 125          cardinality="single"
 126          visibility="external"
 127          defaultValue="true"
 128          access="public"
 129          >
 130     Hint to tell the system whether particles are expected to change position or
 131     not. Is used to speed up sorting.
 132   </Field>
 133   <Field
 134          name="pump"
 135          type="UInt32"
 136          cardinality="single"
 137          visibility="internal"
 138          access="protected"
 139          >
 140   </Field>
 141   <Field
 142          name="bsp"
 143          type="ParticleBSPTree"
 144          cardinality="single"
 145          visibility="external"
 146          typeHeader="OSGParticleBSP.h"
 147      fieldHeader="OSGParticleBSP.h"
 148          access="public"
 149          >
 150   </Field>
 151   <Field
 152          name="numParticles"
 153          type="Int32"
 154          cardinality="single"
 155          visibility="external"
 156          access="public"
 157      defaultValue="-1"
 158          >
 159     Optional number of particles to use. If set to -1, all the particles in
 160     pos, or indices if set, will be used.
 161   </Field>
 162 </FieldContainer>