Index (Pathetic-API 5.4.5 API)

A B C D E F G H I L M N O P R S T V Z
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
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 PathPosition by adding the given values to the coordinates of this position.
add(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition: Creates a new PathPosition by 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 PathVector by adding another vector to this vector.
allOf(ValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Creates a ValidationProcessor that evaluates to true if all of the provided validators evaluate to true.
allOf(List<ValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Creates a ValidationProcessor that evaluates to true if all of the provided validators evaluate to true.
alwaysFalse() - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Returns a ValidationProcessor that always evaluates to false.
alwaysTrue() - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Returns a ValidationProcessor that always evaluates to true.
anyOf(ValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Creates a ValidationProcessor that evaluates to true if any of the provided validators evaluate to true.
anyOf(List<ValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Creates a ValidationProcessor that evaluates to true if any of the provided validators evaluate to true.
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
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.
computeDistance(PathVector, PathVector, PathVector) - Static method in class de.bsommerfeld.pathetic.api.wrapper.PathVector: Computes the distance between a point and a line segment.
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).
create(double, double, double, double) - Static method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights: Creates a new HeuristicWeights instance with the specified weights.
createPathfinder() - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderFactory: Creates a new instance of a Pathfinder with a default PathfinderConfiguration.
createPathfinder(PathfinderConfiguration) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderFactory: Creates a new Pathfinder instance with the given configuration.
createPathfinder(PathfinderConfiguration, PathfinderInitializer) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderFactory: Creates a new Pathfinder instance with the given configuration and initializer.
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
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 PathVector by dividing this vector by a scalar value.
dot(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector: Calculates the dot product of this vector and another vector.

E

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
EvaluationContext - Interface in de.bsommerfeld.pathetic.api.pathing.processing.context: Provides context for the evaluation of a single node (PathPosition) during a pathfinding search.
exceptionally(Consumer<Throwable>) - Method in interface de.bsommerfeld.pathetic.api.pathing.PathfindingSearch: Executes the given callback if the pathfinding operation results in an exception.

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.
floor() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition: Creates a new PathPosition with the coordinates floored to the nearest integer values.
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 PathPosition to the current PathPosition.
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 PathPosition in the search tree.
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 PathPosition towards the target.
getCurrentPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext: Returns the PathPosition currently being evaluated.
getDepth() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext: The current depth of the pathfinding step.
getEnd() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path: Returns the target position of the path
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.
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.
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.
getHeuristicStrategy() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
getHeuristicWeights() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
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.
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.
getPath() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult: Returns the found Path regardless if successful or not.
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.
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.
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.
getPerpendicularWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicWeights: Returns the weight applied to the perpendicular distance component of the heuristic.
getPreviousPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.EvaluationContext: Returns the PathPosition from which the current PathPosition is being reached.
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 SearchContext for this pathfinding operation.
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.
getStart() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path: Returns the start position of the path
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.
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.
getValue() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost: Deprecated.
Use Cost.value() instead.
getValue() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth: Deprecated.
Depth.value()
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.
hasFallenBack() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult: Whether a pathfinder has resulted in a fallback.
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
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 Iterable consisting of PathVectors.
initialize(Pathfinder, PathfinderConfiguration) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderInitializer: Initializes the given Pathfinder with the given PathfinderConfiguration.
initializeSearch(SearchContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.Processor: Called once at the beginning of a path search operation.
interpolate(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.util.NumberUtils: Interpolates between two values based on the given progress.
isAsync() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
isFallback() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
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.

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_LIMITED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState: Signifies that the pathfinder reached its length limit
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
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 PathPosition with 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.
multiply(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector: Creates a new PathVector by multiplying this vector by a scalar value.

N

NavigationPoint - Interface in de.bsommerfeld.pathetic.api.provider: Represents information about a position in the pathfinding environment.
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(INeighborStrategy) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
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 ValidationProcessor that evaluates to true if none of the provided validators evaluate to true (i.e., all evaluate to false).
noneOf(List<ValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Creates a ValidationProcessor that evaluates to true if none of the provided validators evaluate to true (i.e., all evaluate to false).
normalize() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector: Creates a new PathVector by normalizing this vector.
not(ValidationProcessor) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators: Creates a ValidationProcessor that 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 Cost instance.
of(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition: Creates a new PathPosition instance with the specified coordinates.
of(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.wrapper.PathVector: Creates a new PathVector instance with the specified components.
of(int) - Static method in class de.bsommerfeld.pathetic.api.wrapper.Depth: Creates a new Depth instance 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

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.
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 - 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 Pathfinder instances.
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 Pathfinder instances.
PathfinderResult - Interface in de.bsommerfeld.pathetic.api.pathing.result: The result of a pathfinding operation.
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.
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 PathPosition with the specified coordinates.
PathState - Enum in de.bsommerfeld.pathetic.api.pathing.result: The state of a finished pathfinding process.
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 PathVector with the specified x, y, and z components.
position() - Method in class de.bsommerfeld.pathetic.api.pathing.heuristic.HeuristicContext: The current to-evaluate position.
Processor - Interface in de.bsommerfeld.pathetic.api.pathing.processing: Base interface for pathfinding processors.
provider(NavigationPointProvider) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

R

registerPathfindingHook(PathfinderHook) - Method in interface de.bsommerfeld.pathetic.api.pathing.Pathfinder: Deprecated.
Use PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks(java.util.List) to configure hooks in the PathfinderConfiguration instead.
reopenClosedNodes(boolean) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder

S

SearchContext - Interface in de.bsommerfeld.pathetic.api.pathing.processing.context: Provides context for an entire pathfinding search operation.
setX(double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition: Creates a new PathPosition with 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 PathVector with 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 PathPosition with 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 PathVector with 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 PathPosition with 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 PathVector with 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
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 PathPosition by subtracting the given values from the coordinates of this position.
subtract(PathVector) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition: Creates a new PathPosition by 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 PathVector by subtracting another vector from this vector.
successful() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.PathfinderResult: Returns whether the pathfinding was successful.

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 PathVector from the coordinates of this position.

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(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 ValidationProcessor instances.
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.

A B C D E F G H I L M N O P R S T V Z
All Classes and Interfaces|All Packages