The terrain mesh is traversed and locations for planting geometry instances are computed. This can be configured via PlantOptions. The generation of geometry instance data is performed by the IPlanter object (see Planter). For each call to IPlanter.InstancePlant, the planter computes zero or one instance data tuples, which are then cached by the VertexBufferCache object (see InstanceCache).
The following vertex data semantics are used by this class:
required : Semantic.HeightmapCoords
required : Semantic.Normal
required : Semantic.Position
required : Semantic.Radius
required : Semantic.Version
optional : Semantic.Elevation
optional : Semantic.ElevationMinMax
optional : Semantic.Material
optional : Semantic.MaterialMask
optional : Semantic.MaterialRange
optional : Semantic.Texture
Creates a new instance of Planting.
Takes a snapshot of the given planting options and uses them for subsequent planting.
To plant geometry with the given options, call one of these methods:
To generate batches for the planted geometry, call IBatchRendererBase.ComputeBatches.
Plants geometry instances on the surface of the given terrain mesh sector, using the current settings.
The current IPlanter object is used (see Planter). The planting options are taken from the current PlantingOptions object (see PlantOptions). Instance data of planted geometry is written to the given buffer in, starting at its current position. Geometry instances are discarded silently if the buffer overflows at its current limit.
The mesh tree input filter to use for querying sector culling and marks.
The default value is
null (i.e. all mesh sectors are visited).