MappingProjectionParameters Class Reference

#include <MappingProjectionParameters.h>

Public Types
enum	IntegerArrayName { subSurfaceIndex =0, ignoreThisSubSurface =1, elementIndex =2, numberOfIntegerArrayParameters =3 }
enum	RealArrayName {   r =0, x =1, xr =2, normal =3,   numberOfRealArrayParameters =4 }

Public Member Functions
	MappingProjectionParameters ()
	~MappingProjectionParameters ()
MappingProjectionParameters &	operator= (const MappingProjectionParameters &x)
int	setIsAMarchingAlgorithm (const bool &trueOrFalse=true)
bool	isAMarchingAlgorithm () const
int	setAdjustForCornersWhenMarching (const bool &trueOrFalse=true)
bool	adjustForCornersWhenMarching ()
int	setOnlyChangePointsAdjustedForCornersWhenMarching (const bool &trueOrFalse=true)
bool	onlyChangePointsAdjustedForCornersWhenMarching ()
int	setMatchNormals (const bool &trueOrFalse=true)
	If on a corner, choose the normal which best matches the input normal.
bool	getMatchNormals () const
int	setProjectOntoReferenceSurface (const bool &trueOrFalse=true)
bool	projectOntoReferenceSurface () const
int	reset ()
int	setSearchBoundingBoxSize (real estimated, real maximumAllowed=0.)
IntegerDistributedArray &	getIntArray (const IntegerArrayName &name)
	Return an array that represents some integer parameter.
RealDistributedArray &	getRealArray (const RealArrayName &name)
	Return an array that represents some real parameter.

Public Attributes
real	searchBoundingBoxSize
real	searchBoundingBoxMaximumSize

Member Enumeration Documentation

enum MappingProjectionParameters::IntegerArrayName

Enumerator
subSurfaceIndex
ignoreThisSubSurface
elementIndex
numberOfIntegerArrayParameters

enum MappingProjectionParameters::RealArrayName

Enumerator
r
x
xr
normal
numberOfRealArrayParameters

Constructor & Destructor Documentation

MappingProjectionParameters::MappingProjectionParameters

(

)

References NULL, numberOfIntegerArrayParameters, numberOfRealArrayParameters, searchBoundingBoxMaximumSize, and searchBoundingBoxSize.

MappingProjectionParameters::~MappingProjectionParameters

(

)

References numberOfIntegerArrayParameters, and numberOfRealArrayParameters.

Member Function Documentation

bool MappingProjectionParameters::adjustForCornersWhenMarching ( )

inline

Referenced by HyperbolicMapping::buildSurfaceGridParametersDialog(), and UnstructuredMapping::project().

IntegerDistributedArray & MappingProjectionParameters::getIntArray

(

const IntegerArrayName &

name

)

Return an array that represents some integer parameter.

Parameters

subSurfaceIndex(i)	: number of the sub-surface of a CompositeSurface that a point lies on.
ignoreThisSubSurface(i)	: indicate that point i should ignore this sub-surface
elementIndex(i)	: the element index if projecting onto a triangulation (or a CompositeSurface with a triangulation).

References NULL.

Referenced by UnstructuredMapping::buildFromACompositeSurface(), MappingBuilder::buildSurfacePatch(), closerSurfaceFound(), UnstructuredMapping::computeConnection(), AdvancingFront::computeFaceNormal(), AdvancingFront::computeSurfaceNormal(), HyperbolicMapping::correctProjectionOfInitialCurve(), HyperbolicMapping::createCurveOnSurface(), HyperbolicMapping::matchToCurve(), CompositeSurface::project(), UnstructuredMapping::project(), HyperbolicMapping::project(), CompositeTopology::update(), GridStretcher::update(), CompositeSurface::update(), HyperbolicMapping::update(), and UnstructuredMapping::update().

bool MappingProjectionParameters::getMatchNormals ( ) const

inline

Referenced by CompositeSurface::project().

RealDistributedArray & MappingProjectionParameters::getRealArray

(

const RealArrayName &

name

)

Return an array that represents some real parameter.

Parameters

r	:
x	:
xr	:
normal	:

References NULL.

Referenced by AdvancingFront::advanceFront(), GridSmoother::applyBoundaryConditions(), UnstructuredMapping::buildFromACompositeSurface(), InterpolatePoints::buildInterpolationInfo(), InterpolatePointsOnAGrid::buildInterpolationInfo(), closerSurfaceFound(), UnstructuredMapping::computeConnection(), computeDeviation(), AdvancingFront::computeFaceNormal(), AdvancingFront::computeSurfaceNormal(), HyperbolicMapping::correctProjectionOfInitialCurve(), HyperbolicMapping::createCurveOnSurface(), evaluateDeviation(), HyperbolicMapping::getNormalAndSurfaceArea(), HyperbolicMapping::matchToCurve(), CompositeSurface::project(), UnstructuredMapping::project(), Mapping::project(), HyperbolicMapping::project(), HyperbolicMapping::projectNormalsToMatchCurve(), refineCurve(), and HyperbolicMapping::update().

bool MappingProjectionParameters::isAMarchingAlgorithm

(

)

const

bool MappingProjectionParameters::onlyChangePointsAdjustedForCornersWhenMarching ( )

inline

Referenced by UnstructuredMapping::project().

MappingProjectionParameters & MappingProjectionParameters::operator=

(

const MappingProjectionParameters &

x

)

References NULL, numberOfIntegerArrayParameters, numberOfRealArrayParameters, searchBoundingBoxMaximumSize, and searchBoundingBoxSize.

bool MappingProjectionParameters::projectOntoReferenceSurface ( ) const

inline

Referenced by CompositeSurface::project().

int MappingProjectionParameters::reset

(

)

References NULL, numberOfIntegerArrayParameters, and numberOfRealArrayParameters.

Referenced by GridSmoother::applyBoundaryConditions(), HyperbolicMapping::matchToCurve(), and HyperbolicMapping::project().

int MappingProjectionParameters::setAdjustForCornersWhenMarching

(

const bool &

trueOrFalse = true

)

Referenced by GridSmoother::GridSmoother(), HyperbolicMapping::matchToCurve(), and GridStretcher::update().

int MappingProjectionParameters::setIsAMarchingAlgorithm

(

const bool &

trueOrFalse = true

)

Referenced by GridSmoother::applyBoundaryConditions(), MappingBuilder::buildSurfacePatch(), GridSmoother::GridSmoother(), and GridStretcher::update().

int MappingProjectionParameters::setMatchNormals

(

const bool &

trueOrFalse = true

)

If on a corner, choose the normal which best matches the input normal.

int MappingProjectionParameters::setOnlyChangePointsAdjustedForCornersWhenMarching

(

const bool &

trueOrFalse = true

)

Referenced by HyperbolicMapping::project().

int MappingProjectionParameters::setProjectOntoReferenceSurface

(

const bool &

trueOrFalse = true

)

Referenced by HyperbolicMapping::matchToCurve().

int MappingProjectionParameters::setSearchBoundingBoxSize	(	real	estimated,
		real	maximumAllowed = 0.
	)

References searchBoundingBoxMaximumSize, and searchBoundingBoxSize.

Referenced by UnstructuredMapping::buildFromACompositeSurface().

Member Data Documentation

real MappingProjectionParameters::searchBoundingBoxMaximumSize

Referenced by MappingProjectionParameters(), operator=(), UnstructuredMapping::project(), and setSearchBoundingBoxSize().

real MappingProjectionParameters::searchBoundingBoxSize

Referenced by MappingProjectionParameters(), operator=(), UnstructuredMapping::project(), and setSearchBoundingBoxSize().

---

The documentation for this class was generated from the following files:

• MappingProjectionParameters.h
• MappingProjectionParameters.C