agi.foundation.geometry.shapes

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

Class EnclosureDescription

java.lang.Object

agi.foundation.geometry.shapes.EnclosureDescription

public class EnclosureDescription
extends Object

Describes an enclosure, as returned by Solid.getEnclosureDescriptions().

Constructor Summary

Constructors

Constructor and Description
EnclosureDescription(RealValuedScalarFunction1<Cartesian> function, EnclosureFunctionType functionType) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
RealValuedScalarFunction1<Cartesian>	getFunction() Gets the enclosure function.
EnclosureFunctionType	getFunctionType() Gets the type of value returned by the Function (get).

Methods inherited from class java.lang.Object

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

Constructor Detail

EnclosureDescription

public EnclosureDescription(@Nonnull
                            RealValuedScalarFunction1<Cartesian> function,
                            @Nonnull
                            EnclosureFunctionType functionType)

Initializes a new instance.

Parameters:

function - The enclosure function. If all enclosure functions return a value greater than 0.0 for a given position, then that position is inside the volume.

functionType - The type of value returned by the function.

Throws:

ArgumentNullException - Thrown when function is null.

Method Detail

getFunction

@Nonnull
public final RealValuedScalarFunction1<Cartesian> getFunction()

Gets the enclosure function. If all enclosure functions return a value greater than 0.0 for a given position, then that position is inside the volume.

getFunctionType

@Nonnull
public final EnclosureFunctionType getFunctionType()

Gets the type of value returned by the Function (get).