[This is preliminary documentation and is subject to change.]

Sets the sample distance to use when matching the detail mesh surface to the source geometry. (Height detail only.) [Limits: 0 or >= 0.9] [Units: World]

Namespace: org.critterai.nmgen
Assembly: cai-nmgen (in cai-nmgen.dll) Version: (


 C#  Visual Basic  Visual C++ 
public float DetailSampleDistance { get; set; }
Public Property DetailSampleDistance As Single
property float DetailSampleDistance {
	float get ();
	void set (float value);


This parameter is used in conjunction with DetailMaxDeviation to control how much extra height detail a PolyMeshDetail object will contain.

The sample distance is used to lay out sample points along the edges and across the surface of the source PolyMesh object's polygons. The height distance from the polygon edge/surface is tested. If the maximum deviation is exceeded, then the sample point is added as a vertex to the detail mesh.

The sample distance and deviation should be set as high as possible while still getting the desired height detail. Setting the sample distance to less than 0.9 will effectively disable sampling. Setting the maximum deviation to zero is not recommended since it will result in a large number of detail triangles.

Start with a sample distance of (longestXZAxis / 100), where 'longestXZAxis' is based on the bounds of the source geometry. Start with a maximum deviation of (YCellSize * 20).

See Also