Index
All Classes and Interfaces|All Packages
A
- abort() - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Aborts the pathfinding operation if it is still in progress.
- ABORTED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
The pathfinding process was aborted
- AbstractPathfinder - Class in de.bsommerfeld.pathetic.engine.pathfinder
-
Provides a skeletal implementation of the
Pathfinderinterface, defining common behavior for pathfinding algorithms. - AbstractPathfinder(PathfinderConfiguration) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- accept(T) - Method in interface de.bsommerfeld.pathetic.api.util.ParameterizedSupplier
-
Applies this supplier to the given argument.
- add(double, double, double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionby adding the given values to the coordinates of this position. - add(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionby adding the components of the given vector to the coordinates of this position. - add(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorby adding another vector to this vector. - allOf(ValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat evaluates totrueif all of the provided validators evaluate totrue. - allOf(List<ValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat evaluates totrueif all of the provided validators evaluate totrue. - alwaysFalse() - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Returns a
ValidationProcessorthat always evaluates tofalse. - alwaysTrue() - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Returns a
ValidationProcessorthat always evaluates totrue. - anyOf(ValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat evaluates totrueif any of the provided validators evaluate totrue. - anyOf(List<ValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat evaluates totrueif any of the provided validators evaluate totrue. - AStarPathfinder - Class in de.bsommerfeld.pathetic.engine.pathfinder
-
An A* pathfinding algorithm that uses a heuristic to guide the search toward the target.
- AStarPathfinder(PathfinderConfiguration) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
- AStarPathfinderFactory - Class in de.bsommerfeld.pathetic.engine.factory
- AStarPathfinderFactory() - Constructor for class de.bsommerfeld.pathetic.engine.factory.AStarPathfinderFactory
- async(boolean) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
B
- bloomFilterFpp(double) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- bloomFilterSize(int) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- build() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- builder() - Static method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
C
- calculate(HeuristicContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.heuristic.IHeuristicStrategy
-
Calculates the heuristic value (estimated cost) from the current position to the target.
- calculate(HeuristicContext) - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.LinearHeuristicStrategy
- calculate(HeuristicContext) - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.SquaredHeuristicStrategy
- calculate(PathfindingProgress) - Method in interface de.bsommerfeld.pathetic.api.pathing.calc.DistanceCalculator
-
Calculates and returns the distance metric for the given pathfinding progress.
- calculateCostContribution(EvaluationContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.CostProcessor
-
Calculates the cost contribution of this processor for the transition to the current node (PathPosition).
- calculateTransitionCost(PathPosition, PathPosition) - Method in interface de.bsommerfeld.pathetic.api.pathing.heuristic.IHeuristicStrategy
-
Calculates the actual transition cost between two adjacent positions.
- calculateTransitionCost(PathPosition, PathPosition) - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.LinearHeuristicStrategy
- calculateTransitionCost(PathPosition, PathPosition) - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.SquaredHeuristicStrategy
- canEqual(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
- canEqual(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
- capacity() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- capacity() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- capacity() - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.Resizable
-
Returns the current capacity of the internal storage.
- clear() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- clear() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- clear() - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Removes all elements from the heap.
- clone() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- clone() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
- collect() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Returns a new Collection of the Path Positions of the path.
- collect() - Method in class de.bsommerfeld.pathetic.engine.result.PathImpl
- compareTo(Node) - Method in class de.bsommerfeld.pathetic.engine.Node
- computeDistance(PathVector, PathVector, PathVector) - Static method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Computes the distance between a point and a line segment.
- concat(Iterable<? extends T>, Iterable<? extends T>) - Static method in class de.bsommerfeld.pathetic.engine.util.Iterables
-
Returns an iterable that concatenates two iterables.
- contains(long) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- contains(long) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- contains(long) - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Checks if a specific node is currently in the heap.
- cost(long) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- cost(long) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- cost(long) - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Gets the current cost of a node in the heap.
- Cost - Class in de.bsommerfeld.pathetic.api.pathing.processing
-
Represents a cost value used in pathfinding.
- costProcessor(List<CostProcessor>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- CostProcessor - Interface in de.bsommerfeld.pathetic.api.pathing.processing
-
A processor that calculates a specific cost contribution for traversing to a node (PathPosition).
- costProcessors - Variable in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- create(double, double, double, double) - Static method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
-
Creates a new
HeuristicWeightsinstance with the specified weights. - createPathfinder() - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderFactory
-
Creates a new instance of a
Pathfinderwith a defaultPathfinderConfiguration. - createPathfinder() - Method in class de.bsommerfeld.pathetic.engine.factory.AStarPathfinderFactory
- createPathfinder(PathfinderConfiguration) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderFactory
-
Creates a new
Pathfinderinstance with the given configuration. - createPathfinder(PathfinderConfiguration) - Method in class de.bsommerfeld.pathetic.engine.factory.AStarPathfinderFactory
-
Creates a new
AStarPathfinderinstance with the given configuration. - createPathfinder(PathfinderConfiguration, PathfinderInitializer) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderFactory
-
Creates a new
Pathfinderinstance with the given configuration and initializer. - createStartNode(PathPosition, PathPosition) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Creates the initial
Nodefor the start position. - currentPosition() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
-
The current position of the pathfinding step.
- currentPosition() - Method in class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
-
Returns the current step (position) of the pathfinding process.
D
- de.bsommerfeld.pathetic.api.factory - package de.bsommerfeld.pathetic.api.factory
- de.bsommerfeld.pathetic.api.pathing - package de.bsommerfeld.pathetic.api.pathing
- de.bsommerfeld.pathetic.api.pathing.calc - package de.bsommerfeld.pathetic.api.pathing.calc
- de.bsommerfeld.pathetic.api.pathing.configuration - package de.bsommerfeld.pathetic.api.pathing.configuration
- de.bsommerfeld.pathetic.api.pathing.context - package de.bsommerfeld.pathetic.api.pathing.context
- de.bsommerfeld.pathetic.api.pathing.heuristic - package de.bsommerfeld.pathetic.api.pathing.heuristic
- de.bsommerfeld.pathetic.api.pathing.hook - package de.bsommerfeld.pathetic.api.pathing.hook
- de.bsommerfeld.pathetic.api.pathing.processing - package de.bsommerfeld.pathetic.api.pathing.processing
-
Provides interfaces and classes for extending the core pathfinding logic of "pathetic" through a customizable processor pipeline.
- de.bsommerfeld.pathetic.api.pathing.processing.context - package de.bsommerfeld.pathetic.api.pathing.processing.context
- de.bsommerfeld.pathetic.api.pathing.result - package de.bsommerfeld.pathetic.api.pathing.result
- de.bsommerfeld.pathetic.api.provider - package de.bsommerfeld.pathetic.api.provider
- de.bsommerfeld.pathetic.api.util - package de.bsommerfeld.pathetic.api.util
- de.bsommerfeld.pathetic.api.wrapper - package de.bsommerfeld.pathetic.api.wrapper
- de.bsommerfeld.pathetic.engine - package de.bsommerfeld.pathetic.engine
- de.bsommerfeld.pathetic.engine.factory - package de.bsommerfeld.pathetic.engine.factory
- de.bsommerfeld.pathetic.engine.pathfinder - package de.bsommerfeld.pathetic.engine.pathfinder
- de.bsommerfeld.pathetic.engine.pathfinder.heap - package de.bsommerfeld.pathetic.engine.pathfinder.heap
- de.bsommerfeld.pathetic.engine.pathfinder.heap.impl - package de.bsommerfeld.pathetic.engine.pathfinder.heap.impl
- de.bsommerfeld.pathetic.engine.pathfinder.processing - package de.bsommerfeld.pathetic.engine.pathfinder.processing
- de.bsommerfeld.pathetic.engine.pathfinder.spatial - package de.bsommerfeld.pathetic.engine.pathfinder.spatial
- de.bsommerfeld.pathetic.engine.result - package de.bsommerfeld.pathetic.engine.result
- de.bsommerfeld.pathetic.engine.util - package de.bsommerfeld.pathetic.engine.util
- deepCopy(PathfinderConfiguration) - Static method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
-
Creates a deep copy of the given
PathfinderConfiguration. - DEFAULT_WEIGHTS - Static variable in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
-
Represents the default set of heuristic weights used for pathfinding calculations.
- Depth - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents the depth of a pathfinding node or element.
- DIAGONAL_3D - Static variable in class de.bsommerfeld.pathetic.api.pathing.NeighborStrategies
-
Checks all 26 surrounding nodes in a 3x3x3 cube.
- distance(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Calculates the Euclidean distance between this position and another position.
- distance(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Calculates the Euclidean distance between this vector and another vector.
- DistanceCalculator<M> - Interface in de.bsommerfeld.pathetic.api.pathing.calc
-
Computes a distance metric for the current state of a pathfinding operation.
- distanceSquared(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Calculates the squared distance between this position and another position.
- divide(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorby dividing this vector by a scalar value. - done() - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Checks if the pathfinding operation has completed.
- dot(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Calculates the dot product of this vector and another vector.
E
- EMPTY_PATH_POSITIONS - Static variable in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- ensureCapacity() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- ensureCapacity() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- ensureCapacity() - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.Resizable
-
Ensures the internal storage has sufficient capacity, resizing if necessary.
- EnvironmentContext - Interface in de.bsommerfeld.pathetic.api.pathing.context
-
A marker interface to implement, to provide environment-specific information to the Pathfinder.
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
- equals(Object) - Method in class de.bsommerfeld.pathetic.engine.Node
- EvaluationContext - Interface in de.bsommerfeld.pathetic.api.pathing.processing.context
-
Provides context for the evaluation of a single node (PathPosition) during a pathfinding search.
- EvaluationContextImpl - Class in de.bsommerfeld.pathetic.engine.pathfinder.processing
- EvaluationContextImpl(SearchContext, Node, Node, IHeuristicStrategy) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
-
Creates a new NodeEvaluationContextImpl with the specified parameters.
- exceptionally(Consumer<Throwable>) - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Executes the given callback if the pathfinding operation results in an exception.
- extractBestNode(MinHeap) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Extracts the node with the lowest cost from the open set and retrieves the corresponding Node object.
- extractBestNode(MinHeap) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
- extractMin() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- extractMin() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- extractMin() - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Removes and returns the node with the minimum cost from the heap.
F
- FAILED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
The Path wasn't found, either it reached its max search depth or it couldn't find more positions
- fallback(boolean) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- FALLBACK - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Signifies that the pathfinder fell back during the pathfinding attempt
- finalizeSearch(SearchContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.Processor
-
Called once at the end of a path search operation, regardless of whether a path was found or the search was aborted.
- findPath(PathPosition, PathPosition) - Method in interface de.bsommerfeld.pathetic.api.pathing.Pathfinder
-
Tries to find a Path between the two
PathPositions. - findPath(PathPosition, PathPosition, EnvironmentContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.Pathfinder
-
Tries to find a path between the specified start and target positions within the provided environment context.
- findPath(PathPosition, PathPosition, EnvironmentContext) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- flod(PathPosition) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.spatial.SpatialData
-
First Line of Defence.
- floor() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionwith the coordinates floored to the nearest integer values. - forEach(Consumer<? super PathPosition>) - Method in class de.bsommerfeld.pathetic.engine.result.PathImpl
- FOUND - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
The Path was successfully found
G
- getBaseTransitionCost() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Returns the base traversal cost for the transition from the
previous PathPositionto thecurrent PathPosition. - getBaseTransitionCost() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getBloomFilterFpp() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getBloomFilterSize() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getCenteredX() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- getCenteredY() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- getCenteredZ() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- getCrossProduct(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Calculates the cross product of this vector and another vector.
- getCurrentNodeDepth() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Returns the depth of the
current PathPositionin the search tree. - getCurrentNodeDepth() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getCurrentNodeHeuristicValue() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Returns the heuristic value (H-cost) calculated by the pathfinding engine for the
current PathPositiontowards the target. - getCurrentNodeHeuristicValue() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getCurrentPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Returns the PathPosition currently being evaluated.
- getCurrentPathPosition() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getDepth() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
-
The current depth of the pathfinding step.
- getDepth() - Method in class de.bsommerfeld.pathetic.engine.Node
- getEnd() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Returns the target position of the path
- getEnd() - Method in class de.bsommerfeld.pathetic.engine.result.PathImpl
- getEnvironmentContext() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Convenience method to access the EnvironmentContext of the overall search.
- getEnvironmentContext() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext
-
Returns the environment-specific context associated with the pathfinding operation.
- getEnvironmentContext() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- getFCost() - Method in class de.bsommerfeld.pathetic.engine.Node
-
Calculates the estimated total cost (F-cost) of the path from the start node to the target node, passing through this node.
- getFlooredX() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the x-coordinate of the block this position is located in.
- getFlooredY() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the y-coordinate of the block this position is located in.
- getFlooredZ() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the z-coordinate of the block this position is located in.
- getGCost() - Method in class de.bsommerfeld.pathetic.engine.Node
-
Gets the calculated G-cost (accumulated known cost from the start node) for this node.
- getGridCellSize() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getHeightWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
-
Returns the weight applied to the height difference (elevation change) component of the heuristic.
- getHeuristic() - Method in class de.bsommerfeld.pathetic.engine.Node
- getHeuristicStrategy() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getHeuristicWeights() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getLast(Iterable<T>) - Static method in class de.bsommerfeld.pathetic.engine.util.Iterables
-
Returns the last element of the specified iterable.
- getManhattanWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
-
Returns the weight applied to the Manhattan distance component of the heuristic.
- getMaxIterations() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getMaxLength() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getNavigationPoint(PathPosition) - Method in interface de.bsommerfeld.pathetic.api.provider.NavigationPointProvider
-
Gets the navigation point at the given position.
- getNavigationPoint(PathPosition, EnvironmentContext) - Method in interface de.bsommerfeld.pathetic.api.provider.NavigationPointProvider
-
Retrieves the navigation point at the specified position within the provided environment context.
- getNavigationPointProvider() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Convenience method to access the navigation point provider.
- getNavigationPointProvider() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext
-
Returns the NavigationPointProvider configured for the search.
- getNavigationPointProvider() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- getNeighborStrategy() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getNodeCostProcessors() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getNodeValidationProcessors() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getOctileWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
-
Returns the weight applied to the Octile distance component of the heuristic.
- getOffsets() - Method in interface de.bsommerfeld.pathetic.api.pathing.INeighborStrategy
-
Gets the collection of vectors to check for neighbor nodes.
- getOffsets(PathPosition) - Method in interface de.bsommerfeld.pathetic.api.pathing.INeighborStrategy
-
Gets the collection of vectors based on the current position.
- getOrLoadEngineVersion() - Static method in class de.bsommerfeld.pathetic.engine.Pathetic
- getParent() - Method in class de.bsommerfeld.pathetic.engine.Node
- getPath() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult
-
Returns the found
Pathregardless if successful or not. - getPath() - Method in class de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl
- getPathCostToPreviousPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Returns the accumulated G-cost (actual known cost from start) up to the
previous PathPosition. - getPathCostToPreviousPosition() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getPathfinderConfiguration() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Convenience method to access the pathfinder configuration.
- getPathfinderConfiguration() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext
-
Returns the configuration used for this pathfinding search.
- getPathfinderConfiguration() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- getPathfindingProgress() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
- getPathState() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult
-
Returns the state of the pathfinding.
- getPathState() - Method in class de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl
- getPerpendicularWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
-
Returns the weight applied to the perpendicular distance component of the heuristic.
- getPosition() - Method in class de.bsommerfeld.pathetic.engine.Node
- getPreviousPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Returns the PathPosition from which the
current PathPositionis being reached. - getPreviousPathPosition() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getProvider() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getSearchContext() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Provides access to the overarching
SearchContextfor this pathfinding operation. - getSearchContext() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.EvaluationContextImpl
- getSharedData() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Convenience method to access the shared data map for the overall search.
- getSharedData() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext
-
Returns a mutable map that can be used by
Processors to share data throughout the lifecycle of this search operation. - getSharedData() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- getStart() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Returns the start position of the path
- getStart() - Method in class de.bsommerfeld.pathetic.engine.result.PathImpl
- getStartPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Convenience method to access the start PathPosition of the overall search.
- getStartPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext
-
Returns the starting PathPosition of the path search.
- getStartPathPosition() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- getTargetPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext
-
Convenience method to access the target PathPosition of the overall search.
- getTargetPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.SearchContext
-
Returns the target (or goal) PathPosition of the path search.
- getTargetPathPosition() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- getValue() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
-
Deprecated.
- getValue() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
-
Deprecated.
- getX() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the x-coordinate of this position.
- getX() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Returns the x-component of this vector.
- getY() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the y-coordinate of this position.
- getY() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Returns the y-component of this vector.
- getZ() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the z-coordinate of this position.
- getZ() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Returns the z-component of this vector.
- gridCellSize(int) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
H
- hasFailed() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult
-
Whether the pathfinder has failed to reach its target.
- hasFailed() - Method in class de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl
- hasFallenBack() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult
-
Whether a pathfinder has resulted in a fallback.
- hasFallenBack() - Method in class de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
- hashCode() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
- hashCode() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- hashCode() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
- hashCode() - Method in class de.bsommerfeld.pathetic.engine.Node
- HeuristicContext - Class in de.bsommerfeld.pathetic.api.pathing.heuristic
-
An immutable context object used for heuristic calculations providing the essentials.
- HeuristicContext(PathfindingProgress, HeuristicWeights) - Constructor for class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
- HeuristicContext(PathPosition, PathPosition, PathPosition, HeuristicWeights) - Constructor for class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
- HeuristicStrategies - Class in de.bsommerfeld.pathetic.api.pathing.heuristic
-
A util class to provide the two predefined
IHeuristicStrategys of Pathetic. - heuristicStrategy(IHeuristicStrategy) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- heuristicWeights() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
-
The heuristic weights used in the pathfinding process.
- heuristicWeights(HeuristicWeights) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- HeuristicWeights - Class in de.bsommerfeld.pathetic.api.pathing.heuristic
-
Represents a set of weights used to calculate a heuristic for the A* pathfinding algorithm.
I
- ifPresent(Consumer<PathfinderResult>) - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Executes the given callback if the pathfinding operation results in a successful path or a fallback.
- IHeuristicStrategy - Interface in de.bsommerfeld.pathetic.api.pathing.heuristic
-
Defines the contract for heuristic strategies used in pathfinding algorithms.
- increment() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
-
Increments the depth value by one.
- INeighborStrategy - Interface in de.bsommerfeld.pathetic.api.pathing
-
A functional interface to provide an offset as a
Iterableconsisting ofPathVectors. - initialize(Pathfinder, PathfinderConfiguration) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderInitializer
-
Initializes the given
Pathfinderwith the givenPathfinderConfiguration. - initializeSearch() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Prepares the algorithm-specific initial setup required before executing the pathfinding logic.
- initializeSearch() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
- initializeSearch(SearchContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.Processor
-
Called once at the beginning of a path search operation.
- insertOrUpdate(long, double) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- insertOrUpdate(long, double) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- insertOrUpdate(long, double) - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Inserts a new node or updates an existing node's cost in the heap.
- insertStartNode(Node, double, MinHeap) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Inserts the start node into the open set and updates any internal mapping.
- insertStartNode(Node, double, MinHeap) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
- interpolate(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.util.NumberUtils
-
Interpolates between two values based on the given progress.
- interpolate(Path, double) - Static method in class de.bsommerfeld.pathetic.engine.result.PathUtils
-
Deprecated.Interpolates a path by inserting intermediate positions between each pair of consecutive points.
- isAsync() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- isEmpty() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- isEmpty() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
-
Checks if the heap is empty.
- isEmpty() - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Checks if the heap is empty.
- isFallback() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- isTarget(PathPosition) - Method in class de.bsommerfeld.pathetic.engine.Node
- isTraversable() - Method in interface de.bsommerfeld.pathetic.api.provider.NavigationPoint
-
Returns whether the position is traversable or not.
- isValid(EvaluationContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.ValidationProcessor
-
Checks if the current node (PathPosition) (or the transition to it from the previous node) is valid according to the logic of this validator.
- Iterables - Class in de.bsommerfeld.pathetic.engine.util
-
Utility class that provides methods for working with Iterables.
- iterator() - Method in class de.bsommerfeld.pathetic.engine.result.PathImpl
J
- join(Path, Path) - Static method in class de.bsommerfeld.pathetic.engine.result.PathUtils
-
Deprecated.Concatenates two paths into a single continuous path.
L
- length() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
The length of the Path compiled from the number of positions
- length() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Calculates the length (magnitude) of this vector.
- length() - Method in class de.bsommerfeld.pathetic.engine.result.PathImpl
- LENGTH_LIMITED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Signifies that the pathfinder reached its length limit
- limit(Iterable<T>, int) - Static method in class de.bsommerfeld.pathetic.engine.util.Iterables
-
Returns an iterable that contains the first
limitSizeelements of the specified iterable. - LINEAR - Static variable in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicStrategies
- LinearHeuristicStrategy - Class in de.bsommerfeld.pathetic.api.pathing.heuristic
-
A linear heuristic strategy combining multiple distance metrics for pathfinding.
- LinearHeuristicStrategy() - Constructor for class de.bsommerfeld.pathetic.api.pathing.heuristic.LinearHeuristicStrategy
M
- manhattanDistance(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Deprecated.marked for removal
- markNodeAsExpanded(Node) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Marks the given node as expanded (i.e., added to the "closed set").
- markNodeAsExpanded(Node) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
- MAX_ITERATIONS_REACHED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Signifies that the pathfinder reached its iteration limit
- maxIterations(int) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- maxLength(int) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- mid() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionwith the coordinates set to the center of the block they are in. - midPoint(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Calculates the midpoint between this position and another position.
- MinHeap - Interface in de.bsommerfeld.pathetic.engine.pathfinder.heap
-
Contract for min-heap implementations used in pathfinding algorithms.
- multiply(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorby multiplying this vector by a scalar value. - mutatePositions(Path, ParameterizedSupplier<PathPosition>) - Static method in class de.bsommerfeld.pathetic.engine.result.PathUtils
-
Deprecated.Applies a transformation function to every position in the path.
N
- NavigationPoint - Interface in de.bsommerfeld.pathetic.api.provider
-
Represents information about a position in the pathfinding environment.
- navigationPointProvider - Variable in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- NavigationPointProvider - Interface in de.bsommerfeld.pathetic.api.provider
-
The NavigationPointProvider interface defines methods for retrieving navigation point data at specific positions within a 3D environment.
- NeighborStrategies - Class in de.bsommerfeld.pathetic.api.pathing
-
This class serves as a util class in order to access Pathetic's predefined
INeighborStrategys. - neighborStrategy - Variable in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- neighborStrategy(INeighborStrategy) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- Node - Class in de.bsommerfeld.pathetic.engine
-
Represents a node in the pathfinding graph.
- Node(PathPosition, PathPosition, PathPosition, HeuristicWeights, IHeuristicStrategy, int) - Constructor for class de.bsommerfeld.pathetic.engine.Node
-
Creates a new Node with the specified parameters.
- nodeCostProcessors(List<CostProcessor>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
-
Deprecated.
- nodeValidationProcessors(List<ValidationProcessor>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
-
Deprecated.
- noneOf(ValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat evaluates totrueif none of the provided validators evaluate totrue(i.e., all evaluate tofalse). - noneOf(List<ValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat evaluates totrueif none of the provided validators evaluate totrue(i.e., all evaluate tofalse). - normalize() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorby normalizing this vector. - not(ValidationProcessor) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
ValidationProcessorthat inverts the result of the given validator. - NumberUtils - Class in de.bsommerfeld.pathetic.api.util
-
Utility class for common number operations.
O
- octileDistance(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Deprecated.marked for removal
- of(double) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
-
Factory method to create a
Costinstance. - of(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositioninstance with the specified coordinates. - of(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorinstance with the specified components. - of(int) - Static method in class de.bsommerfeld.pathetic.api.wrapper.Depth
-
Creates a new
Depthinstance with the specified value. - onPathfindingStep(PathfindingContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.hook.PathfinderHook
-
Called on each step of the pathfinding process.
- orElse(Consumer<PathfinderResult>) - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Executes the given callback if the pathfinding operation results in a failure, abortion, length limitation, or reaching maximum iterations.
P
- pack(int, int, int) - Static method in class de.bsommerfeld.pathetic.engine.util.RegionKey
-
Packs raw integer coordinates into a primitive long key.
- pack(PathPosition) - Static method in class de.bsommerfeld.pathetic.engine.util.RegionKey
-
Packs a PathPosition into a primitive long key.
- ParameterizedSupplier<T> - Interface in de.bsommerfeld.pathetic.api.util
-
A functional interface representing a supplier that accepts a parameter and returns a result.
- Path - Interface in de.bsommerfeld.pathetic.api.pathing.result
-
A Path is a sequence of positions that represents a path through a 3D space.
- Pathetic - Class in de.bsommerfeld.pathetic.engine
- Pathfinder - Interface in de.bsommerfeld.pathetic.api.pathing
-
A Pathfinder is a class that can find a path between two positions while following a given set of rules.
- pathfinderConfiguration - Variable in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- PathfinderConfiguration - Class in de.bsommerfeld.pathetic.api.pathing.configuration
-
Defines a set of configurable parameters that govern the behavior of the A* pathfinding algorithm.
- PathfinderConfiguration.PathfinderConfigurationBuilder - Class in de.bsommerfeld.pathetic.api.pathing.configuration
- PathfinderFactory - Interface in de.bsommerfeld.pathetic.api.factory
-
A factory interface for creating
Pathfinderinstances. - PathfinderHook - Interface in de.bsommerfeld.pathetic.api.pathing.hook
-
Interface for hooks that are called during the pathfinding process.
- PathfinderInitializer - Interface in de.bsommerfeld.pathetic.api.factory
-
An interface for initializing
Pathfinderinstances. - PathfinderResult - Interface in de.bsommerfeld.pathetic.api.pathing.result
-
The result of a pathfinding operation.
- PathfinderResultImpl - Class in de.bsommerfeld.pathetic.engine.result
- PathfinderResultImpl(PathState, Path) - Constructor for class de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl
- PathfindingContext - Class in de.bsommerfeld.pathetic.api.pathing.hook
-
Context for the current step of the pathfinding process.
- PathfindingContext(PathPosition, Depth) - Constructor for class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- pathfindingHooks() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- pathfindingHooks(List<PathfinderHook>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- PathfindingProgress - Class in de.bsommerfeld.pathetic.api.pathing
-
Immutable container for the three core positions in a pathfinding operation.
- PathfindingProgress(PathPosition, PathPosition, PathPosition) - Constructor for class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
- PathfindingSearch - Interface in de.bsommerfeld.pathetic.api.pathing
-
Represents a pathfinding operation that can be configured with callbacks for different outcomes.
- PathImpl - Class in de.bsommerfeld.pathetic.engine.result
- PathImpl(PathPosition, PathPosition, Iterable<PathPosition>) - Constructor for class de.bsommerfeld.pathetic.engine.result.PathImpl
- PathPosition - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents a position.
- PathPosition(double, double, double) - Constructor for class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Constructs a
PathPositionwith the specified coordinates. - PathState - Enum in de.bsommerfeld.pathetic.api.pathing.result
-
The state of a finished pathfinding process.
- PathUtils - Class in de.bsommerfeld.pathetic.engine.result
-
Deprecated.Pathetic's future focus will rely heavily on finding paths, not modifying or post-processing them. This class is maintained for backward compatibility until a dedicated post-processing module is available.
- PathVector - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents a 3D vector within a pathfinding context.
- PathVector(double, double, double) - Constructor for class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Constructs a
PathVectorwith the specified x, y, and z components. - performAlgorithmCleanup() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Abstract method for algorithm-specific cleanup, called after pathfinding execution.
- performAlgorithmCleanup() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
- position() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
-
The current to-evaluate position.
- PrimitiveMinHeap - Class in de.bsommerfeld.pathetic.engine.pathfinder.heap.impl
-
A highly optimized, array-backed binary min-heap for A* pathfinding.
- PrimitiveMinHeap(int) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- Processor - Interface in de.bsommerfeld.pathetic.api.pathing.processing
-
Base interface for pathfinding processors.
- processSuccessors(PathPosition, PathPosition, Node, MinHeap, SearchContext) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Abstract method representing the core logic of processing successor nodes for a given
currentNode. - processSuccessors(PathPosition, PathPosition, Node, MinHeap, SearchContext) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AStarPathfinder
-
Processes the successors of the current node, checking if they're in the open or closed set, calculating costs, validating traversability, and updating the open set as needed.
- provider(NavigationPointProvider) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
Q
- QuaternaryPrimitiveMinHeap - Class in de.bsommerfeld.pathetic.engine.pathfinder.heap.impl
-
A quaternary (4-ary) min-heap implementation optimized for pathfinding algorithms.
- QuaternaryPrimitiveMinHeap() - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
-
Constructs a new quaternary min-heap with the default initial capacity.
- QuaternaryPrimitiveMinHeap(int) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
-
Constructs a new quaternary min-heap with the specified initial capacity.
R
- reconstructPath(PathPosition, PathPosition, Node) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
-
Reconstructs the path by tracing back from the given end node to the start node.
- RegionKey - Class in de.bsommerfeld.pathetic.engine.util
-
Utility class to pack 3D grid coordinates (Region Indices or Block Positions) into a single primitive long.
- register(PathPosition) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.spatial.SpatialData
-
Registers a given path position by adding it to the Bloom filter and marking it as examined within the regional positions set.
- registerPathfindingHook(PathfinderHook) - Method in interface de.bsommerfeld.pathetic.api.pathing.Pathfinder
-
Deprecated.Use
PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks(java.util.List)to configure hooks in thePathfinderConfigurationinstead. - registerPathfindingHook(PathfinderHook) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- reopenClosedNodes(boolean) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- Resizable - Interface in de.bsommerfeld.pathetic.engine.pathfinder.heap
-
Contract for data structures that can dynamically resize their internal storage.
- result() - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Retrieves the result of the pathfinding operation if it has completed.
- resultBlocking() - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch
-
Blocks until the pathfinding operation completes and returns the result.
S
- SearchContext - Interface in de.bsommerfeld.pathetic.api.pathing.processing.context
-
Provides context for an entire pathfinding search operation.
- SearchContextImpl - Class in de.bsommerfeld.pathetic.engine.pathfinder.processing
- SearchContextImpl(PathPosition, PathPosition, PathfinderConfiguration, NavigationPointProvider, EnvironmentContext) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.processing.SearchContextImpl
- setGCost(double) - Method in class de.bsommerfeld.pathetic.engine.Node
-
Sets the calculated G-cost for this node.
- setParent(Node) - Method in class de.bsommerfeld.pathetic.engine.Node
- setX(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionwith the same coordinates as this one, but with the x-coordinate set to the given value. - setX(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorwith the same y and z components as this vector, but with the x-component set to the given value. - setY(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionwith the same coordinates as this one, but with the y-coordinate set to the given value. - setY(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorwith the same x and z components as this vector, but with the y-component set to the given value. - setZ(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionwith the same coordinates as this one, but with the z-coordinate set to the given value. - setZ(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorwith the same x and y components as this vector, but with the z-component set to the given value. - shouldReopenClosedNodes() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- Siftable - Interface in de.bsommerfeld.pathetic.engine.pathfinder.heap
-
Contract for heap implementations that use sift operations to maintain heap property.
- siftDown(int) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- siftDown(int) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
-
Moves a node down the heap until the heap property is restored.
- siftDown(int) - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.Siftable
-
Moves a node down the heap until the heap property is restored.
- siftUp(int) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- siftUp(int) - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
-
Moves a node up the heap until the heap property is restored.
- siftUp(int) - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.Siftable
-
Moves a node up the heap until the heap property is restored.
- simplify(Path, double) - Static method in class de.bsommerfeld.pathetic.engine.result.PathUtils
-
Deprecated.Simplifies a path by retaining only every nth point based on an epsilon value.
- size() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.PrimitiveMinHeap
- size() - Method in class de.bsommerfeld.pathetic.engine.pathfinder.heap.impl.QuaternaryPrimitiveMinHeap
- size() - Method in interface de.bsommerfeld.pathetic.engine.pathfinder.heap.MinHeap
-
Returns the number of elements currently in the heap.
- size(Iterable<?>) - Static method in class de.bsommerfeld.pathetic.engine.util.Iterables
-
Returns the number of elements in the specified iterable.
- SpatialData - Class in de.bsommerfeld.pathetic.engine.pathfinder.spatial
-
The SpatialData class represents the data associated with a grid region.
- SpatialData(int, double) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.spatial.SpatialData
-
Creates a new SpatialData with the specified Bloom filter settings.
- SpatialData(PathfinderConfiguration) - Constructor for class de.bsommerfeld.pathetic.engine.pathfinder.spatial.SpatialData
-
Creates a new GridRegionData with Bloom filter settings from the provided configuration.
- sqrt(double) - Static method in class de.bsommerfeld.pathetic.api.util.NumberUtils
-
Computes the square root of the given value using an approximation method.
- square(double) - Static method in class de.bsommerfeld.pathetic.api.util.NumberUtils
-
Squares the given value.
- SQUARED - Static variable in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicStrategies
- SquaredHeuristicStrategy - Class in de.bsommerfeld.pathetic.api.pathing.heuristic
-
A performance-optimized heuristic strategy using squared distance metrics.
- SquaredHeuristicStrategy() - Constructor for class de.bsommerfeld.pathetic.api.pathing.heuristic.SquaredHeuristicStrategy
- startPosition() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
-
The overall start position of the pathfinding.
- startPosition() - Method in class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
-
Returns the start position of the overall pathfinding process.
- subtract(double, double, double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionby subtracting the given values from the coordinates of this position. - subtract(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPositionby subtracting the components of the given vector from the coordinates of this position. - subtract(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
-
Creates a new
PathVectorby subtracting another vector from this vector. - successful() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult
-
Returns whether the pathfinding was successful.
- successful() - Method in class de.bsommerfeld.pathetic.engine.result.PathfinderResultImpl
T
- targetPosition() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext
-
The overall target position of the pathfinding.
- targetPosition() - Method in class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
-
Returns the destination (target) position of the overall pathfinding process.
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.PathfindingProgress
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
- toString() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- toVector() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathVectorfrom the coordinates of this position. - trim(Path, int) - Static method in class de.bsommerfeld.pathetic.engine.result.PathUtils
-
Deprecated.Truncates a path to a maximum number of positions.
V
- ValidationProcessor - Interface in de.bsommerfeld.pathetic.api.pathing.processing
-
A processor that validates whether a node (PathPosition) or the transition to it is permissible during pathfinding.
- validationProcessors - Variable in class de.bsommerfeld.pathetic.engine.pathfinder.AbstractPathfinder
- validationProcessors(List<ValidationProcessor>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- Validators - Class in de.bsommerfeld.pathetic.api.pathing.processing
-
Utility class for creating and combining
ValidationProcessorinstances. - value() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
-
Returns the numerical cost value.
- value() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
-
Returns the current depth value.
- valueOf(String) - Static method in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VERTICAL_AND_HORIZONTAL - Static variable in class de.bsommerfeld.pathetic.api.pathing.NeighborStrategies
-
Just checks adjacent nodes (up, down, left, right, forward, back).
Z
- ZERO - Static variable in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
-
A shared instance for zero cost.
All Classes and Interfaces|All Packages
Cost.value()instead.