DotRecastNetSim/src/DotRecast.Detour/NavMeshDataCreateParams.cs

/*
Copyright (c) 2009-2010 Mikko Mononen memon@inside.org
recast4j copyright (c) 2015-2019 Piotr Piastucki piotr@jtilia.org
DotRecast Copyright (c) 2023 Choi Ikpil ikpil@naver.com

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
 claim that you wrote the original software. If you use this software
 in a product, an acknowledgment in the product documentation would be
 appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
 misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/

namespace DotRecast.Detour
{
    /// Represents the source data used to build an navigation mesh tile.
    public class NavMeshDataCreateParams
    {
        /// @name Polygon Mesh Attributes
        /// Used to create the base navigation graph.
        /// See #rcPolyMesh for details related to these attributes.
        /// @{
        public int[] verts;

        /// < The polygon mesh vertices. [(x, y, z) * #vertCount] [Unit: vx]
        public int vertCount;

        /// < The number vertices in the polygon mesh. [Limit: >= 3]
        public int[] polys;

        /// < The polygon data. [Size: #polyCount * 2 * #nvp]
        public int[] polyFlags;

        /// < The user defined flags assigned to each polygon. [Size: #polyCount]
        public int[] polyAreas;

        /// < The user defined area ids assigned to each polygon. [Size: #polyCount]
        public int polyCount;

        /// < Number of polygons in the mesh. [Limit: >= 1]
        public int nvp;

        /// < Number maximum number of vertices per polygon. [Limit: >= 3]
        /// @}
        /// @name Height Detail Attributes (Optional)
        /// See #rcPolyMeshDetail for details related to these attributes.
        /// @{
        public int[] detailMeshes;

        /// < The height detail sub-mesh data. [Size: 4 * #polyCount]
        public float[] detailVerts;

        /// < The detail mesh vertices. [Size: 3 * #detailVertsCount] [Unit: wu]
        public int detailVertsCount;

        /// < The number of vertices in the detail mesh.
        public int[] detailTris;

        /// < The detail mesh triangles. [Size: 4 * #detailTriCount]
        public int detailTriCount;

        /// < The number of triangles in the detail mesh.
        /// @}
        /// @name Off-Mesh Connections Attributes (Optional)
        /// Used to define a custom point-to-point edge within the navigation graph, an
        /// off-mesh connection is a user defined traversable connection made up to two vertices,
        /// at least one of which resides within a navigation mesh polygon.
        /// @{
        /// Off-mesh connection vertices. [(ax, ay, az, bx, by, bz) * #offMeshConCount] [Unit: wu]
        public float[] offMeshConVerts;

        /// Off-mesh connection radii. [Size: #offMeshConCount] [Unit: wu]
        public float[] offMeshConRad;

        /// User defined flags assigned to the off-mesh connections. [Size: #offMeshConCount]
        public int[] offMeshConFlags;

        /// User defined area ids assigned to the off-mesh connections. [Size: #offMeshConCount]
        public int[] offMeshConAreas;

        /// The permitted travel direction of the off-mesh connections. [Size: #offMeshConCount]
        ///
        /// 0 = Travel only from endpoint A to endpoint B.<br/>
        /// #DT_OFFMESH_CON_BIDIR = Bidirectional travel.
        public int[] offMeshConDir;

        /// The user defined ids of the off-mesh connection. [Size: #offMeshConCount]
        public int[] offMeshConUserID;

        /// The number of off-mesh connections. [Limit: >= 0]
        public int offMeshConCount;

        /// @}
        /// @name Tile Attributes
        /// @note The tile grid/layer data can be left at zero if the destination is a single tile mesh.
        /// @{
        public int userId;

        /// < The user defined id of the tile.
        public int tileX;

        /// < The tile's x-grid location within the multi-tile destination mesh. (Along the x-axis.)
        public int tileZ;

        /// < The tile's y-grid location within the multi-tile desitation mesh. (Along the z-axis.)
        public int tileLayer;

        /// < The tile's layer within the layered destination mesh. [Limit: >= 0] (Along the y-axis.)
        public float[] bmin;

        /// < The minimum bounds of the tile. [(x, y, z)] [Unit: wu]
        public float[] bmax;

        /// < The maximum bounds of the tile. [(x, y, z)] [Unit: wu]
        /// @}
        /// @name General Configuration Attributes
        /// @{
        public float walkableHeight;

        /// < The agent height. [Unit: wu]
        public float walkableRadius;

        /// < The agent radius. [Unit: wu]
        public float walkableClimb;

        /// < The agent maximum traversable ledge. (Up/Down) [Unit: wu]
        public float cs;

        /// < The xz-plane cell size of the polygon mesh. [Limit: > 0] [Unit: wu]
        public float ch;

        /// < The y-axis cell height of the polygon mesh. [Limit: > 0] [Unit: wu]
        /// True if a bounding volume tree should be built for the tile.
        /// @note The BVTree is not normally needed for layered navigation meshes.
        public bool buildBvTree;

        /// @}
    }
}