SRM

Class BaseSRF_WithTangentPlaneSurface

java.lang.Object

SRM.BaseSRF

SRM.BaseSRF_3D

SRM.BaseSRF_WithTangentPlaneSurface

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

SRF_LocalTangentSpaceAzimuthalSpherical, SRF_LocalTangentSpaceCylindrical, SRF_LocalTangentSpaceEuclidean

public abstract class BaseSRF_WithTangentPlaneSurface
extends BaseSRF_3D

The BaseSRF_WithTangentPlaneSurface abstract class.

Author:

David Shen

See Also:

BaseSRF_3D, BaseSRF

Field Summary

Fields inherited from class SRM.BaseSRF_3D

_component_is_angular, _component_valid_region

Fields inherited from class SRM.BaseSRF

_internalSRFs, _myCsCode, _myOpSeq, _mySrftCode, _orm, _rt

Constructor Summary

Constructors

Constructor and Description
BaseSRF_WithTangentPlaneSurface()

Method Summary

Methods

Modifier and Type	Method and Description
abstract CoordSurf	createSurfaceCoordinate() Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].
abstract CoordSurf	createSurfaceCoordinate(double coord_surf_comp1, double coord_surf_comp2) Creates a surface coordinate object with initial values.
abstract CoordSurf	getAssociatedSurfaceCoordinate(Coord3D coord) Returns a surface coordinate associated with a 3D coordinate.
abstract Coord3D	getPromotedSurfaceCoordinate(CoordSurf surf_coord) Returns a 3D coordinate representing the same location as specified by a surface coordinate.
double[]	getSurfaceCoordinateValues(CoordSurf coord_surf) Retrieves a coordinate surface component values

Methods inherited from class SRM.BaseSRF_3D

calculateEuclideanDistance, changeCoordinate3DArraySRF, changeCoordinate3DArraySRFObject, changeCoordinate3DSRF, changeCoordinate3DSRFObject, changeDirectionArraySRF, changeDirectionArraySRFObject, changeDirectionSRF, changeDirectionSRFObject, checkDirection, comp_ori_mat, compLTP, computeSRFOrientation, createCoordinate3D, createCoordinate3D, createDirection, createDirection, createLococentricEuclidean3DSRF, getCoordinate3DValues, getDirectionValues, getExtendedValidRegion, getLocalTangentFrameSRFParameters, getMemberCode, getNaturalSRFSetMember, getNaturalSRFSetMemberCode, getValidRegion, setExtendedValidRegion, setValidRegion, transformOrientation, transformOrientationCommonOrigin, transformVector, transformVectorCommonOrigin, transformVectorInBodyFrame, transformVectorInBodyFrameCommonOrigin

Methods inherited from class SRM.BaseSRF

calculateEuclideanDistance, changeCoordinateSRF, checkCoordinate, createSRFSetMember, createStandardSRF, get_orm, get_rt, getA, getCSCode, getF, getImplVerInfo, getOrm, getRt, getSRFCode, getSRFSetCode, getSRFSetMemberCode, getSRFTemplateCode, interimConv, isEqual, makeClone, querySRFTSupport, setSrfCode, setSrfSetCode, setSrfSetMemberCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSRF_WithTangentPlaneSurface

public BaseSRF_WithTangentPlaneSurface()

Method Detail

createSurfaceCoordinate

public abstract CoordSurf createSurfaceCoordinate()

Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].

Returns:

a surface coordinate object

createSurfaceCoordinate

public abstract CoordSurf createSurfaceCoordinate(double coord_surf_comp1,
                                double coord_surf_comp2)

Creates a surface coordinate object with initial values.

Parameters:

coord_surf_comp1 - in: the values of the first component of the surface coordinate

coord_surf_comp2 - in: the values of the second component of the surface coordinate

Returns:

a surface coordinate object

getSurfaceCoordinateValues

public double[] getSurfaceCoordinateValues(CoordSurf coord_surf)
                                    throws SrmException

Retrieves a coordinate surface component values

Parameters:

coord_surf - in: a surface coordinate

Returns:

an array of size 2 containing the component values for the surface coordinate

Throws:

SrmException

getAssociatedSurfaceCoordinate

public abstract CoordSurf getAssociatedSurfaceCoordinate(Coord3D coord)
                                                  throws SrmException

Returns a surface coordinate associated with a 3D coordinate.

Parameters:

coord - in: a 3D coordinate in this SRF

Returns:

a surface coordinate object in this SRF

Throws:

SrmException

getPromotedSurfaceCoordinate

public abstract Coord3D getPromotedSurfaceCoordinate(CoordSurf surf_coord)
                                              throws SrmException

Returns a 3D coordinate representing the same location as specified by a surface coordinate.

Parameters:

surf_coord - in: a surface coordinate in this SRF

Returns:

a 3D coordinate object in this SRF

Throws:

SrmException