Index
All Classes and Interfaces|All Packages
A
- abort() - Method in interface de.bsommerfeld.pathetic.api.pathing.Pathfinder
-
Aborts the running pathfinding process.
- 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(NodeValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
that evaluates totrue
if all of the provided validators evaluate totrue
. - allOf(List<NodeValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
that evaluates totrue
if all of the provided validators evaluate totrue
. - alwaysFalse() - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Returns a
NodeValidationProcessor
that always evaluates tofalse
. - alwaysTrue() - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Returns a
NodeValidationProcessor
that always evaluates totrue
. - anyOf(NodeValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
that evaluates totrue
if any of the provided validators evaluate totrue
. - anyOf(List<NodeValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
that evaluates totrue
if any of the provided validators evaluate totrue
. - areNegativeCostsAllowed() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- async(boolean) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
B
- 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
- calculateCostContribution(NodeEvaluationContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.NodeCostProcessor
-
Calculates the cost contribution of this processor for the transition to the current node (PathPosition).
- 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
- 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.
- create(double, double, double, double, double) - Static method in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
-
Creates a new
HeuristicWeights
instance with the specified weights. - 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.
D
- de.bsommerfeld.pathetic.api.annotation - package de.bsommerfeld.pathetic.api.annotation
- 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.configuration - package de.bsommerfeld.pathetic.api.pathing.configuration
- 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
. - Depth - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents the depth of a pathfinding node or element.
- DIAGONAL - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.Offset
- DIRECT_PATH_WEIGHTS - Static variable in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
-
Provides a set of weights strongly prioritizing the shortest direct path, even if diagonally.
- 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.
- 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
- EnvironmentHeight - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents the height range of an environment with defined minimum and maximum bounds.
- EnvironmentHeight(int, int) - Constructor for class de.bsommerfeld.pathetic.api.wrapper.EnvironmentHeight
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- 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.PathEnvironment
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- equals(Object) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
- Experimental - Annotation Type in de.bsommerfeld.pathetic.api.annotation
-
Marks an API as experimental.
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
PathPosition
s. - floor() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPosition
with the same environment, but 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.NodeEvaluationContext
-
Returns the base traversal cost for the transition from the
previous PathPosition
to thecurrent 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.NodeEvaluationContext
-
Returns the depth of the
current PathPosition
in the search tree. - getCurrentNodeHeuristicValue() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.NodeEvaluationContext
-
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.NodeEvaluationContext
-
Returns the PathPosition currently being evaluated.
- getDepth() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- getDirectionalPenaltyWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
-
Returns the weight applied to the directional penalty component of the heuristic.
- getEnd() - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Returns the target position of the path
- 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.
- getHeightWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
-
Returns the weight applied to the height difference (elevation change) component of the heuristic.
- getHeuristicWeights() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getManhattanWeight() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
-
Returns the weight applied to the Manhattan distance component of the heuristic.
- getMaxHeight() - Method in class de.bsommerfeld.pathetic.api.wrapper.EnvironmentHeight
- getMaxHeight() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathEnvironment
-
Get the max height of this environment.
- getMaxIterations() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getMaxLength() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- getMinHeight() - Method in class de.bsommerfeld.pathetic.api.wrapper.EnvironmentHeight
- getMinHeight() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathEnvironment
-
Get the min height of this environment.
- getName() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathEnvironment
-
Get the name of this environment.
- getNavigationPoint(PathPosition) - Method in interface de.bsommerfeld.pathetic.api.provider.NavigationPointProvider
-
Gets the navigation point at the given position.
- getNavigationPointProvider() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.NodeEvaluationContext
-
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.
- 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.configuration.HeuristicWeights
-
Returns the weight applied to the Octile distance component of the heuristic.
- getOffset() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- 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.NodeEvaluationContext
-
Returns the accumulated G-cost (actual known cost from start) up to the
previous PathPosition
. - getPathEnvironment() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Returns the environment this position belongs to.
- getPathfinderConfiguration() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.NodeEvaluationContext
-
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.
- 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.configuration.HeuristicWeights
-
Returns the weight applied to the perpendicular distance component of the heuristic.
- getPreviousPathPosition() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.NodeEvaluationContext
-
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.NodeEvaluationContext
-
Provides access to the overarching
SearchContext
for this pathfinding operation. - getSharedData() - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.context.NodeEvaluationContext
-
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
Processor
s 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.NodeEvaluationContext
-
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.NodeEvaluationContext
-
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.
- getUuid() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathEnvironment
-
Get the unique identifier of this environment.
- getValue() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
-
Returns the numerical cost value.
- getValue() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
- getVectors() - Method in enum de.bsommerfeld.pathetic.api.pathing.Offset
- 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.
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.HeuristicWeights
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- hashCode() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- 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.PathEnvironment
- hashCode() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
- hashCode() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathVector
- heuristicWeights(HeuristicWeights) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- HeuristicWeights - Class in de.bsommerfeld.pathetic.api.pathing.configuration
-
Represents a set of weights used to calculate a heuristic for the A* pathfinding algorithm.
I
- increment() - Method in class de.bsommerfeld.pathetic.api.wrapper.Depth
-
Increments the depth value by one.
- initialize(Pathfinder, PathfinderConfiguration) - Method in interface de.bsommerfeld.pathetic.api.factory.PathfinderInitializer
-
Initializes the given
Pathfinder
with the givenPathfinderConfiguration
. - initializeSearch(SearchContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.Processor
-
Called once at the beginning of a path search operation.
- INITIALLY_FAILED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Pathing failed to start, typically due to an invalid start or end position.
- interpolate(double) - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Interpolates the positions of this Path to a new Path with the given resolution.
- interpolate(double, double, double) - Static method in class de.bsommerfeld.pathetic.api.util.NumberUtils
-
Interpolates between two values based on the given progress.
- interpolate(PathPosition, double) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Interpolates between this position and another position based on a given progress value.
- isAsync() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- isFallback() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- isInSameBlock(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Checks if this position and another position are within the same block in the environment.
- isTraversable() - Method in interface de.bsommerfeld.pathetic.api.provider.NavigationPoint
-
Returns whether the position is traversable or not.
- isValid(NodeEvaluationContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.processing.NodeValidationProcessor
-
Checks if the current node (PathPosition) (or the transition to it from the previous node) is valid according to the logic of this validator.
J
- join(Path) - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Joins this Path with the given 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_LIMITED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.result.PathState
-
Signifies that the pathfinder reached its length limit
M
- manhattanDistance(PathPosition) - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Calculates the Manhattan distance between this position and another position.
- 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
- MERGED - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.Offset
- mid() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Creates a new
PathPosition
with the same environment, but 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. - mutatePositions(ParameterizedSupplier<PathPosition>) - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Mutates each of the positions in the path with the given consumer
N
- NATURAL_PATH_WEIGHTS - Static variable in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
-
Provides a set of default heuristic weights that may be suitable for natural pathfinding.
- 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.
- negativeCostsAllowed(boolean) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- NodeCostProcessor - Interface in de.bsommerfeld.pathetic.api.pathing.processing
-
A processor that calculates a specific cost contribution for traversing to a node (PathPosition).
- nodeCostProcessors(List<NodeCostProcessor>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- NodeEvaluationContext - Interface in de.bsommerfeld.pathetic.api.pathing.processing.context
-
Provides context for the evaluation of a single node (PathPosition) during a pathfinding search.
- NodeValidationProcessor - 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.
- nodeValidationProcessors(List<NodeValidationProcessor>) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- noneOf(NodeValidationProcessor...) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
that evaluates totrue
if none of the provided validators evaluate totrue
(i.e., all evaluate tofalse
). - noneOf(List<NodeValidationProcessor>) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
that evaluates totrue
if 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
PathVector
by normalizing this vector. - not(NodeValidationProcessor) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Validators
-
Creates a
NodeValidationProcessor
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
-
Calculates the Octile distance between this position and another position.
- of(double) - Static method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
-
Factory method to create a
Cost
instance. - of(int) - Static method in class de.bsommerfeld.pathetic.api.wrapper.Depth
- offset(Offset) - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- Offset - Enum in de.bsommerfeld.pathetic.api.pathing
- onPathfindingStep(PathfindingContext) - Method in interface de.bsommerfeld.pathetic.api.pathing.hook.PathfinderHook
-
Called on each step of the pathfinding process.
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.
- PathEnvironment - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents the environment in which pathfinding operations take place.
- PathEnvironment(UUID, String, Integer, Integer) - Constructor for class de.bsommerfeld.pathetic.api.wrapper.PathEnvironment
-
Constructs a
PathEnvironment
with the specified attributes. - 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(Depth) - Constructor for class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- PathPosition - Class in de.bsommerfeld.pathetic.api.wrapper
-
Represents a position within a
PathEnvironment
. - PathPosition(PathEnvironment, double, double, double) - Constructor for class de.bsommerfeld.pathetic.api.wrapper.PathPosition
-
Constructs a
PathPosition
with the specified environment and 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. - 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
-
Registers a
PathfinderHook
that will be called on every step of the pathfinding process.
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 environment and 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 environment and 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 environment and 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. - simplify(double) - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Simplifies the path by removing intermediate positions based on the given epsilon value.
- 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.
- 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
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.HeuristicWeights
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration.PathfinderConfigurationBuilder
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.configuration.PathfinderConfiguration
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.hook.PathfindingContext
- toString() - Method in class de.bsommerfeld.pathetic.api.pathing.processing.Cost
- toString() - Method in class de.bsommerfeld.pathetic.api.wrapper.PathEnvironment
- 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. - trim(int) - Method in interface de.bsommerfeld.pathetic.api.pathing.result.Path
-
Trims this Path to the given length.
V
- Validators - Class in de.bsommerfeld.pathetic.api.pathing.processing
-
Utility class for creating and combining
NodeValidationProcessor
instances. - valueOf(String) - Static method in enum de.bsommerfeld.pathetic.api.pathing.Offset
-
Returns the enum constant of this type with the specified name.
- 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.Offset
-
Returns an array containing the constants of this enum type, in the order they are declared.
- 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 - Enum constant in enum de.bsommerfeld.pathetic.api.pathing.Offset
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