You are here: Start » Function Reference » Surface » Surface Basics » ProjectSurfaceOntoAxesPlane

ProjectSurfaceOntoAxesPlane

Header:	AVL.h
Namespace:	avl
Module:	Vision3DStandard

Projects a surface onto one of three axes planes.

Syntax

void avl::ProjectSurfaceOntoAxesPlane
(
	const avl::Surface& inSurface,
	avl::PlaneType::Type inAxesPlaneType,
	atl::Optional<double> inOutputXScale,
	const avl::ValueLimits_f64& inOutputXLimits,
	atl::Optional<double> inOutputYScale,
	const avl::ValueLimits_f64& inOutputYLimits,
	const double inOutputZOffset,
	atl::Optional<double> inOutputZScale,
	const avl::ValueLimits_f64& inOutputZLimits,
	avl::PlainType::Type inPointType,
	avl::SurfaceMultipointHeight::Type inMultipointHeight,
	avl::Surface& outSurface,
	atl::Optional<double&> outMinOutputX = atl::NIL,
	atl::Optional<double&> outMinOutputY = atl::NIL,
	avl::Region& diagSurfaceValidPointsRegion
)

Parameters

Name	Type	Range	Default	Description
inSurface	const Surface&
inAxesPlaneType	PlaneType::Type		XZ
inOutputXScale	Optional<double>	0.000001 -	1.0D
inOutputXLimits	const ValueLimits_f64&
inOutputYScale	Optional<double>	0.000001 -	1.0D
inOutputYLimits	const ValueLimits_f64&
inOutputZOffset	const double
inOutputZScale	Optional<double>	0.000001 -	1.0D
inOutputZLimits	const ValueLimits_f64&
inPointType	PlainType::Type		Int16	Type of single point Z coordinate
inMultipointHeight	SurfaceMultipointHeight::Type		Mean	Determines the Z coordinate of a surface point created from more than one point
outSurface	Surface&
outMinOutputX	Optional<double&>		NIL
outMinOutputY	Optional<double&>		NIL
diagSurfaceValidPointsRegion	Region&			Region of locations where the surface points are valid

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outMinOutputX, outMinOutputY.