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

FIL.SurfaceMultipleProfilesAlongAxis

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

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

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

Parameters

Name Type Range Default Description
inSurfaceFilNet.SurfaceInput surface.
inAxisFilNet.AxisAxis along which the profile is extracted.
inCoordinateValueStartdouble?Determines the coordinate the first profile will be extracted from. Default value: ftl::NIL.
inCoordinateValueEnddouble?Limits the coordinate the last profile will be extracted from. Default value: ftl::NIL.
inCoordinateValueStepdouble?<0, INF>Determines the distance between consecutive extracted profiles. Default value: ftl::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: ftl::NIL.
inProfileDomainEnddouble?Maximal X coordinate of the output profiles. Default value: ftl::NIL.
inMaxInterpolationLengthint?<0, INF>Maximal number of consecutive not existing profile points to be interpolated. Default value: ftl::NIL.
inDefaultValuefloatDefault value of the not existing and not interpolated surface point.
outProfilesSystem.Collections.Generic.IList<FilNet.Profile>The resulting profiles of the surface height.
outCoordinateValuesFilNet.NullableRef<System.Collections.Generic.List<double>>The coordinates the output profiles were extracted from. Can be null to skip this parameter calculation.

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