You are here: Start » AVL.NET » Function Reference » Surface » Surface Features » AVL.SurfaceSingleProfileAlongAxis

AVL.SurfaceSingleProfileAlongAxis

Creates the profile of point Z values along X or Y axis.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void SurfaceSingleProfileAlongAxis
(
	AvlNet.Surface inSurface,
	AvlNet.Axis inAxis,
	double inCoordinateValue,
	int inSmoothRadius,
	double? inProfileDomainStart,
	double? inProfileDomainEnd,
	int? inMaxInterpolationLength,
	float inDefaultValue,
	AvlNet.Profile outProfile,
	out double outCoordinateValue
)

Parameters

Name Type Range Default Description
inSurfaceAvlNet.SurfaceInput surface.
inAxisAvlNet.AxisAxis along which the profile is extracted.
inCoordinateValuedoubleDetermines the coordinate the profile will be extracted from.
inSmoothRadiusint<0, INF>Increases the number of neighbouring profiles taken into account extracting a profile.
inProfileDomainStartdouble?Minimal X coordinate of the output profile. Default value: atl::NIL.
inProfileDomainEnddouble?Maximal X coordinate of the output profile. Default value: atl::NIL.
inMaxInterpolationLengthint?<0, INF>Maximal number of consecutive not existing profile points to be interpolated. Default value: atl::NIL.
inDefaultValuefloatDefault value of the not existing and not interpolated surface point.
outProfileAvlNet.ProfileThe resulting profile of the surface height.
outCoordinateValuedoubleThe coordinate the output profile was extracted from.

Errors

List of possible exceptions:

Error type Description
DomainError Incorrect output profile domain in SurfaceSingleProfileAlongAxis.
DomainError Input coordinate value exceeds surface in SurfaceSingleProfileAlongAxis.
DomainError Unknown axis type in SurfaceSingleProfileAlongAxis.

Function Overrides

See also