Package de.bsommerfeld.pathetic.api.factory

Interface PathfinderFactory

All Known Implementing Classes:

AStarPathfinderFactory

public interface PathfinderFactory

A factory interface for creating Pathfinder instances.

Method Summary

Modifier and Type	Method	Description
Pathfinder	createPathfinder()	Deprecated. Use createPathfinder(PathfinderConfiguration) with an explicit configuration that supplies a real NavigationPointProvider.
Pathfinder	createPathfinder(PathfinderConfiguration configuration)	Creates a new Pathfinder instance with the given configuration.
default Pathfinder	createPathfinder(PathfinderConfiguration configuration, PathfinderInitializer initializer)	Creates a new Pathfinder instance with the given configuration and initializer.

Method Details

createPathfinder

@Deprecated
Pathfinder createPathfinder()

Deprecated.

Use createPathfinder(PathfinderConfiguration) with an explicit configuration that supplies a real NavigationPointProvider. Calling this no-arg overload almost always indicates a misconfiguration.

Creates a new instance of a Pathfinder with a default PathfinderConfiguration.

The resulting pathfinder uses the builder defaults, including a NavigationPointProvider that reports every position as traversable. The returned pathfinder will therefore route through walls, obstacles, and otherwise non-traversable terrain. This is only useful for ad-hoc smoke tests and never for production use.

Returns:

A new Pathfinder instance configured with builder defaults.

createPathfinder

Pathfinder createPathfinder(PathfinderConfiguration configuration)

Creates a new Pathfinder instance with the given configuration.

Parameters:

configuration - The configuration for the pathfinder.

Returns:

A new Pathfinder instance.

createPathfinder

default Pathfinder createPathfinder(PathfinderConfiguration configuration,
 PathfinderInitializer initializer)

Creates a new Pathfinder instance with the given configuration and initializer. This method first creates a pathfinder using the createPathfinder(PathfinderConfiguration) method and then initializes it using the provided PathfinderInitializer.

Parameters:

configuration - The configuration for the pathfinder.

initializer - The initializer to use for initializing the pathfinder.

Returns:

A new, initialized Pathfinder instance.