Click or drag to resize

Pathfinding Class

Navigation mesh pathfinding.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.CoreExtension (in NeoAxis.CoreExtension.dll) Version: 2022.1.1.0 (2022.1.1.0)
Syntax
C#
public class Pathfinding : ObjectInSpace

The Pathfinding type exposes the following members.

Constructors
  NameDescription
Public methodPathfinding
Initializes a new instance of the Pathfinding class
Top
Properties
  NameDescription
Public propertyAgentHeight
Minimum height where the agent can still walk.
Public propertyAgentMaxClimb
Maximum height between grid cells the agent can climb.
Public propertyAgentRadius
Radius of the agent.
Public propertyAlwaysDisplayNavMesh
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCanBeSelected
Whether the object is selectable in the scene view.
(Inherited from ObjectInSpace.)
Public propertyCanBeSelectedInHierarchy (Inherited from ObjectInSpace.)
Public propertyCellHeight
The height resolution used when sampling the source geometry. The height of the voxels in voxel fields.
Public propertyCellSize
The width and depth resolution used when sampling the source geometry. The width and depth of the voxels in voxel fields. The width and depth of the cell columns that make up voxel fields. A lower value allows for the generated meshes to more closely match the source geometry, but at a higher processing and memory cost.
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyDetailMaxSampleError
The maximum distance the surface of the detail mesh may deviate from the surface of the original geometry.
Public propertyDetailSampleDistance
Sets the sampling distance to use when matching the detail mesh to the surface of the original geometry. Impacts how well the final detail mesh conforms to the surface contour of the original geometry. Higher values result in a detail mesh which conforms more closely to the original geometry's surface at the cost of a higher final triangle count and higher processing cost.
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
Public propertyDisposed
Whether the object is disposed.
(Inherited from Component.)
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component.)
Public propertyEditorReadOnly
Whether the object is read only in the editor.
(Inherited from Component.)
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component.)
Public propertyEnabled
Whether the component is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public propertyEnabledInHierarchy
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledInHierarchyAndIsNotResource
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledSelectionByCursor (Inherited from ObjectInSpace.)
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyStatic memberInstances
Public propertyMaxEdgeError
The maximum distance the edges of meshes may deviate from the source geometry. A lower value will result in mesh edges following the xy-plane geometry contour more accurately at the expense of an increased triangle count.
Public propertyMaxEdgeLength
The maximum length of polygon edges that represent the border of meshes. More vertices will be added to border edges if this value is exceeded for a particular edge. A value of zero will disable this feature.
Public propertyMaxVerticesPerPolygon
Public propertyMergedRegionSize
Any regions smaller than this size will, if possible, be merged with larger regions. Value is in voxels. Helps reduce the number of small regions. This is especially an issue in diagonal path regions where inherent faults in the region generation algorithm can result in unnecessarily small regions.
Public propertyMinRegionSize
The minimum region size for unconnected (island) regions. The value is in voxels. Regions that are not connected to any other region and are smaller than this size will be culled before mesh generation. I.e. They will no longer be considered traversable.
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyParentScene (Inherited from ObjectInSpace.)
Public propertyPathfindingMaxNodes
Maximum number of search nodes to use (max 65536).
Public propertyPrecompiledData
Public propertyRemainingLifetime
The lifetime of the component during the simulation.
(Inherited from ObjectInSpace.)
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
Public propertySpaceBounds (Inherited from ObjectInSpace.)
Public propertySpaceBoundsOverride (Inherited from ObjectInSpace.)
Public propertyTiles
Whether to use tiles to partition the navigation mesh. THE SUPPORT OF THE FEATURE IS NOT COMPLETED.
Public propertyTileSizeInCells
The amount of cells in the tile by one axis.
Public propertyTransform
The position, rotation and scale of the object.
(Inherited from ObjectInSpace.)
Public propertyTransformV
Simplier form of Transform.Value.
(Inherited from ObjectInSpace.)
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyVisible
Whether the object is visible in the scene.
(Inherited from ObjectInSpace.)
Public propertyVisibleInHierarchy (Inherited from ObjectInSpace.)
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
Public methodBuildPrecompiledData
Public methodCheckSelectionByRay (Inherited from ObjectInSpace.)
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodDebugDrawNavMesh
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
Public methodDoForceUpdate
Public methodDynamicObstacleAdd
Public methodDynamicObstacleDelete
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindParent(Type)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParentT
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindPath(PathfindingFindPathContext, Boolean)
Public methodFindPath(PathfindingFindPathContext, Boolean)
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodGetAllParents
Gets all parents of the component.
(Inherited from Component.)
Public methodGetComponent(String, Boolean)
Finds a child component by name.
(Inherited from Component.)
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component.)
Public methodGetComponentByPath
Finds a child component by path.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPathFromParent
Returns the path to the object from the parent.
(Inherited from Component.)
Public methodGetPathFromRoot
Returns the object's access path from the root object.
(Inherited from Component.)
Public methodGetProvidedType
Returns a type when the object is used as a type.
(Inherited from Component.)
Public methodGetScreenLabelInfo (Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
Public methodLookAt(ObjectInSpace) (Inherited from ObjectInSpace.)
Public methodLookAt(Vector3) (Inherited from ObjectInSpace.)
Public methodLookAt(ObjectInSpace, Vector3) (Inherited from ObjectInSpace.)
Public methodLookAt(Vector3, Vector3) (Inherited from ObjectInSpace.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
(Inherited from Component.)
Public methodMetadataGetMembers
Returns the object metadata members.
(Inherited from Component.)
Public methodMethodInvoke
Calls a method by name.
(Inherited from Component.)
Public methodMethodInvokeCancel (Inherited from Component.)
Public methodMethodInvokeCancelAll (Inherited from Component.)
Public methodNewObjectSetDefaultConfiguration
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Protected methodOnAddedToParent
Called when a component is added to the parent.
(Inherited from Component.)
Protected methodOnCheckSelectionByRay (Inherited from ObjectInSpace.)
Protected methodOnClone
Called when the object is cloned.
(Inherited from Component.)
Protected methodOnComponentAdded
Called when a child component is added.
(Inherited from Component.)
Protected methodOnComponentRemoved
Called when a child component is removed.
(Inherited from Component.)
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDisabledInSimulation
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDispose
Called when the object is disposed.
(Inherited from Component.)
Protected methodOnEditorGetTextInfoCenterBottomCorner (Inherited from Component.)
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
(Inherited from Component.)
Protected methodOnEnabledInHierarchyChanged (Overrides ObjectInSpaceOnEnabledInHierarchyChanged.)
Protected methodOnEnabledInSimulation
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledSelectionByCursor (Inherited from ObjectInSpace.)
Protected methodOnGetRenderSceneData (Inherited from ObjectInSpace.)
Protected methodOnLifetimeEnd (Inherited from ObjectInSpace.)
Protected methodOnLoad (Overrides ComponentOnLoad(MetadataLoadContext, TextBlock, String).)
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
(Inherited from Component.)
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
(Inherited from Component.)
Protected methodOnMetadataGetMembersFilter (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean).)
Protected methodOnOcclusionCullingDataContains (Inherited from ObjectInSpace.)
Protected methodOnOcclusionCullingDataGet (Inherited from ObjectInSpace.)
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
(Inherited from Component.)
Protected methodOnRemovedFromParent
Called when a component is removed from the parent.
(Inherited from Component.)
Protected methodOnSave (Overrides ComponentOnSave(MetadataSaveContext, TextBlock, Boolean, String).)
Protected methodOnSimulationStep (Inherited from ObjectInSpace.)
Protected methodOnSpaceBoundsChanged (Inherited from ObjectInSpace.)
Protected methodOnSpaceBoundsUpdate (Inherited from ObjectInSpace.)
Protected methodOnSpaceBoundsUpdateIncludeChildren (Inherited from ObjectInSpace.)
Protected methodOnTransformChanged (Inherited from ObjectInSpace.)
Protected methodOnTransformUpdating (Inherited from ObjectInSpace.)
Protected methodOnUpdate (Overrides ComponentOnUpdate(Single).)
Public methodPreloadResources
Preload resources used by the object.
(Inherited from Component.)
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
(Inherited from Component.)
Public methodPropertySet
Sets the value of a property by name.
(Inherited from Component.)
Public methodRemoveAllComponents
Removes all child components.
(Inherited from Component.)
Public methodRemoveComponent
Removes a child component.
(Inherited from Component.)
Public methodRemoveFromParent
Detaches the object from its parent.
(Inherited from Component.)
Public methodSetPosition(Vector3) (Inherited from ObjectInSpace.)
Public methodSetPosition(Double, Double, Double) (Inherited from ObjectInSpace.)
Public methodSetRotation(Angles) (Inherited from ObjectInSpace.)
Public methodSetRotation(Quaternion) (Inherited from ObjectInSpace.)
Public methodSetRotation(Double, Double, Double) (Inherited from ObjectInSpace.)
Public methodSetScale(Double) (Inherited from ObjectInSpace.)
Public methodSetScale(Vector3) (Inherited from ObjectInSpace.)
Public methodSetScale(Double, Double, Double) (Inherited from ObjectInSpace.)
Public methodSpaceBoundsUpdate (Inherited from ObjectInSpace.)
Public methodToString
Returns the name and type of the object as a string.
(Inherited from Component.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
(Inherited from Component.)
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventAgentHeightChanged
Occurs when the AgentHeight property value changes.
Public eventAgentMaxClimbChanged
Occurs when the AgentMaxClimb property value changes.
Public eventAgentRadiusChanged
Occurs when the AgentRadius property value changes.
Public eventAlwaysDisplayNavMeshChanged
Occurs when the AlwaysDisplayNavMesh property value changes.
Public eventCanBeSelectedChanged
Occurs when the CanBeSelected property value changes.
(Inherited from ObjectInSpace.)
Public eventCellHeightChanged
Occurs when the CellHeight property value changes.
Public eventCellSizeChanged
Occurs when the CellSize property value changes.
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventComponentAdded
Occurs when a child component is added.
(Inherited from Component.)
Public eventComponentRemoved
Occurs when a child component is removed.
(Inherited from Component.)
Public eventComponentsChanged
Occurs when the set of children is changed.
(Inherited from Component.)
Public eventDetailMaxSampleErrorChanged
Occurs when the DetailMaxSampleError property value changes.
Public eventDetailSampleDistanceChanged
Occurs when the DetailSampleDistance property value changes.
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisabledInSimulation
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
Public eventDisposeEvent
Occurs when the object is disposed.
(Inherited from Component.)
Public eventEnabledChanged
Occurs when the Enabled property value changes.
(Inherited from Component.)
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component.)
Public eventEnabledInSimulation
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventGetRenderSceneData (Inherited from ObjectInSpace.)
Public eventGetRenderSceneDataBefore (Inherited from ObjectInSpace.)
Public eventLifetimeEnd (Inherited from ObjectInSpace.)
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventMaxEdgeErrorChanged
Occurs when the MaxEdgeError property value changes.
Public eventMaxEdgeLengthChanged
Occurs when the MaxEdgeLength property value changes.
Public eventMaxVerticesPerPolygonChanged
Occurs when the MaxVerticesPerPolygon property value changes.
Public eventMergedRegionSizeChanged
Occurs when the MergedRegionSize property value changes.
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
(Inherited from Component.)
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
(Inherited from Component.)
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
(Inherited from Component.)
Public eventMinRegionSizeChanged
Occurs when the MinRegionSize property value changes.
Public eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventPathfindingMaxNodesChanged
Occurs when the PathfindingMaxNodes property value changes.
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventRemainingLifetimeChanged
Occurs when the RemainingLifetime property value changes.
(Inherited from ObjectInSpace.)
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventSpaceBoundsChanged
Occurs when the SpaceBounds property value changes.
(Inherited from ObjectInSpace.)
Public eventSpaceBoundsUpdateEvent (Inherited from ObjectInSpace.)
Public eventSpaceBoundsUpdateIncludeChildrenEvent (Inherited from ObjectInSpace.)
Public eventTilesChanged
Occurs when the Tiles property value changes.
Public eventTileSizeInCellsChanged
Occurs when the TileSizeInCells property value changes.
Public eventTransformChanged
Occurs when the Transform property value changes.
(Inherited from ObjectInSpace.)
Public eventTransformUpdatingEvent (Inherited from ObjectInSpace.)
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventVisibleChanged
Occurs when the Visible property value changes.
(Inherited from ObjectInSpace.)
Top
Extension Methods
See Also