using UnityEngine;
using System.Collections.Generic;
using UnityEngine.Profiling;
using Unity.Jobs;
using Unity.Mathematics;
namespace Pathfinding {
using Pathfinding.Serialization;
using Pathfinding.Graphs.Navmesh;
using Pathfinding.Util;
using Pathfinding.Jobs;
using Pathfinding.Sync;
using Pathfinding.Pooling;
using Pathfinding.Graphs.Navmesh.Jobs;
using Pathfinding.Collections;
///
/// Automatically generates navmesh graphs based on world geometry.
///
/// [Open online documentation to see images]
///
/// The recast graph is based on Recast (http://code.google.com/p/recastnavigation/).
/// I have translated a good portion of it to C# to run it natively in Unity.
///
/// For a tutorial on how to configure a recast graph, take a look at create-recast (view in online documentation for working links).
///
/// \section recastinspector Inspector
///
/// [Open online documentation to see images]
///
/// Shape
/// \inspectorField{Dimensions, dimensionMode}
/// \inspectorField{Center, forcedBoundsCenter}
/// \inspectorField{Size, forcedBoundsSize}
/// \inspectorField{Rotation, rotation}
/// \inspectorField{Snap bounds to scene, SnapForceBoundsToScene}
///
/// Input Filtering
/// \inspectorField{Filter Objects By, collectionSettings.collectionMode}
/// \inspectorField{Layer Mask, collectionSettings.layerMask}
/// \inspectorField{Tag Mask, collectionSettings.tagMask}
/// \inspectorField{Rasterize Terrains, collectionSettings.rasterizeTerrain}
/// \inspectorField{Rasterize Trees, collectionSettings.rasterizeTrees}
/// \inspectorField{Heightmap Downsampling, collectionSettings.terrainHeightmapDownsamplingFactor}
/// \inspectorField{Rasterize Meshes, collectionSettings.rasterizeMeshes}
/// \inspectorField{Rasterize Colliders, collectionSettings.rasterizeColliders}
///
/// Agent Characteristics
/// \inspectorField{Character Radius, characterRadius}
/// \inspectorField{Character Height, walkableHeight}
/// \inspectorField{Max Step Height, walkableClimb}
/// \inspectorField{Max Slope, maxSlope}
/// \inspectorField{Per Layer Modifications, perLayerModifications}
///
/// Rasterization
/// \inspectorField{Voxel Size, cellSize}
/// \inspectorField{Use Tiles, useTiles}
/// \inspectorField{Tile Size, editorTileSize}
/// \inspectorField{Max Border Edge Length, maxEdgeLength}
/// \inspectorField{Edge Simplification, contourMaxError}
/// \inspectorField{Min Region Size, minRegionSize}
/// \inspectorField{Round Collider Detail, collectionSettings.colliderRasterizeDetail}
///
/// Runtime Settings
/// \inspectorField{Affected By Navmesh Cuts, enableNavmeshCutting}
///
/// Advanced
/// \inspectorField{Relevant Graph Surface Mode, relevantGraphSurfaceMode}
/// \inspectorField{Initial Penalty, initialPenalty}
///
/// \section howitworks How a recast graph works
/// When generating a recast graph what happens is that the world is voxelized.
/// You can think of this as constructing an approximation of the world out of lots of boxes.
/// If you have played Minecraft it looks very similar (but with smaller boxes).
/// [Open online documentation to see images]
///
/// The Recast process is described as follows:
/// - The voxel mold is build from the input triangle mesh by rasterizing the triangles into a multi-layer heightfield.
/// Some simple filters are then applied to the mold to prune out locations where the character would not be able to move.
/// - The walkable areas described by the mold are divided into simple overlayed 2D regions.
/// The resulting regions have only one non-overlapping contour, which simplifies the final step of the process tremendously.
/// - The navigation polygons are peeled off from the regions by first tracing the boundaries and then simplifying them.
/// The resulting polygons are finally converted to triangles which makes them perfect for pathfinding and spatial reasoning about the level.
///
/// The recast generation process usually works directly on the visiable geometry in the world. This is usually a good thing, because world geometry is usually more detailed than the colliders.
/// You can, however, specify that colliders should be rasterized instead. If you have very detailed world geometry, this can speed up scanning and updating the graph.
///
/// \section export Exporting for manual editing
/// In the editor there is a button for exporting the generated graph to a .obj file.
/// Usually the generation process is good enough for the game directly, but in some cases you might want to edit some minor details.
/// So you can export the graph to a .obj file, open it in your favourite 3D application, edit it, and export it to a mesh which Unity can import.
/// You can then use that mesh in a navmesh graph.
///
/// Since many 3D modelling programs use different axis systems (unity uses X=right, Y=up, Z=forward), it can be a bit tricky to get the rotation and scaling right.
/// For blender for example, what you have to do is to first import the mesh using the .obj importer. Don't change anything related to axes in the settings.
/// Then select the mesh, open the transform tab (usually the thin toolbar to the right of the 3D view) and set Scale -> Z to -1.
/// If you transform it using the S (scale) hotkey, it seems to set both Z and Y to -1 for some reason.
/// Then make the edits you need and export it as an .obj file to somewhere in the Unity project.
/// But this time, edit the setting named "Forward" to "Z forward" (not -Z as it is per default).
///
[JsonOptIn]
[Pathfinding.Util.Preserve]
public class RecastGraph : NavmeshBase, IUpdatableGraph {
[JsonMember]
///
/// Radius of the agent which will traverse the navmesh.
/// The navmesh will be eroded with this radius.
/// [Open online documentation to see images]
///
public float characterRadius = 0.5F;
///
/// Max distance from simplified edge to real edge.
/// This value is measured in voxels. So with the default value of 2 it means that the final navmesh contour may be at most
/// 2 voxels (i.e 2 times away from the border that was calculated when voxelizing the world.
/// A higher value will yield a more simplified and cleaner navmesh while a lower value may capture more details.
/// However a too low value will cause the individual voxels to be visible (see image below).
///
/// [Open online documentation to see images]
///
/// See:
///
[JsonMember]
public float contourMaxError = 2F;
///
/// Voxel sample size (x,z).
/// When generating a recast graph what happens is that the world is voxelized.
/// You can think of this as constructing an approximation of the world out of lots of boxes.
/// If you have played Minecraft it looks very similar (but with smaller boxes).
/// [Open online documentation to see images]
/// The cell size is the width and depth of those boxes. The height of the boxes is usually much smaller
/// and automatically calculated, however.
///
/// Lower values will yield higher quality navmeshes, however the graph will be slower to scan.
///
/// [Open online documentation to see images]
///
[JsonMember]
public float cellSize = 0.5F;
///
/// Character height.
/// [Open online documentation to see images]
///
[JsonMember]
public float walkableHeight = 2F;
///
/// Height the character can climb.
/// [Open online documentation to see images]
///
[JsonMember]
public float walkableClimb = 0.5F;
///
/// Max slope in degrees the character can traverse.
/// [Open online documentation to see images]
///
[JsonMember]
public float maxSlope = 30;
///
/// Longer edges will be subdivided.
/// Reducing this value can sometimes improve path quality since similarly sized triangles
/// yield better paths than really large and really triangles small next to each other.
/// However it will also add a lot more nodes which will make pathfinding slower.
/// For more information about this take a look at navmeshnotes (view in online documentation for working links).
///
/// [Open online documentation to see images]
///
[JsonMember]
public float maxEdgeLength = 20;
///
/// Minumum region size.
/// Small regions will be removed from the navmesh.
/// Measured in voxels.
///
/// [Open online documentation to see images]
///
/// If a region is adjacent to a tile border, it will not be removed
/// even though it is small since the adjacent tile might join it
/// to form a larger region.
///
/// [Open online documentation to see images]
/// [Open online documentation to see images]
///
[JsonMember]
public float minRegionSize = 3;
///
/// Size in voxels of a single tile.
/// This is the width of the tile.
///
/// [Open online documentation to see images]
///
/// A large tile size can be faster to initially scan (but beware of out of memory issues if you try with a too large tile size in a large world)
/// smaller tile sizes are (much) faster to update.
///
/// Different tile sizes can affect the quality of paths. It is often good to split up huge open areas into several tiles for
/// better quality paths, but too small tiles can also lead to effects looking like invisible obstacles.
/// For more information about this take a look at navmeshnotes (view in online documentation for working links).
/// Usually it is best to experiment and see what works best for your game.
///
/// When scanning a recast graphs individual tiles can be calculated in parallel which can make it much faster to scan large worlds.
/// When you want to recalculate a part of a recast graph, this can only be done on a tile-by-tile basis which means that if you often try to update a region
/// of the recast graph much smaller than the tile size, then you will be doing a lot of unnecessary calculations. However if you on the other hand
/// update regions of the recast graph that are much larger than the tile size then it may be slower than necessary as there is some overhead in having lots of tiles
/// instead of a few larger ones (not that much though).
///
/// Recommended values are between 64 and 256, but these are very soft limits. It is possible to use both larger and smaller values.
///
[JsonMember]
public int editorTileSize = 128;
///
/// Size of a tile along the X axis in voxels.
/// \copydetails editorTileSize
///
/// Warning: Do not modify, it is set from at Scan
///
/// See:
///
[JsonMember]
public int tileSizeX = 128;
///
/// Size of a tile along the Z axis in voxels.
/// \copydetails editorTileSize
///
/// Warning: Do not modify, it is set from at Scan
///
/// See:
///
[JsonMember]
public int tileSizeZ = 128;
///
/// If true, divide the graph into tiles, otherwise use a single tile covering the whole graph.
///
/// Using tiles is useful for a number of things. But it also has some drawbacks.
/// - Using tiles allows you to update only a part of the graph at a time. When doing graph updates on a recast graph, it will always recalculate whole tiles (or the whole graph if there are no tiles).
/// components also work on a tile-by-tile basis.
/// - Using tiles allows you to use s.
/// - Using tiles can break up very large triangles, which can improve path quality in some cases, and make the navmesh more closely follow the y-coordinates of the ground.
/// - Using tiles can make it much faster to generate the navmesh, because each tile can be calculated in parallel.
/// But if the tiles are made too small, then the overhead of having many tiles can make it slower than having fewer tiles.
/// - Using small tiles can make the path quality worse in some cases, but setting the s quality setting to high (or using ) will mostly mitigate this.
///
/// See:
///
/// Since: Since 4.1 the default value is true.
///
[JsonMember]
public bool useTiles = true;
///
/// If true, scanning the graph will yield a completely empty graph.
/// Useful if you want to replace the graph with a custom navmesh for example
///
/// Note: This is mostly obsolete now that the and functions exist.
///
public bool scanEmptyGraph;
public enum RelevantGraphSurfaceMode {
/// No RelevantGraphSurface components are required anywhere
DoNotRequire,
///
/// Any surfaces that are completely inside tiles need to have a component
/// positioned on that surface, otherwise it will be stripped away.
///
OnlyForCompletelyInsideTile,
///
/// All surfaces need to have one component
/// positioned somewhere on the surface and in each tile that it touches, otherwise it will be stripped away.
/// Only tiles that have a RelevantGraphSurface component for that surface will keep it.
///
RequireForAll
}
/// Whether to use 3D or 2D mode
public enum DimensionMode {
/// Allows the recast graph to use 2D colliders
Dimension2D,
/// Allows the recast graph to use 3D colliders, 3D meshes and terrains
Dimension3D,
}
///
/// Whether the base of the graph should default to being walkable or unwalkable.
///
/// See:
///
public enum BackgroundTraversability {
/// Makes the background walkable by default
Walkable,
/// Makes the background unwalkable by default
Unwalkable,
}
///
/// Per layer modification settings.
///
/// This can be used to make all surfaces with a specific layer get a specific pathfinding tag for example.
/// Or make all surfaces with a specific layer unwalkable.
///
/// See: If you instead want to apply similar settings on an object level, you can use the component.
///
[System.Serializable]
public struct PerLayerModification {
/// Unity layer that this modification applies to
public int layer;
/// \copydocref{RecastNavmeshModifier.mode}
public RecastNavmeshModifier.Mode mode;
/// \copydocref{RecastNavmeshModifier.surfaceID}
public int surfaceID;
public static PerLayerModification Default => new PerLayerModification {
layer = 0,
mode = RecastNavmeshModifier.Mode.WalkableSurface,
surfaceID = 1,
};
public static PerLayerModification[] ToLayerLookup (List perLayerModifications, PerLayerModification defaultValue) {
var lookup = new PerLayerModification[32];
int seen = 0;
for (int i = 0; i < lookup.Length; i++) {
lookup[i] = defaultValue;
lookup[i].layer = i;
}
for (int i = 0; i < perLayerModifications.Count; i++) {
if (perLayerModifications[i].layer < 0 || perLayerModifications[i].layer >= 32) {
Debug.LogError("Layer " + perLayerModifications[i].layer + " is out of range. Layers must be in the range [0...31]");
continue;
}
if ((seen & (1 << perLayerModifications[i].layer)) != 0) {
Debug.LogError("Several per layer modifications refer to the same layer '" + LayerMask.LayerToName(perLayerModifications[i].layer) + "'");
continue;
}
seen |= 1 << perLayerModifications[i].layer;
lookup[perLayerModifications[i].layer] = perLayerModifications[i];
}
return lookup;
}
}
/// Settings for which meshes/colliders and other objects to include in the graph
[System.Serializable]
public class CollectionSettings {
/// Determines how the initial filtering of objects is done
public enum FilterMode {
/// Use a layer mask to filter objects
Layers,
/// Use tags to filter objects
Tags,
}
///
/// Determines how the initial filtering of objects is done.
///
/// See:
/// See:
///
public FilterMode collectionMode = FilterMode.Layers;
///
/// Objects in all of these layers will be rasterized.
///
/// Will only be used if is set to Layers.
///
/// See:
///
public LayerMask layerMask = -1;
///
/// Objects tagged with any of these tags will be rasterized.
///
/// Will only be used if is set to Tags.
///
/// See:
///
public List tagMask = new List();
///
/// Use colliders to calculate the navmesh.
///
/// Depending on the , either 3D or 2D colliders will be rasterized.
///
/// Sphere/Capsule/Circle colliders will be approximated using polygons, with the precision specified in .
///
/// Note: In 2D mode, this is always treated as enabled, because no other types of inputs (like meshes or terrains) are supported.
///
public bool rasterizeColliders = true;
///
/// Use scene meshes to calculate the navmesh.
///
/// This can get you higher precision than colliders, since colliders are typically very simplified versions of the mesh.
/// However, it is often slower to scan, and graph updates can be particularly slow.
///
/// The reason that graph updates are slower is that there's no efficient way to find all meshes that intersect a given tile,
/// so the graph has to iterate over all meshes in the scene just to find the ones relevant for the tiles that you want to update.
/// Colliders, on the other hand, can be efficiently queried using the physics system.
///
/// You can disable this and attach a component (with dynamic=false) to all meshes that you want to be included in the navmesh instead.
/// That way they will be able to be efficiently queried for, without having to iterate through all meshes in the scene.
///
/// In 2D mode, this setting has no effect.
///
public bool rasterizeMeshes;
///
/// Use terrains to calculate the navmesh.
///
/// In 2D mode, this setting has no effect.
///
public bool rasterizeTerrain = true;
///
/// Rasterize tree colliders on terrains.
///
/// If the tree prefab has a collider, that collider will be rasterized.
/// Otherwise a simple box collider will be used and the script will
/// try to adjust it to the tree's scale, it might not do a very good job though so
/// an attached collider is preferable.
///
/// Note: It seems that Unity will only generate tree colliders at runtime when the game is started.
/// For this reason, this graph will not pick up tree colliders when scanned outside of play mode
/// but it will pick them up if the graph is scanned when the game has started. If it still does not pick them up
/// make sure that the trees actually have colliders attached to them and that the tree prefabs are
/// in the correct layer (the layer should be included in the layer mask).
///
/// In 2D mode, this setting has no effect.
///
/// See:
/// See:
///
public bool rasterizeTrees = true;
///
/// Controls how much to downsample the terrain's heightmap before generating the input mesh used for rasterization.
/// A higher value is faster to scan but less accurate.
///
public int terrainHeightmapDownsamplingFactor = 3;
///
/// Controls detail on rasterization of sphere and capsule colliders.
///
/// The colliders will be approximated with polygons so that the max distance to the theoretical surface is less than 1/(this number of voxels).
///
/// A higher value does not necessarily increase quality of the mesh, but a lower
/// value will often speed it up.
///
/// You should try to keep this value as low as possible without affecting the mesh quality since
/// that will yield the fastest scan times.
///
/// The default value is 1, which corresponds to a maximum error of 1 voxel.
/// In most cases, increasing this to a value higher than 2 (corresponding to a maximum error of 0.5 voxels) is not useful.
///
/// See: rasterizeColliders
///
/// Version: Before 4.3.80 this variable was not scaled by the , and so it would not transfer as easily between scenes of different scales.
///
public float colliderRasterizeDetail = 1;
///
/// Callback for collecting custom scene meshes.
///
/// This callback will be called once when scanning the graph, to allow you to add custom meshes to the graph, and once every time a graph update happens.
/// Use the class to add meshes that are to be rasterized.
///
/// Note: This is a callback, and can therefore not be serialized. You must set this field using code, every time the game starts (and optionally in edit mode as well).
///
///
/// AstarPath.active.data.recastGraph.collectionSettings.onCollectMeshes += (RecastMeshGatherer gatherer) => {
/// // Define a mesh using 4 vertices and 2 triangles
/// var vertices = new Vector3[] {
/// new Vector3(0, 0, 0),
/// new Vector3(100, 0, 0),
/// new Vector3(100, 0, 100),
/// new Vector3(0, 0, 100)
/// };
/// var triangles = new int[] { 0, 1, 2, 0, 2, 3 };
/// // Register the mesh buffers
/// var meshDataIndex = gatherer.AddMeshBuffers(vertices, triangles);
/// // Register the mesh for rasterization
/// gatherer.AddMesh(new RecastMeshGatherer.GatheredMesh {
/// meshDataIndex = meshDataIndex,
/// area = 0,
/// indexStart = 0,
/// indexEnd = -1,
/// bounds = default,
/// matrix = Matrix4x4.identity,
/// solid = false,
/// doubleSided = true,
/// flatten = false,
/// areaIsTag = false
/// });
/// };
/// AstarPath.active.Scan();
///
///
public System.Action onCollectMeshes;
}
///
/// List of rules that modify the graph based on the layer of the rasterized object.
///
/// [Open online documentation to see images]
///
/// By default, all layers are treated as walkable surfaces.
/// But by adding rules to this list, one can for example make all surfaces with a specific layer get a specific pathfinding tag.
///
/// Each layer should be modified at most once in this list.
///
/// If an object has a component attached, the settings on that component will override the settings in this list.
///
/// See:
///
[JsonMember]
public List perLayerModifications = new List();
///
/// Whether to use 3D or 2D mode.
///
/// See:
///
[JsonMember]
public DimensionMode dimensionMode = DimensionMode.Dimension3D;
///
/// Whether the base of the graph should default to being walkable or unwalkable.
///
/// This is only used in 2D mode. In 3D mode, this setting has no effect.
///
/// For 2D games, it can be very useful to set the background to be walkable by default, and then
/// constrain walkability using colliders.
///
/// If you don't want to use a walkable background, you can instead create colliders and attach a RecastNavmeshModifier with Surface Type set to Walkable Surface.
/// These will then create walkable regions.
///
/// See:
///
[JsonMember]
public BackgroundTraversability backgroundTraversability = BackgroundTraversability.Walkable;
///
/// Require every region to have a RelevantGraphSurface component inside it.
/// A RelevantGraphSurface component placed in the scene specifies that
/// the navmesh region it is inside should be included in the navmesh.
///
/// If this is set to OnlyForCompletelyInsideTile
/// a navmesh region is included in the navmesh if it
/// has a RelevantGraphSurface inside it, or if it
/// is adjacent to a tile border. This can leave some small regions
/// which you didn't want to have included because they are adjacent
/// to tile borders, but it removes the need to place a component
/// in every single tile, which can be tedious (see below).
///
/// If this is set to RequireForAll
/// a navmesh region is included only if it has a RelevantGraphSurface
/// inside it. Note that even though the navmesh
/// looks continous between tiles, the tiles are computed individually
/// and therefore you need a RelevantGraphSurface component for each
/// region and for each tile.
///
/// [Open online documentation to see images]
/// In the above image, the mode OnlyForCompletelyInsideTile was used. Tile borders
/// are highlighted in black. Note that since all regions are adjacent to a tile border,
/// this mode didn't remove anything in this case and would give the same result as DoNotRequire.
/// The RelevantGraphSurface component is shown using the green gizmo in the top-right of the blue plane.
///
/// [Open online documentation to see images]
/// In the above image, the mode RequireForAll was used. No tiles were used.
/// Note that the small region at the top of the orange cube is now gone, since it was not the in the same
/// region as the relevant graph surface component.
/// The result would have been identical with OnlyForCompletelyInsideTile since there are no tiles (or a single tile, depending on how you look at it).
///
/// [Open online documentation to see images]
/// The mode RequireForAll was used here. Since there is only a single RelevantGraphSurface component, only the region
/// it was in, in the tile it is placed in, will be enabled. If there would have been several RelevantGraphSurface in other tiles,
/// those regions could have been enabled as well.
///
/// [Open online documentation to see images]
/// Here another tile size was used along with the OnlyForCompletelyInsideTile.
/// Note that the region on top of the orange cube is gone now since the region borders do not intersect that region (and there is no
/// RelevantGraphSurface component inside it).
///
/// Note: When not using tiles. OnlyForCompletelyInsideTile is equivalent to RequireForAll.
///
[JsonMember]
public RelevantGraphSurfaceMode relevantGraphSurfaceMode = RelevantGraphSurfaceMode.DoNotRequire;
///
/// Determines which objects are used to build the graph, when it is scanned.
///
/// Also contains some settings for how to convert objects into meshes.
/// Spherical colliders, for example, need to be converted into a triangular mesh before they can be used in the graph.
///
/// See:
///
[JsonMember]
public CollectionSettings collectionSettings = new CollectionSettings();
///
/// Use colliders to calculate the navmesh.
///
/// Depending on the , either 3D or 2D colliders will be rasterized.
///
/// Sphere/Capsule/Circle colliders will be approximated using polygons, with the precision specified in .
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.rasterizeColliders instead")]
public bool rasterizeColliders {
get => collectionSettings.rasterizeColliders;
set => collectionSettings.rasterizeColliders = value;
}
///
/// Use scene meshes to calculate the navmesh.
///
/// This can get you higher precision than colliders, since colliders are typically very simplified versions of the mesh.
/// However, it is often slower to scan, and graph updates can be particularly slow.
///
/// The reason that graph updates are slower is that there's no efficient way to find all meshes that intersect a given tile,
/// so the graph has to iterate over all meshes in the scene just to find the ones relevant for the tiles that you want to update.
/// Colliders, on the other hand, can be efficiently queried using the physics system.
///
/// You can disable this and attach a component (with dynamic=false) to all meshes that you want to be included in the navmesh instead.
/// That way they will be able to be efficiently queried for, without having to iterate through all meshes in the scene.
///
/// In 2D mode, this setting has no effect.
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.rasterizeMeshes instead")]
public bool rasterizeMeshes {
get => collectionSettings.rasterizeMeshes;
set => collectionSettings.rasterizeMeshes = value;
}
///
/// Use terrains to calculate the navmesh.
///
/// In 2D mode, this setting has no effect.
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.rasterizeTerrain instead")]
public bool rasterizeTerrain {
get => collectionSettings.rasterizeTerrain;
set => collectionSettings.rasterizeTerrain = value;
}
///
/// Rasterize tree colliders on terrains.
///
/// If the tree prefab has a collider, that collider will be rasterized.
/// Otherwise a simple box collider will be used and the script will
/// try to adjust it to the tree's scale, it might not do a very good job though so
/// an attached collider is preferable.
///
/// Note: It seems that Unity will only generate tree colliders at runtime when the game is started.
/// For this reason, this graph will not pick up tree colliders when scanned outside of play mode
/// but it will pick them up if the graph is scanned when the game has started. If it still does not pick them up
/// make sure that the trees actually have colliders attached to them and that the tree prefabs are
/// in the correct layer (the layer should be included in the layer mask).
///
/// In 2D mode, this setting has no effect.
///
/// See:
/// See:
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.rasterizeTrees instead")]
public bool rasterizeTrees {
get => collectionSettings.rasterizeTrees;
set => collectionSettings.rasterizeTrees = value;
}
///
/// Controls detail on rasterization of sphere and capsule colliders.
///
/// The colliders will be approximated with polygons so that the max distance to the theoretical surface is less than 1/(this number of voxels).
///
/// A higher value does not necessarily increase quality of the mesh, but a lower
/// value will often speed it up.
///
/// You should try to keep this value as low as possible without affecting the mesh quality since
/// that will yield the fastest scan times.
///
/// The default value is 1, which corresponds to a maximum error of 1 voxel.
/// In most cases, increasing this to a value higher than 2 (corresponding to a maximum error of 0.5 voxels) is not useful.
///
/// See: rasterizeColliders
///
/// Version: Before 4.3.80 this variable was not scaled by the , and so it would not transfer as easily between scenes of different scales.
///
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.colliderRasterizeDetail instead")]
public float colliderRasterizeDetail {
get => collectionSettings.colliderRasterizeDetail;
set => collectionSettings.colliderRasterizeDetail = value;
}
///
/// Layer mask which filters which objects to include.
/// See:
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.layerMask instead")]
public LayerMask mask {
get => collectionSettings.layerMask;
set => collectionSettings.layerMask = value;
}
///
/// Objects tagged with any of these tags will be rasterized.
/// Note that this extends the layer mask, so if you only want to use tags, set to 'Nothing'.
///
/// See:
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.tagMask instead")]
public List tagMask {
get => collectionSettings.tagMask;
set => collectionSettings.tagMask = value;
}
///
/// Controls how large the sample size for the terrain is.
/// A higher value is faster to scan but less accurate.
///
/// The heightmap resolution is effectively divided by this value, before the terrain is rasterized.
///
/// Deprecated: Use instead
///
[System.Obsolete("Use collectionSettings.terrainHeightmapDownsamplingFactor instead")]
public int terrainSampleSize {
get => collectionSettings.terrainHeightmapDownsamplingFactor;
set => collectionSettings.terrainHeightmapDownsamplingFactor = value;
}
/// Rotation of the graph in degrees
[JsonMember]
public Vector3 rotation;
///
/// Center of the bounding box.
/// Scanning will only be done inside the bounding box
///
[JsonMember]
public Vector3 forcedBoundsCenter;
#if UNITY_EDITOR
/// Internal field used to warn users when the mesh includes meshes that are not readable at runtime
public List<(UnityEngine.Object, Mesh)> meshesUnreadableAtRuntime;
#endif
public override float NavmeshCuttingCharacterRadius => characterRadius;
public override bool RecalculateNormals { get { return true; } }
public override float TileWorldSizeX {
get {
return tileSizeX*cellSize;
}
}
public override float TileWorldSizeZ {
get {
return tileSizeZ*cellSize;
}
}
public override float MaxTileConnectionEdgeDistance {
get {
return walkableClimb;
}
}
///
/// World bounding box for the graph.
///
/// This always contains the whole graph.
///
/// Note: Since this is an axis-aligned bounding box, it may not be particularly tight if the graph is significantly rotated.
///
/// [Open online documentation to see images]
///
public override Bounds bounds {
get {
var m = (float4x4)CalculateTransform().matrix;
var b = new ToWorldMatrix(new float3x3(m.c0.xyz, m.c1.xyz, m.c2.xyz)).ToWorld(new Bounds(Vector3.zero, forcedBoundsSize));
b.center += forcedBoundsCenter;
return b;
}
}
///
/// True if the point is inside the bounding box of this graph.
///
/// Note: This method uses a tighter non-axis-aligned bounding box than you can get from the property.
///
/// Note: What is considered inside the bounds is only updated when the graph is scanned. For an unscanned graph, this will always return false.
///
/// In 2D mode, the point is considered inside if it is contained along the graph's X and Z axes (Y is ignored).
/// Note that the graph's X and Z axes are typically aligned with the world's X and Y axes when using 2D mode.
///
public override bool IsInsideBounds (Vector3 point) {
if (this.tiles == null || this.tiles.Length == 0) return false;
var local = (float3)transform.InverseTransform(point);
if (dimensionMode == DimensionMode.Dimension2D) {
return local.x >= 0 && local.z >= 0 && local.x <= forcedBoundsSize.x && local.z <= forcedBoundsSize.z;
} else {
return math.all(local >= 0) && math.all(local <= (float3)forcedBoundsSize);
}
}
[System.Obsolete("Use SnapBoundsToScene instead")]
public void SnapForceBoundsToScene () {
SnapBoundsToScene();
}
///
/// Changes the bounds of the graph to precisely encapsulate all objects in the scene.
/// The bounds will be expanded to fit all objects in the scene which match the current scanning settings.
///
/// This method corresponds to the 'Snap bounds to scene' button in the inspector.
///
/// See: rasterizeMeshes
/// See: rasterizeTerrain
/// See: rasterizeColliders
/// See: mask
/// See: tagMask
///
/// See: forcedBoundsCenter
/// See: forcedBoundsSize
///
public void SnapBoundsToScene () {
var arena = new DisposeArena();
var meshes = new TileBuilder(this, new TileLayout(this), default).CollectMeshes(new Bounds(Vector3.zero, new Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity)));
if (meshes.meshes.Length > 0) {
// Project all bounding boxes into a space relative to the current rotation of the graph
var m = new ToWorldMatrix(new float3x3((quaternion)Quaternion.Inverse(Quaternion.Euler(rotation))));
var bounds = m.ToWorld(meshes.meshes[0].bounds);
for (int i = 1; i < meshes.meshes.Length; i++) {
bounds.Encapsulate(m.ToWorld(meshes.meshes[i].bounds));
}
// Make sure the character can stand on all surfaces (with a bit of margin)
bounds.max += Vector3.up * (walkableHeight * 1.1f);
// Add a small bit of margin below the lowest surface, to ensure polygons right at the bottom are not lost due to floating point errors.
bounds.min -= Vector3.up * 0.01f;
// The center is in world space, so we need to convert it back from the rotated space
forcedBoundsCenter = Quaternion.Euler(rotation) * bounds.center;
forcedBoundsSize = Vector3.Max(bounds.size, Vector3.one*0.01f);
}
arena.Add(meshes);
arena.DisposeAll();
}
DisposeArena pendingGraphUpdateArena = new DisposeArena();
class RecastGraphUpdatePromise : IGraphUpdatePromise {
public List<(Promise, Promise, Promise)> promises;
public List graphUpdates;
public RecastGraph graph;
int graphHash;
public RecastGraphUpdatePromise (RecastGraph graph, List graphUpdates) {
this.promises = ListPool<(Promise, Promise, Promise)>.Claim();
this.graph = graph;
this.graphHash = HashSettings(graph);
var tileRecalculations = ListPool<(IntRect, GraphUpdateObject)>.Claim();
for (int i = graphUpdates.Count - 1; i >= 0; i--) {
var guo = graphUpdates[i];
if (guo.updatePhysics) {
graphUpdates.RemoveAt(i);
// Calculate world bounds of all affected tiles
// Expand TileBorderSizeInWorldUnits voxels in all directions to make sure
// all tiles that could be affected by the update are recalculated.
// TODO: Shouldn't this be expanded by the character radius too?
IntRect touchingTiles = graph.GetTouchingTiles(guo.bounds, graph.TileBorderSizeInWorldUnits);
if (touchingTiles.IsValid()) {
tileRecalculations.Add((touchingTiles, guo));
}
}
}
this.graphUpdates = graphUpdates;
// Sort larger updates first
if (tileRecalculations.Count > 1) tileRecalculations.Sort((a, b) => b.Item1.Area.CompareTo(a.Item1.Area));
for (int i = 0; i < tileRecalculations.Count; i++) {
var(touchingTiles, guo) = tileRecalculations[i];
// Skip this graph update if we have already scheduled an update that
// covers the same tiles
if (tileRecalculations.Count > 1) {
bool anyNew = false;
for (int z = touchingTiles.ymin; z <= touchingTiles.ymax; z++) {
for (int x = touchingTiles.xmin; x <= touchingTiles.xmax; x++) {
var tile = graph.GetTile(x, z);
anyNew |= !tile.flag;
tile.flag = true;
}
}
if (!anyNew) continue;
}
var tileLayout = new TileLayout(graph);
var pendingGraphUpdatePromise = RecastBuilder.BuildTileMeshes(graph, tileLayout, touchingTiles).Schedule(graph.pendingGraphUpdateArena);
var pendingCutPromise = RecastBuilder.CutTiles(graph, graph.navmeshUpdateData.clipperLookup, tileLayout).Schedule(pendingGraphUpdatePromise);
var pendingGraphUpdatePromise2 = RecastBuilder.BuildNodeTiles(graph, tileLayout).Schedule(graph.pendingGraphUpdateArena, pendingGraphUpdatePromise, pendingCutPromise);
promises.Add((pendingGraphUpdatePromise, pendingCutPromise, pendingGraphUpdatePromise2));
// TODO: Ideally we'd inform the navmesh cutting system that we have updated tiles here.
// Not notifying it is fine, but if a navmesh cut had been moved right before a graph update,
// the tile may be cut twice unnecessarily, losing a small amount of performance.
// Typically one does not combine navmesh cutting and normal graph updates, though.
}
if (tileRecalculations.Count > 1) {
for (int i = 0; i < tileRecalculations.Count; i++) {
var(touchingTiles, _) = tileRecalculations[i];
for (int z = touchingTiles.ymin; z <= touchingTiles.ymax; z++) {
for (int x = touchingTiles.xmin; x <= touchingTiles.xmax; x++) {
graph.GetTile(x, z).flag = false;
}
}
}
}
ListPool<(IntRect, GraphUpdateObject)>.Release(ref tileRecalculations);
}
public IEnumerator Prepare () {
for (int i = 0; i < promises.Count; i++) {
yield return promises[i].Item2.handle;
yield return promises[i].Item1.handle;
}
}
static int HashSettings(RecastGraph graph) => (((graph.tileXCount * 31) ^ graph.tileZCount) * 31 ^ graph.TileWorldSizeX.GetHashCode() * 31) ^ graph.TileWorldSizeZ.GetHashCode();
public void Apply (IGraphUpdateContext ctx) {
if (HashSettings(graph) != graphHash) throw new System.InvalidOperationException("Recast graph changed while a graph update was in progress. This is not allowed. Use AstarPath.active.AddWorkItem if you need to update graphs.");
for (int i = 0; i < promises.Count; i++) {
var preCutPromise = promises[i].Item1;
var postCutPromise = promises[i].Item2;
var tilePromise = promises[i].Item3;
Profiler.BeginSample("Applying graph update results");
var tilesResult = tilePromise.Complete();
var tileRect = tilesResult.progressSource.tileMeshes.tileRect;
var tiles = tilesResult.tiles;
preCutPromise.Dispose();
postCutPromise.Dispose();
tilePromise.Dispose();
// Initialize all nodes that were created in the jobs
for (int j = 0; j < tiles.Length; j++) AstarPath.active.InitializeNodes(tiles[j].nodes);
// Assign all tiles to the graph.
// Remove connections from existing tiles destroy the nodes
// Replace the old tile by the new tile
graph.StartBatchTileUpdate(exclusive: true);
for (int z = 0; z < tileRect.Height; z++) {
for (int x = 0; x < tileRect.Width; x++) {
var newTile = tiles[z*tileRect.Width + x];
// Assign the new tile
newTile.graph = graph;
graph.ClearTile(x + tileRect.xmin, z+tileRect.ymin, newTile);
}
}
graph.EndBatchTileUpdate();
// All tiles inside the update will already be connected to each other
// but they will not be connected to any tiles outside the update.
// We do this here. It needs to be done as one atomic update on the Unity main thread
// because other code may be reading graph data on the main thread.
var tilesHandle = System.Runtime.InteropServices.GCHandle.Alloc(graph.tiles);
var graphTileRect = new IntRect(0, 0, graph.tileXCount - 1, graph.tileZCount - 1);
JobConnectTiles.ScheduleRecalculateBorders(tilesHandle, default, graphTileRect, tileRect, new Vector2(graph.TileWorldSizeX, graph.TileWorldSizeZ), graph.MaxTileConnectionEdgeDistance).Complete();
tilesHandle.Free();
if (graph.OnRecalculatedTiles != null) graph.OnRecalculatedTiles(tiles);
ctx.DirtyBounds(graph.GetTileBounds(tileRect));
Profiler.EndSample();
}
graph.pendingGraphUpdateArena.DisposeAll();
if (graphUpdates != null) {
for (int i = 0; i < graphUpdates.Count; i++) {
var guo = graphUpdates[i];
// Figure out which tiles are affected
// Expand TileBorderSizeInWorldUnits voxels in all directions to make sure
// all tiles that could be affected by the update are recalculated.
var affectedTiles = graph.GetTouchingTiles(guo.bounds, graph.TileBorderSizeInWorldUnits);
// If the bounding box did not overlap with the graph then just skip the update
if (!affectedTiles.IsValid()) continue;
for (int z = affectedTiles.ymin; z <= affectedTiles.ymax; z++) {
for (int x = affectedTiles.xmin; x <= affectedTiles.xmax; x++) {
NavmeshTile tile = graph.tiles[z*graph.tileXCount + x];
NavMeshGraph.UpdateArea(guo, tile);
}
}
ctx.DirtyBounds(graph.GetTileBounds(affectedTiles));
}
}
}
}
IGraphUpdatePromise IUpdatableGraph.ScheduleGraphUpdates(List graphUpdates) => new RecastGraphUpdatePromise(this, graphUpdates);
class RecastGraphScanPromise : IGraphUpdatePromise {
public RecastGraph graph;
TileLayout tileLayout;
bool emptyGraph;
NavmeshTile[] tiles;
IProgress progressSource;
NavmeshUpdates.NavmeshUpdateSettings cutSettings;
public float Progress => progressSource != null ? progressSource.Progress : 1;
#if UNITY_EDITOR
List<(UnityEngine.Object, Mesh)> meshesUnreadableAtRuntime;
#endif
public IEnumerator Prepare () {
TriangleMeshNode.SetNavmeshHolder(AstarPath.active.data.GetGraphIndex(graph), graph);
if (!Application.isPlaying) {
RelevantGraphSurface.FindAllGraphSurfaces();
}
RelevantGraphSurface.UpdateAllPositions();
tileLayout = new TileLayout(graph);
// If this is true, just fill the graph with empty tiles
if (graph.scanEmptyGraph || tileLayout.tileCount.x*tileLayout.tileCount.y <= 0) {
emptyGraph = true;
yield break;
}
var arena = new DisposeArena();
var tileRect = new IntRect(0, 0, tileLayout.tileCount.x - 1, tileLayout.tileCount.y - 1);
var tileMeshesPromise = RecastBuilder.BuildTileMeshes(graph, tileLayout, tileRect).Schedule(arena);
cutSettings = new NavmeshUpdates.NavmeshUpdateSettings(graph, tileLayout);
var cutPromise = RecastBuilder.CutTiles(graph, cutSettings.clipperLookup, tileLayout).Schedule(tileMeshesPromise);
// Mark all navmesh cuts as up to date, since we are combining the cutting with the scan
cutSettings.DiscardPending();
var buildNodesJob = RecastBuilder.BuildNodeTiles(graph, tileLayout);
var tilesPromise = buildNodesJob.Schedule(arena, tileMeshesPromise, cutPromise);
progressSource = tilesPromise;
yield return tilesPromise.handle;
progressSource = null;
var tiles = tilesPromise.Complete();
var preCutMeshes = tileMeshesPromise.Complete();
var tileMeshes = cutPromise.Complete();
this.tiles = tiles.tiles;
#if UNITY_EDITOR
meshesUnreadableAtRuntime = preCutMeshes.meshesUnreadableAtRuntime;
preCutMeshes.meshesUnreadableAtRuntime = null;
#endif
preCutMeshes.Dispose();
tileMeshes.Dispose();
tiles.Dispose();
arena.DisposeAll();
}
public void Apply (IGraphUpdateContext ctx) {
// Destroy all previous nodes, if any exist
graph.DestroyAllNodes();
graph.hasExtendedInZ = false;
graph.hasExtendedInX = false;
cutSettings.AttachToGraph();
if (emptyGraph) {
graph.SetLayout(tileLayout);
graph.FillWithEmptyTiles();
} else {
// Initialize all nodes that were created in the jobs
for (int j = 0; j < tiles.Length; j++) AstarPath.active.InitializeNodes(tiles[j].nodes);
#if UNITY_EDITOR
graph.meshesUnreadableAtRuntime = meshesUnreadableAtRuntime;
#endif
// Assign all tiles to the graph
// We do this in a single atomic update (from the main thread's perspective) to ensure
// that even if one does an async scan, the graph will always be in a valid state.
// This guarantees that things like GetNearest will still work during an async scan.
graph.SetLayout(tileLayout);
graph.tiles = tiles;
for (int i = 0; i < tiles.Length; i++) tiles[i].graph = graph;
}
if (graph.OnRecalculatedTiles != null) graph.OnRecalculatedTiles(graph.tiles.Clone() as NavmeshTile[]);
}
}
///
/// Moves the recast graph by a number of tiles, discarding old tiles and scanning new ones.
///
/// Note: Only translation in a single direction is supported. dx == 0 || dz == 0 must hold.
/// If you need to move the graph diagonally, then you can call this function twice, once for each axis.
///
/// This is used by the component to efficiently move the graph.
///
/// All tiles that can stay in the same position will stay. The ones that would have fallen off the edge of the graph will be discarded,
/// and new tiles will be created and scanned at the other side of the graph.
///
/// See:
///
/// Returns: An async graph update promise. See
///
/// Number of tiles along the graph's X axis to move by.
/// Number of tiles along the graph's Z axis to move by.
public IGraphUpdatePromise TranslateInDirection (int dx, int dz) {
return new RecastMovePromise(this, new Vector2Int(dx, dz));
}
bool hasExtendedInX = false;
bool hasExtendedInZ = false;
class RecastMovePromise : IGraphUpdatePromise {
RecastGraph graph;
TileMeshes tileMeshes;
Vector2Int delta;
IntRect newTileRect;
public RecastMovePromise(RecastGraph graph, Vector2Int delta) {
this.graph = graph;
this.delta = delta;
if (delta.x != 0 && delta.y != 0) throw new System.ArgumentException("Only translation in a single direction is supported. delta.x == 0 || delta.y == 0 must hold.");
}
public IEnumerator Prepare () {
if (delta.x == 0 && delta.y == 0) yield break;
var originalTileRect = new IntRect(0, 0, graph.tileXCount - 1, graph.tileZCount - 1);
newTileRect = originalTileRect.Offset(delta);
var createdTiles = IntRect.Exclude(newTileRect, originalTileRect);
// Initially, the graph bounding box size may not be a multiple of the tile size.
// This can result in the tiles at the +x and +z borders of the graph being slightly cropped.
// When we move the graph, we will round it up to the nearest multiple of the tile size.
// However, this means we also need to recalculate those border tiles that may have been
// cropped before. So the first time we move in the +x and +z directions, we recalculate
// an extra row/column of tiles.
// Ideally we'd update all border tiles the first time we move in a direction, but that
// would require much more complex logic.
// If we move in the -x or -z directions, we don't need to calculate any extra tiles,
// and the tiles that were cropped originally will be discarded after the move.
if (!graph.hasExtendedInX && delta.x != 0) {
if (delta.x > 0) createdTiles.xmin -= 1;
graph.hasExtendedInX = true;
}
if (!graph.hasExtendedInZ && delta.y != 0) {
if (delta.y > 0) createdTiles.ymin -= 1;
graph.hasExtendedInZ = true;
}
var disposeArena = new DisposeArena();
var tileLayout = new TileLayout(graph);
// Disable cropping to the graph's exact bounds, since the new tiles are actually
// created outside the current bounds of the graph.
tileLayout.graphSpaceSize.x = float.PositiveInfinity;
tileLayout.graphSpaceSize.z = float.PositiveInfinity;
var buildSettings = RecastBuilder.BuildTileMeshes(graph, tileLayout, createdTiles);
buildSettings.scene = graph.active.gameObject.scene;
// Schedule the jobs asynchronously.
// These jobs will prepare the data for the update, but will not change any graph data.
// This is to ensure that the graph data stays valid even if the update takes multiple frames.
// Any changes will be made in the #Apply method.
var pendingPromise = buildSettings.Schedule(disposeArena);
// Wait for the job to complete
yield return pendingPromise.handle;
var output = pendingPromise.GetValue();
tileMeshes = output.tileMeshes.ToManaged();
pendingPromise.Dispose();
disposeArena.DisposeAll();
// Set the tile rect of the newly created tiles relative to the #newTileRect
tileMeshes.tileRect = createdTiles.Offset(-delta);
}
public void Apply (IGraphUpdateContext ctx) {
if (delta.x == 0 && delta.y == 0) return;
graph.Resize(newTileRect);
graph.ReplaceTiles(tileMeshes);
}
}
protected override IGraphUpdatePromise ScanInternal (bool async) => new RecastGraphScanPromise { graph = this };
public override GraphTransform CalculateTransform () {
return CalculateTransform(new Bounds(forcedBoundsCenter, forcedBoundsSize), Quaternion.Euler(rotation));
}
public static GraphTransform CalculateTransform (Bounds bounds, Quaternion rotation) {
return new GraphTransform(Matrix4x4.TRS(bounds.center, rotation, Vector3.one) * Matrix4x4.TRS(-bounds.extents, Quaternion.identity, Vector3.one));
}
protected void SetLayout (TileLayout info) {
this.tileXCount = info.tileCount.x;
this.tileZCount = info.tileCount.y;
this.tileSizeX = info.tileSizeInVoxels.x;
this.tileSizeZ = info.tileSizeInVoxels.y;
this.transform = info.transform;
}
/// Convert character radius to a number of voxels
internal int CharacterRadiusInVoxels {
get {
// Round it up most of the time, but round it down
// if it is very close to the result when rounded down
return Mathf.CeilToInt((characterRadius / cellSize) - 0.1f);
}
}
///
/// Number of extra voxels on each side of a tile to ensure accurate navmeshes near the tile border.
/// The width of a tile is expanded by 2 times this value (1x to the left and 1x to the right)
///
internal int TileBorderSizeInVoxels {
get {
return CharacterRadiusInVoxels + 3;
}
}
internal float TileBorderSizeInWorldUnits {
get {
return TileBorderSizeInVoxels*cellSize;
}
}
///
/// Resize the number of tiles that this graph contains.
///
/// This can be used both to make a graph larger, smaller or move the bounds of the graph around.
/// The new bounds are relative to the existing bounds which are IntRect(0, 0, tileCountX-1, tileCountZ-1).
///
/// Any current tiles that fall outside the new bounds will be removed.
/// Any new tiles that did not exist inside the previous bounds will be created as empty tiles.
/// All other tiles will be preserved. They will stay at their current world space positions.
///
/// Note: This is intended to be used at runtime on an already scanned graph.
/// If you want to change the bounding box of a graph like in the editor, use and instead.
///
///
/// AstarPath.active.AddWorkItem(() => {
/// var graph = AstarPath.active.data.recastGraph;
/// var currentBounds = new IntRect(0, 0, graph.tileXCount-1, graph.tileZCount-1);
///
/// // Make the graph twice as large, but discard the first 3 columns.
/// // All other tiles will be kept and stay at the same position in the world.
/// // The new tiles will be empty.
/// graph.Resize(new IntRect(3, 0, currentBounds.xmax*2, currentBounds.ymax*2));
/// });
///
///
/// Rectangle of tiles that the graph should contain. Relative to the old bounds.
public virtual void Resize (IntRect newTileBounds) {
AssertSafeToUpdateGraph();
if (!newTileBounds.IsValid()) throw new System.ArgumentException("Invalid tile bounds");
if (newTileBounds == new IntRect(0, 0, tileXCount-1, tileZCount-1)) return;
if (newTileBounds.Area == 0) throw new System.ArgumentException("Tile count must at least 1x1");
if (!useTiles) throw new System.InvalidOperationException("Cannot resize graph when tiles are not enabled");
StartBatchTileUpdate(exclusive: true);
// Create a new tile array and copy the old tiles over, and destroy tiles that are outside the new bounds
var newTiles = new NavmeshTile[newTileBounds.Area];
for (int z = 0; z < tileZCount; z++) {
for (int x = 0; x < tileXCount; x++) {
if (newTileBounds.Contains(x, z)) {
NavmeshTile tile = tiles[x + z*tileXCount];
newTiles[(x - newTileBounds.xmin) + (z - newTileBounds.ymin)*newTileBounds.Width] = tile;
} else {
ClearTile(x, z, null);
// This tile is removed, and that means some off-mesh links may need to be recalculated
DirtyBounds(GetTileBounds(x, z));
}
}
}
// Update the graph's bounding box so that it covers the new tiles
this.forcedBoundsSize = new Vector3(newTileBounds.Width*TileWorldSizeX, forcedBoundsSize.y, newTileBounds.Height*TileWorldSizeZ);
this.forcedBoundsCenter = this.transform.Transform(
new Vector3(
(newTileBounds.xmin + newTileBounds.xmax + 1)*0.5f*TileWorldSizeX,
forcedBoundsSize.y*0.5f,
(newTileBounds.ymin + newTileBounds.ymax + 1)*0.5f*TileWorldSizeZ
)
);
this.transform = CalculateTransform();
var offset = -(Int3) new Vector3(TileWorldSizeX * newTileBounds.xmin, 0, TileWorldSizeZ * newTileBounds.ymin);
// Create new tiles for the new bounds
for (int z = 0; z < newTileBounds.Height; z++) {
for (int x = 0; x < newTileBounds.Width; x++) {
var tileIndex = x + z*newTileBounds.Width;
var tile = newTiles[tileIndex];
if (tile == null) {
newTiles[tileIndex] = NewEmptyTile(x, z);
} else {
tile.x = x;
tile.z = z;
// Ensure nodes refer to the correct tile index
for (int i = 0; i < tile.nodes.Length; i++) {
var node = tile.nodes[i];
// The tile indices change when we resize the graph
node.v0 = (node.v0 & VertexIndexMask) | (tileIndex << TileIndexOffset);
node.v1 = (node.v1 & VertexIndexMask) | (tileIndex << TileIndexOffset);
node.v2 = (node.v2 & VertexIndexMask) | (tileIndex << TileIndexOffset);
}
// Update the vertex positions in graph space
for (int i = 0; i < tile.vertsInGraphSpace.Length; i++) {
tile.vertsInGraphSpace[i] += offset;
}
tile.vertsInGraphSpace.CopyTo(tile.verts);
transform.Transform(tile.verts);
// Recalculate the BBTree, since the vertices have moved in graph space.
// TODO: Should the BBTree be built in tile-space instead, to avoid this recalculation?
tile.bbTree.Dispose();
tile.bbTree = new BBTree(tile.tris, tile.vertsInGraphSpace);
}
}
}
this.tiles = newTiles;
this.tileXCount = newTileBounds.Width;
this.tileZCount = newTileBounds.Height;
EndBatchTileUpdate();
this.navmeshUpdateData.OnResized(newTileBounds, new TileLayout(this));
}
/// Initialize the graph with empty tiles if it is not currently scanned
public void EnsureInitialized () {
AssertSafeToUpdateGraph();
if (this.tiles == null) {
TriangleMeshNode.SetNavmeshHolder(AstarPath.active.data.GetGraphIndex(this), this);
SetLayout(new TileLayout(this));
FillWithEmptyTiles();
}
}
///
/// Load tiles from a object into this graph.
///
/// This can be used for many things, for example world streaming or placing large prefabs that have been pre-scanned.
///
/// The loaded tiles must have the same world-space size as this graph's tiles.
/// The world-space size for a recast graph is given by the multiplied by (or .
///
/// If the graph is not scanned when this method is called, the graph will be initialized and consist of just the tiles loaded by this call.
///
///
/// // Scans the first 6x6 chunk of tiles of the recast graph (the IntRect uses inclusive coordinates)
/// var graph = AstarPath.active.data.recastGraph;
/// var buildSettings = RecastBuilder.BuildTileMeshes(graph, new TileLayout(graph), new IntRect(0, 0, 5, 5));
/// var disposeArena = new Pathfinding.Jobs.DisposeArena();
/// var promise = buildSettings.Schedule(disposeArena);
///
/// AstarPath.active.AddWorkItem(() => {
/// // Block until the asynchronous job completes
/// var result = promise.Complete();
/// TileMeshes tiles = result.tileMeshes.ToManaged();
/// // Take the scanned tiles and place them in the graph,
/// // but not at their original location, but 2 tiles away, rotated 90 degrees.
/// tiles.tileRect = tiles.tileRect.Offset(new Vector2Int(2, 0));
/// tiles.Rotate(1);
/// graph.ReplaceTiles(tiles);
///
/// // Dispose unmanaged data
/// disposeArena.DisposeAll();
/// result.Dispose();
/// });
///
///
/// See:
/// See:
/// See:
/// See:
/// See:
/// See:
/// See:
///
/// The tiles to load. They will be loaded into the graph at the \reflink{TileMeshes.tileRect} tile coordinates.
/// All vertices in the loaded tiles will be moved upwards (or downwards if negative) by this amount.
public void ReplaceTiles (TileMeshes tileMeshes, float yOffset = 0) {
AssertSafeToUpdateGraph();
EnsureInitialized();
if (tileMeshes.tileWorldSize.x != TileWorldSizeX || tileMeshes.tileWorldSize.y != TileWorldSizeZ) {
throw new System.Exception("Loaded tile size does not match this graph's tile size.\n"
+ "The source tiles have a world-space tile size of " + tileMeshes.tileWorldSize + " while this graph's tile size is (" + TileWorldSizeX + "," + TileWorldSizeZ + ").\n"
+ "For a recast graph, the world-space tile size is defined as the cell size * the tile size in voxels");
}
var w = tileMeshes.tileRect.Width;
var h = tileMeshes.tileRect.Height;
UnityEngine.Assertions.Assert.AreEqual(w*h, tileMeshes.tileMeshes.Length);
// Ensure the graph is large enough
var newTileBounds = IntRect.Union(
new IntRect(0, 0, tileXCount - 1, tileZCount - 1),
tileMeshes.tileRect
);
Resize(newTileBounds);
tileMeshes.tileRect = tileMeshes.tileRect.Offset(-newTileBounds.Min);
StartBatchTileUpdate();
var updatedTiles = new NavmeshTile[w*h];
for (int z = 0; z < h; z++) {
for (int x = 0; x < w; x++) {
var tile = tileMeshes.tileMeshes[x + z*w];
var offset = (Int3) new Vector3(0, yOffset, 0);
for (int i = 0; i < tile.verticesInTileSpace.Length; i++) {
tile.verticesInTileSpace[i] += offset;
}
var tileCoordinates = new Vector2Int(x, z) + tileMeshes.tileRect.Min;
ReplaceTile(tileCoordinates.x, tileCoordinates.y, tile.verticesInTileSpace, tile.triangles);
updatedTiles[x + z*w] = GetTile(tileCoordinates.x, tileCoordinates.y);
}
}
EndBatchTileUpdate();
if (OnRecalculatedTiles != null) OnRecalculatedTiles(updatedTiles);
}
protected override void PostDeserialization (GraphSerializationContext ctx) {
base.PostDeserialization(ctx);
if (ctx.meta.version < AstarSerializer.V4_3_80) {
// This field changed behavior in 4.3.80. This is an approximate (but very good) conversion.
collectionSettings.colliderRasterizeDetail = 2*cellSize*collectionSettings.colliderRasterizeDetail*collectionSettings.colliderRasterizeDetail/(math.PI*math.PI);
}
if (ctx.meta.version < AstarSerializer.V5_1_0) {
if (collectionSettings.tagMask.Count > 0 && collectionSettings.layerMask != -1) {
Debug.LogError("In version 5.1.0 or higher of the A* Pathfinding Project you can no longer include objects both using a tag mask and a layer mask. Please choose in the recast graph inspector which one you want to use.");
} else if (collectionSettings.tagMask.Count > 0) {
collectionSettings.collectionMode = CollectionSettings.FilterMode.Tags;
}
}
}
}
}