agi.foundation.geometry

(agi.foundation.core-2024r3.jar)

Class AxesHelper

java.lang.Object

agi.foundation.geometry.AxesHelper

public final class AxesHelper
extends Object

A collection of helper methods for working with Axes and related types.

Method Summary

Modifier and Type	Method and Description
static Axes	getAxes(IServiceProvider provider) Gets the Axes from the IOrientationAxesService provided by an object.
static Axes	getAxes(IServiceProvider provider, String exceptionMessage) Gets the Axes from the IOrientationAxesService provided by an object.
static IOrientationAxesService	getOptionalOrientationAxesService(IServiceProvider provider) Gets the IOrientationAxesService provided by an object, or null if the service does not exist.
static IOrientationAxesService	getOrientationAxesService(IServiceProvider provider) Gets the IOrientationAxesService provided by an object.
static IOrientationAxesService	getOrientationAxesService(IServiceProvider provider, String exceptionMessage) Gets the IOrientationAxesService provided by an object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOrientationAxesService

@Nonnull
public static IOrientationAxesService getOrientationAxesService(@Nonnull
                                                                          IServiceProvider provider)

Gets the IOrientationAxesService provided by an object.

Parameters:

provider - The object from which to obtain the service.

Returns:

The service provided by the object.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IOrientationAxesService.

getOrientationAxesService

@Nonnull
public static IOrientationAxesService getOrientationAxesService(@Nonnull
                                                                          IServiceProvider provider,
                                                                          String exceptionMessage)

Gets the IOrientationAxesService provided by an object.

Parameters:

provider - The object from which to obtain the service.

exceptionMessage - An error message to include in the exception if the service is unavailable.

Returns:

The service provided by the object.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IOrientationAxesService.

getOptionalOrientationAxesService

@Nullable
public static IOrientationAxesService getOptionalOrientationAxesService(@Nonnull
                                                                                   IServiceProvider provider)

Gets the IOrientationAxesService provided by an object, or null if the service does not exist.

Parameters:

provider - The object from which to obtain the service.

Returns:

The service provided by the object, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when provider is null.

getAxes

public static Axes getAxes(@Nonnull
                           IServiceProvider provider)

Gets the Axes from the IOrientationAxesService provided by an object.

Parameters:

provider - The object from which to obtain the IOrientationAxesService service.

Returns:

The Axes from the IOrientationAxesService.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IOrientationAxesService.

getAxes

public static Axes getAxes(@Nonnull
                           IServiceProvider provider,
                           String exceptionMessage)

Gets the Axes from the IOrientationAxesService provided by an object.

Parameters:

provider - The object from which to obtain the IOrientationAxesService service.

exceptionMessage - An error message to include in the exception if the IOrientationAxesService service is unavailable.

Returns:

The Axes from the IOrientationAxesService.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IOrientationAxesService.