Direction field

The direction field module creates a velocity field affecting the agent directions.

The field is uniformly distributed on the surface UVs. Use the "Direction field context tool" (Maya only) to paint the vectors direction. Each agent will look for samples inside the "maxDistance" radius to interpolate the final direction at every frame.

Attributes

Attributes	Type	Overridable	Description

Attributes	Type	Overridable	Description
mesh	mesh	no	Input mesh. Must have valid UVs, since the module generate samples using the UV coordinates.
meshParentMatrix	matrix	no	The mesh parent matrix.
meshTranslation	vector3	no	The mesh translation.
meshScale	vector3	no	The mesh scale.
meshRotation	vector3	no	The mesh rotation.
weight	double	yes	Weight.
tangentSamples	string	no	Serialized MapMetadata, Contains some UV samples with their direction.
debug	bool	no	Enables module debug drawing.
resolution	vector2	no	Number of row and column of the sample grid generated inside the UV space (from 0.0 to 1.0).
maxTurnAngle	double	no	The max turn angle.
debugVectorScale	double	no	Length of the direction vectors drawn by the module when the debug attribute is on.
isAnimated	bool	no	If the input mesh is deformed over the time.
useHeightField	bool	no	Use an Height field instead of the input mesh .
heightField	string	no	Height field name.
influences	int	no	Max number of neighbour samples used by each agent to compute the final direction.
maxDistance	double	no	Max search distance
ignoreNextDirectionalModules	bool	yes	If enabled, all next directional modules in the stack will be ignored.
editLocomotionAngularVelocity	bool	yes	If on, this module will edit the targetAngularVelocity metadata used by the locomotion system.