Generic base class for areas in which HyperNav pathfinding can occur. More...

Public Member Functions
override void	Register ()
	Register this volume in the Instances dictionary and perform initialization. This can be used in edit mode to create the native data. It does not need to be called at runtime. More...

override void	Deregister (bool destroyData)
	Remove this volume from the Instances dictionary, and optionally destroy its native data. More...

void	UpdateNativeData (in TNativeData newData, in TPointers newPointers, bool updateSerializedAreaData, bool updateSerializedLinkData, IReadOnlyList< string > externalLinkScenePaths=null)
	Update native data for the nav area, optionally referencing new arrays. More...

Public Member Functions inherited from Infohazard.HyperNav.NavAreaBase
void	UpdateTransform ()
	Update the native data of this NavArea. More...

Static Public Member Functions
static void	UpdateAllTransforms ()
	Update the native data on all loaded NavAreas. Note, this must be called on each area type class (NavSurface and NavVolume) separately. More...

Static Public Attributes
static NativeParallelHashMap< long, TNativeData >	NativeDataMap
	Data for all loaded volumes in the format used by jobs. More...

Protected Member Functions
override void	Reset ()
	Reset certain properties to the first NavArea on the object. More...

Protected Member Functions inherited from Infohazard.HyperNav.NavAreaBase
virtual void	OnEnable ()
	Register this area in the Instances dictionary and perform initialization. More...

virtual void	OnDisable ()
	Remove this area from the Instances dictionary. More...

virtual void	Reset ()
	Reset certain properties to the first NavArea on the object. More...

virtual void	OnDestroy ()
	Dispose native-side data for this area. More...

virtual void	Update ()
	Update UniqueID in editor, and check movement. More...

Properties
TData	Data `[get, set]`

ref readonly TNativeData	NativeData `[get]`
	The native data for the volume. Will not be initialized until the volume is registered. More...

ref readonly TPointers	DataStructurePointers `[get]`
	The internal pointers to the native data for the volume. More...

TSettings	InstanceSettings `[get, set]`
	Settings specific to this area instance. On set, SharedSettings will be set to null. More...

NavAreaBaseSettingsAsset< TSettings >	SharedSettings `[get, set]`
	Shared settings asset for all areas of this type. If not null, InstanceSettings will be ignored. More...

TSettings	Settings `[get]`
	The settings object in use by this area, whether shared or instance. The returned object, while mutable, should not be modified directly as it may reference a ScriptableObject. More...

override NavAreaBaseSettings	BaseSettings `[get]`

override bool	IsNativeDataCreated `[get]`

static IReadOnlyDictionary< long, TArea >	Instances `[get]`
	All currently loaded volumes. More...

Properties inherited from Infohazard.HyperNav.NavAreaBase
Bounds	Bounds `[get, set]`
	The boundaries of the area. More...

INavAreaData INavArea.	Data `[get]`

Transform	Transform `[get]`

IReadOnlyList< NavExternalLinkData >	ExternalLinks `[get]`
	The external links for this area. More...

IReadOnlyList< SerializableRange >	ExternalLinkRanges `[get]`
	The ranges of external links for this area (one element per region). More...

ulong	DataVersionForExternalLinks `[get]`
	The version of the data when the external links were last updated. More...

long	InstanceID `[get]`
	The unique ID for this area to identify it in pathfinding jobs and serialized data. More...

bool	RandomInstanceID `[get, set]`
	Whether to generate a random instance ID on awake (use if instantiating dynamically). More...

bool	AutoDetectMovement `[get, set]`
	Whether to automatically update native data if the area moves. More...

abstract NavAreaBaseSettings	BaseSettings `[get]`
	Base settings for the area, whether shared or instance. The returned object, while mutable, should not be modified directly as it may reference a ScriptableObject. More...

abstract Type	SettingsAssetType `[get]`
	Type of settings asset for this area (should inherit from NavAreaBaseSettings). More...

bool	UseStartLocations `[get, set]`
	Whether only regions connected to certain locations are considered valid. More...

IReadOnlyList< Vector3 >	StartLocations `[get, set]`
	If _useStartLocations is true, which start locations to use. More...

int	VisualizationSoloRegion `[get, set]`
	If set, only this region will be included in the visualization mesh. More...

bool	VisualizeNeighbors `[get, set]`
	Whether to show the connections of a selected region in the scene view. More...

int	VisualizeNeighborsRegion `[get, set]`
	If _visualizeNeighbors is true, which region to visualize in the scene view. More...

bool	VisualizeExternalLinks `[get, set]`
	Whether to show the external links. More...

bool	ShowVertexNumbers `[get, set]`
	Whether to show the vertex numbers of the preview mesh in the scene view (for debugging). More...

float	ShowVertexNumbersRange `[get, set]`
	Max distance from the camera at which vertex numbers will be shown. More...

bool	VisualizeRegionBounds `[get, set]`
	Whether to visualize the bounds of each region in the scene view. More...

bool	VisualizeVoxelQueries `[get, set]`
	Whether to visualize the queries that are performed for a voxel when baking. More...

Mesh	PreviewMesh `[get, set]`
	(Editor Only) Preview mesh that is rendered to visualize the area. More...

Material[]	PreviewMaterials `[get, set]`
	(Editor Only) List of materials to use for drawing the preview mesh. More...

abstract bool	IsNativeDataCreated `[get]`
	Returns whether the native data for this area has been created. More...

Detailed Description

Generic base class for areas in which HyperNav pathfinding can occur.

Type Constraints

TArea	:	NavArea
TArea	:	TArea
TArea	:	TData
TArea	:	TNativeData
TArea	:	TPointers
TArea	:	TSettings
TData	:	ScriptableObject
TData	:	INavAreaData
TData	:	TNativeData
TData	:	TPointers
TNativeData	:	unmanaged
TNativeData	:	IDisposable
TNativeData	:	INativeNavAreaData
TPointers	:	struct
TPointers	:	IDisposable
TPointers	:	INativeNavAreaDataPointers
TSettings	:	NavAreaBaseSettings<TSettings>
TSettings	:	new()

Member Function Documentation

◆ Deregister()

override void Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.Deregister ( bool destroyData )

virtual

Remove this volume from the Instances dictionary, and optionally destroy its native data.

Parameters

destroyData Whether to free the memory used for native data.

Implements Infohazard.HyperNav.NavAreaBase.

◆ Register()

override void Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.Register ( )

virtual

Register this volume in the Instances dictionary and perform initialization. This can be used in edit mode to create the native data. It does not need to be called at runtime.

Implements Infohazard.HyperNav.NavAreaBase.

◆ Reset()

override void Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.Reset ( )

protectedvirtual

Reset certain properties to the first NavArea on the object.

Reimplemented from Infohazard.HyperNav.NavAreaBase.

◆ UpdateAllTransforms()

static void Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.UpdateAllTransforms ( )

static

Update the native data on all loaded NavAreas. Note, this must be called on each area type class (NavSurface and NavVolume) separately.

Use this after moving all areas when AutoDetectMovement is disabled.

◆ UpdateNativeData()

void Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.UpdateNativeData	(	in TNativeData	newData,
		in TPointers	newPointers,
		bool	updateSerializedAreaData,
		bool	updateSerializedLinkData,
		IReadOnlyList< string >	externalLinkScenePaths = `null`
	)

Update native data for the nav area, optionally referencing new arrays.

This does NOT automatically dispose the old arrays, as they may be shared with the new data. If you are not reusing the old arrays, you should dispose them manually.

Parameters

newData	New native data.
newPointers	New pointers to arrays.
updateSerializedAreaData	Whether to update the serialized area ScriptableObject as well. Note that this will incur a major performance cost because it will allocate managed memory. If this is used at runtime, it will copy the ScriptableObject to avoid modifying assets.
updateSerializedLinkData	Whether to update the serialized external link data as well. Note that this will incur a performance cost because it will allocate managed memory.
externalLinkScenePaths	If updating serialized link data, should contain the scene paths for each external link in the newData.ExternalLinks array.

Member Data Documentation

◆ NativeDataMap

NativeParallelHashMap<long, TNativeData> Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.NativeDataMap

static

Data for all loaded volumes in the format used by jobs.

Property Documentation

◆ BaseSettings

override NavAreaBaseSettings Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.BaseSettings

get

◆ Data

TData Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.Data

getset

◆ DataStructurePointers

ref readonly TPointers Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.DataStructurePointers

get

The internal pointers to the native data for the volume.

◆ Instances

IReadOnlyDictionary<long, TArea> Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.Instances

staticget

All currently loaded volumes.

◆ InstanceSettings

TSettings Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.InstanceSettings

getset

Settings specific to this area instance. On set, SharedSettings will be set to null.

◆ IsNativeDataCreated

override bool Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.IsNativeDataCreated

get

◆ NativeData

ref readonly TNativeData Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.NativeData

get

The native data for the volume. Will not be initialized until the volume is registered.

◆ Settings

TSettings Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.Settings

get

The settings object in use by this area, whether shared or instance. The returned object, while mutable, should not be modified directly as it may reference a ScriptableObject.

◆ SharedSettings

NavAreaBaseSettingsAsset<TSettings> Infohazard.HyperNav.NavArea< TArea, TData, TNativeData, TPointers, TSettings >.SharedSettings

getset

Shared settings asset for all areas of this type. If not null, InstanceSettings will be ignored.

The documentation for this class was generated from the following file:

Runtime/NavArea.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Deregister()

◆ Register()

◆ Reset()

◆ UpdateAllTransforms()

◆ UpdateNativeData()

Member Data Documentation

◆ NativeDataMap

Property Documentation

◆ BaseSettings

◆ Data

◆ DataStructurePointers

◆ Instances

◆ InstanceSettings

◆ IsNativeDataCreated

◆ NativeData

◆ Settings

◆ SharedSettings