From b9804c52102405fc0461db5f50f773a28beb8f37 Mon Sep 17 00:00:00 2001 From: Graham Pentheny Date: Wed, 16 Dec 2015 12:17:49 -0500 Subject: [PATCH] Better documentation for a few private fields in dtCrowdAgent as discussed in PR #110 --- DetourCrowd/Include/DetourCrowd.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/DetourCrowd/Include/DetourCrowd.h b/DetourCrowd/Include/DetourCrowd.h index b3ec3e1..2d786f3 100644 --- a/DetourCrowd/Include/DetourCrowd.h +++ b/DetourCrowd/Include/DetourCrowd.h @@ -143,10 +143,10 @@ struct dtCrowdAgent float desiredSpeed; float npos[3]; ///< The current agent position. [(x, y, z)] - float disp[3]; - float dvel[3]; ///< The desired velocity of the agent. [(x, y, z)] - float nvel[3]; - float vel[3]; ///< The actual velocity of the agent. [(x, y, z)] + 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. Based on the current path, calculated from scratch each frame. [(x, y, z)] + 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. The change from nvel -> vel is constrained by max acceleration. [(x, y, z)] /// The agent's configuration parameters. 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 the cost of more difficult steering in tight spaces. -*/ \ No newline at end of file +*/