Merge pull request #134 from grahamboree/Comments

Better documentation for a few private fields in dtCrowdAgent
This commit is contained in:
Graham Pentheny 2015-12-16 23:41:59 -05:00
commit 5b2dce6a18

View File

@ -143,10 +143,10 @@ struct dtCrowdAgent
float desiredSpeed; float desiredSpeed;
float npos[3]; ///< The current agent position. [(x, y, z)] float npos[3]; ///< The current agent position. [(x, y, z)]
float disp[3]; float disp[3]; ///< A temporary value used to accumulate agent displacement during iterative collision resolution. [(x, y, z)]
float dvel[3]; ///< The desired velocity of the agent. [(x, y, z)] float dvel[3]; ///< The desired velocity of the agent. Based on the current path, calculated from scratch each frame. [(x, y, z)]
float nvel[3]; float nvel[3]; ///< The desired velocity adjusted by obstacle avoidance, calculated from scratch each frame. [(x, y, z)]
float vel[3]; ///< The actual velocity of the agent. [(x, y, z)] float vel[3]; ///< The actual velocity of the agent. The change from nvel -> vel is constrained by max acceleration. [(x, y, z)]
/// The agent's configuration parameters. /// The agent's configuration parameters.
dtCrowdAgentParams params; dtCrowdAgentParams params;
@ -447,4 +447,4 @@ This value is often based on the agent radius. E.g. radius * 30
A higher value will result in agents trying to stay farther away from each other at A higher value will result in agents trying to stay farther away from each other at
the cost of more difficult steering in tight spaces. the cost of more difficult steering in tight spaces.
*/ */