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

ProjectSurfaceOntoAxesPlane

Header:	FIL.h
Namespace:	fil
Module:	Vision3DStandard

Projects a surface onto one of three axes planes.

Syntax

void fil::ProjectSurfaceOntoAxesPlane
(
	const fil::Surface& inSurface,
	fil::PlaneType::Type inAxesPlaneType,
	ftl::Optional<double> inOutputXScale,
	const fil::ValueLimits_f64& inOutputXLimits,
	ftl::Optional<double> inOutputYScale,
	const fil::ValueLimits_f64& inOutputYLimits,
	const double inOutputZOffset,
	ftl::Optional<double> inOutputZScale,
	const fil::ValueLimits_f64& inOutputZLimits,
	fil::PlainType::Type inPointType,
	fil::SurfaceMultipointHeight::Type inMultipointHeight,
	fil::Surface& outSurface,
	ftl::Optional<double&> outMinOutputX = ftl::NIL,
	ftl::Optional<double&> outMinOutputY = ftl::NIL,
	fil::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 ftl::NIL to these parameters: outMinOutputX, outMinOutputY.