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

AVL.SurfaceMultipleProfilesAlongAxis

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void SurfaceMultipleProfilesAlongAxis
(
	AvlNet.Surface inSurface,
	AvlNet.Axis inAxis,
	double? inCoordinateValueStart,
	double? inCoordinateValueEnd,
	double? inCoordinateValueStep,
	int inSmoothRadius,
	double? inProfileDomainStart,
	double? inProfileDomainEnd,
	int? inMaxInterpolationLength,
	float inDefaultValue,
	IList<AvlNet.Profile> outProfiles
)

Parameters

Name Type Range Default Description
inSurfaceAvlNet.SurfaceInput surface.
inAxisAvlNet.AxisAxis along which the profile is extracted.
inCoordinateValueStartdouble?Determines the coordinate the first profile will be extracted from. Default value: atl::NIL.
inCoordinateValueEnddouble?Limits the coordinate the last profile will be extracted from. Default value: atl::NIL.
inCoordinateValueStepdouble?<0, INF>Determines the distance between consecutive extracted profiles. Default value: atl::NIL.
inSmoothRadiusint<0, INF>Increases the number of neighbouring profiles taken into account extracting a single profile.
inProfileDomainStartdouble?Minimal X coordinate of the output profiles. Default value: atl::NIL.
inProfileDomainEnddouble?Maximal X coordinate of the output profiles. 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.
outProfilesSystem.Collections.Generic.IList<AvlNet.Profile>The resulting profiles of the surface height.

Errors

List of possible exceptions:

Error type Description
DomainError Coordinate value range exceeds input surface in SurfaceMultipleProfilesAlongAxis.
DomainError Incorrect output profile domain in SurfaceMultipleProfilesAlongAxis.
DomainError Non-positive coordinate value step in SurfaceMultipleProfilesAlongAxis.
DomainError Unknown axis type in SurfaceMultipleProfilesAlongAxis.

Function Overrides

See also