forked from mirror/DotRecast
update comment
This commit is contained in:
parent
7664ae9f3d
commit
e6f515f08a
|
@ -1055,7 +1055,6 @@ namespace DotRecast.Detour
|
||||||
/// -# Call updateSlicedFindPath() until it returns complete.
|
/// -# Call updateSlicedFindPath() until it returns complete.
|
||||||
/// -# Call finalizeSlicedFindPath() to get the path.
|
/// -# Call finalizeSlicedFindPath() to get the path.
|
||||||
///@{
|
///@{
|
||||||
|
|
||||||
/// Initializes a sliced path query.
|
/// Initializes a sliced path query.
|
||||||
/// @param[in] startRef The reference id of the start polygon.
|
/// @param[in] startRef The reference id of the start polygon.
|
||||||
/// @param[in] endRef The reference id of the end polygon.
|
/// @param[in] endRef The reference id of the end polygon.
|
||||||
|
@ -2256,16 +2255,16 @@ namespace DotRecast.Detour
|
||||||
///
|
///
|
||||||
/// This method is meant to be used for quick, short distance checks.
|
/// This method is meant to be used for quick, short distance checks.
|
||||||
///
|
///
|
||||||
/// If the path array is too small to hold the result, it will be filled as
|
/// If the path array is too small to hold the result, it will be filled as
|
||||||
/// far as possible from the start postion toward the end position.
|
/// far as possible from the start postion toward the end position.
|
||||||
///
|
///
|
||||||
/// <b>Using the Hit Parameter t of RaycastHit</b>
|
/// <b>Using the Hit Parameter t of RaycastHit</b>
|
||||||
///
|
///
|
||||||
/// If the hit parameter is a very high value (FLT_MAX), then the ray has hit
|
/// If the hit parameter is a very high value (FLT_MAX), then the ray has hit
|
||||||
/// the end position. In this case the path represents a valid corridor to the
|
/// the end position. In this case the path represents a valid corridor to the
|
||||||
/// end position and the value of @p hitNormal is undefined.
|
/// end position and the value of @p hitNormal is undefined.
|
||||||
///
|
///
|
||||||
/// If the hit parameter is zero, then the start position is on the wall that
|
/// If the hit parameter is zero, then the start position is on the wall that
|
||||||
/// was hit and the value of @p hitNormal is undefined.
|
/// was hit and the value of @p hitNormal is undefined.
|
||||||
///
|
///
|
||||||
/// If 0 < t < 1.0 then the following applies:
|
/// If 0 < t < 1.0 then the following applies:
|
||||||
|
@ -2277,32 +2276,29 @@ namespace DotRecast.Detour
|
||||||
///
|
///
|
||||||
/// <b>Use Case Restriction</b>
|
/// <b>Use Case Restriction</b>
|
||||||
///
|
///
|
||||||
/// The raycast ignores the y-value of the end position. (2D check.) This
|
/// The raycast ignores the y-value of the end position. (2D check.) This
|
||||||
/// places significant limits on how it can be used. For example:
|
/// places significant limits on how it can be used. For example:
|
||||||
///
|
///
|
||||||
/// Consider a scene where there is a main floor with a second floor balcony
|
/// Consider a scene where there is a main floor with a second floor balcony
|
||||||
/// that hangs over the main floor. So the first floor mesh extends below the
|
/// that hangs over the main floor. So the first floor mesh extends below the
|
||||||
/// balcony mesh. The start position is somewhere on the first floor. The end
|
/// balcony mesh. The start position is somewhere on the first floor. The end
|
||||||
/// position is on the balcony.
|
/// position is on the balcony.
|
||||||
///
|
///
|
||||||
/// The raycast will search toward the end position along the first floor mesh.
|
/// The raycast will search toward the end position along the first floor mesh.
|
||||||
/// If it reaches the end position's xz-coordinates it will indicate FLT_MAX
|
/// If it reaches the end position's xz-coordinates it will indicate FLT_MAX
|
||||||
/// (no wall hit), meaning it reached the end position. This is one example of why
|
/// (no wall hit), meaning it reached the end position. This is one example of why
|
||||||
/// this method is meant for short distance checks.
|
/// this method is meant for short distance checks.
|
||||||
///
|
///
|
||||||
/// Casts a 'walkability' ray along the surface of the navigation mesh from
|
/// Casts a 'walkability' ray along the surface of the navigation mesh from
|
||||||
/// the start position toward the end position.
|
/// the start position toward the end position.
|
||||||
/// @note A wrapper around Raycast(..., RaycastHit*). Retained for backward compatibility.
|
/// @param[in] startRef The reference id of the start polygon.
|
||||||
/// @param[in] startRef The reference id of the start polygon.
|
/// @param[in] startPos A position within the start polygon representing
|
||||||
/// @param[in] startPos A position within the start polygon representing
|
/// the start of the ray. [(x, y, z)]
|
||||||
/// the start of the ray. [(x, y, z)]
|
/// @param[in] endPos The position to cast the ray toward. [(x, y, z)]
|
||||||
/// @param[in] endPos The position to cast the ray toward. [(x, y, z)]
|
/// @param[in] filter The polygon filter to apply to the query.
|
||||||
/// @param[out] t The hit parameter. (FLT_MAX if no wall hit.)
|
/// @param[in] options govern how the raycast behaves. See dtRaycastOptions
|
||||||
/// @param[out] hitNormal The normal of the nearest wall hit. [(x, y, z)]
|
/// @param[out] hit Pointer to a raycast hit structure which will be filled by the results.
|
||||||
/// @param[in] filter The polygon filter to apply to the query.
|
/// @param[in] prevRef parent of start ref. Used during for cost calculation [opt]
|
||||||
/// @param[out] path The reference ids of the visited polygons. [opt]
|
|
||||||
/// @param[out] pathCount The number of visited polygons. [opt]
|
|
||||||
/// @param[in] maxPath The maximum number of polygons the @p path array can hold.
|
|
||||||
/// @returns The status flags for the query.
|
/// @returns The status flags for the query.
|
||||||
public DtStatus Raycast(long startRef, RcVec3f startPos, RcVec3f endPos,
|
public DtStatus Raycast(long startRef, RcVec3f startPos, RcVec3f endPos,
|
||||||
IDtQueryFilter filter, int options,
|
IDtQueryFilter filter, int options,
|
||||||
|
|
Loading…
Reference in New Issue