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

ArrangePoint3DGrid

Header:	FIL.h
Namespace:	fil

Creates a surface structure from Point3DGrid taking into account X and Y coordinates.

Syntax

void fil::ArrangePoint3DGrid
(
	const fil::Point3DGrid& inPoint3DGrid,
	ftl::Optional<double> inMinX,
	ftl::Optional<double> inMaxX,
	ftl::Optional<double> inMinY,
	ftl::Optional<double> inMaxY,
	const double inZOffset,
	const double inZScale,
	const fil::PlainType::Type& inPointType,
	fil::Surface& outSurface,
	ftl::Optional<double&> outMinX = ftl::NIL,
	ftl::Optional<double&> outMinY = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inPoint3DGrid	const Point3DGrid&
inMinX	Optional<double>		NIL
inMaxX	Optional<double>		NIL
inMinY	Optional<double>		NIL
inMaxY	Optional<double>		NIL
inZOffset	const double
inZScale	const double	0.000001 -	1.0D
inPointType	const PlainType::Type&		Int16	Type of single point Z coordinate
outSurface	Surface&
outMinX	Optional<double&>		NIL
outMinY	Optional<double&>		NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outSurface, outMinX, outMinY.

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty point array in ArrangePoint3DGrid.
DomainError	Incorrect coordinate limits in ArrangePoint3DGrid.
DomainError	Surface dimensions too big in ArrangePoint3DGrid.