Module org.arakhne.afc.core.mathgeom

Package org.arakhne.afc.math.geometry

Interface GeomFactoryBase

All Known Subinterfaces:

GeomFactory1afp<P,V,S,B>, GeomFactory1D<V,P>, GeomFactory2afp<E,P,V,B>, GeomFactory2ai<E,P,V,B>, GeomFactory2D<V,P>, GeomFactory3afp<E,P,V,B>, GeomFactory3ai<E,P,V,B>, GeomFactory3D<V,P>

All Known Implementing Classes:

AbstractGeomFactory1D, AbstractGeomFactory2D, AbstractGeomFactory3D, AbstractGeomFactoryBase, GeomFactory1d, GeomFactory1dfx, GeomFactory2d, GeomFactory2dfx, GeomFactory2i, GeomFactory2ifx, GeomFactory3d, GeomFactory3dfx, GeomFactory3i, GeomFactory3ifx, ImmutableGeomFactory, ImmutableGeomFactory, ImmutableGeomFactory3D, InnerComputationGeomFactory, InnerComputationGeomFactory, InnerComputationGeomFactory, InnerComputationGeomFactory, InnerComputationGeomFactory3afp

public interface GeomFactoryBase

Factory of geometrical primitives.

Since:

14.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Method Summary

Modifier and Type	Method	Description
double	getSplineApproximationRatio()	The maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve.
void	setSplineApproximationRatio(Double distance)	Change the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve.

Method Detail

getSplineApproximationRatio

@Pure
double getSplineApproximationRatio()

The maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve.

The replied value is one of:

• the ratio specifically defined within this factory, by a call to setSplineApproximationRatio(Double).
• the global ratio (shared among all the factories) replied by AbstractGeomFactoryBase.getGlobalSplineApproximationRatio() and defined by a call to AbstractGeomFactoryBase.setGlobalSplineApproximationRatio(Double).
• the value defined by GeomConstants.SPLINE_APPROXIMATION_RATIO.

.

Returns:

the maximal distance for approximating curves with segments.

Since:

14.0

setSplineApproximationRatio

void setSplineApproximationRatio(Double distance)

Change the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve.

This function changes the ratio defined within the current factory. The other factories and the global value are not changed. For changing the global value, you must call AbstractGeomFactoryBase.setGlobalSplineApproximationRatio(Double).

Parameters:

distance - the maximal distance for approximating curves with segments. If the argument value is null or NaN, the global definition of the ratio is used by this factory.

Since:

14.0