reposition DtCrwdAgent class comment

This commit is contained in:
ikpil 2024-02-14 01:48:33 +09:00
parent aae0884f5a
commit bd4825dcd5
2 changed files with 16 additions and 43 deletions

View File

@ -33,8 +33,7 @@ namespace DotRecast.Detour.Crowd
/// The type of mesh polygon the agent is traversing. (See: #CrowdAgentState) /// The type of mesh polygon the agent is traversing. (See: #CrowdAgentState)
public DtCrowdAgentState state; public DtCrowdAgentState state;
/// True if the agent has valid path (targetState == DT_CROWDAGENT_TARGET_VALID) and the path does not lead to the /// True if the agent has valid path (targetState == DT_CROWDAGENT_TARGET_VALID) and the path does not lead to the requested position, else false.
/// requested position, else false.
public bool partial; public bool partial;
/// The path corridor the agent is using. /// The path corridor the agent is using.
@ -52,51 +51,24 @@ namespace DotRecast.Detour.Crowd
/// The desired speed. /// The desired speed.
public float desiredSpeed; public float desiredSpeed;
public RcVec3f npos = new RcVec3f(); public RcVec3f npos = new RcVec3f(); // < The current agent position. [(x, y, z)]
public RcVec3f disp = new RcVec3f(); // < A temporary value used to accumulate agent displacement during iterative collision resolution. [(x, y, z)]
public RcVec3f dvel = new RcVec3f(); // < The desired velocity of the agent. Based on the current path, calculated from scratch each frame. [(x, y, z)]
public RcVec3f nvel = new RcVec3f(); // < The desired velocity adjusted by obstacle avoidance, calculated from scratch each frame. [(x, y, z)]
public RcVec3f vel = new RcVec3f(); // < The actual velocity of the agent. The change from nvel -> vel is constrained by max acceleration. [(x, y, z)]
/// < The current agent position. [(x, y, z)]
public RcVec3f disp = new RcVec3f();
/// < A temporary value used to accumulate agent displacement during iterative
/// collision resolution. [(x, y, z)]
public RcVec3f dvel = new RcVec3f();
/// < The desired velocity of the agent. Based on the current path, calculated
/// from
/// scratch each frame. [(x, y, z)]
public RcVec3f nvel = new RcVec3f();
/// < The desired velocity adjusted by obstacle avoidance, calculated from scratch each
/// frame. [(x, y, z)]
public RcVec3f vel = new RcVec3f();
/// < 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.
public DtCrowdAgentParams option; public DtCrowdAgentParams option;
/// The local path corridor corners for the agent. /// The local path corridor corners for the agent.
public List<DtStraightPath> corners = new List<DtStraightPath>(); public List<DtStraightPath> corners = new List<DtStraightPath>();
public DtMoveRequestState targetState; public DtMoveRequestState targetState; // < State of the movement request.
public long targetRef; // < Target polyref of the movement request.
/// < State of the movement request. public RcVec3f targetPos = new RcVec3f(); // < Target position of the movement request (or velocity in case of DT_CROWDAGENT_TARGET_VELOCITY).
public long targetRef; public DtPathQueryResult targetPathQueryResult; // < Path finder query
public bool targetReplan; // < Flag indicating that the current path is being replanned.
/// < Target polyref of the movement request. public float targetReplanTime; // <Time since the agent's target was replanned.
public RcVec3f targetPos = new RcVec3f();
/// < Target position of the movement request (or velocity in case of
/// DT_CROWDAGENT_TARGET_VELOCITY).
public DtPathQueryResult targetPathQueryResult;
/// < Path finder query
public bool targetReplan;
/// < Flag indicating that the current path is being replanned.
public float targetReplanTime;
/// <Time since the agent's target was replanned.
public float targetReplanWaitTime; public float targetReplanWaitTime;
public DtCrowdAgentAnimation animation; public DtCrowdAgentAnimation animation;

View File

@ -30,8 +30,8 @@ namespace DotRecast.Detour.Crowd
/// @ingroup crowd, detour /// @ingroup crowd, detour
public class DtPathCorridor public class DtPathCorridor
{ {
private RcVec3f m_pos = new RcVec3f(); private RcVec3f m_pos;
private RcVec3f m_target = new RcVec3f(); private RcVec3f m_target;
private List<long> m_path; private List<long> m_path;
/** /**
@ -85,9 +85,10 @@ namespace DotRecast.Detour.Crowd
/// Allocates the corridor's path buffer. /// Allocates the corridor's path buffer.
/// @param[in] maxPath The maximum path size the corridor can handle. /// @param[in] maxPath The maximum path size the corridor can handle.
/// @return True if the initialization succeeded. /// @return True if the initialization succeeded.
public void Init(int maxPath) public bool Init(int maxPath)
{ {
// ... // ...
return true;
} }
/// @par /// @par