You are here: Start » AVL.NET » Function Reference » Surface » Surface Features » 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, NullableRef<List<double>> outCoordinateValues )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSurface | AvlNet.Surface | Input surface. | |||
inAxis | AvlNet.Axis | Axis along which the profile is extracted. | |||
inCoordinateValueStart | double? | Determines the coordinate the first profile will be extracted from. Default value: atl::NIL. | |||
inCoordinateValueEnd | double? | Limits the coordinate the last profile will be extracted from. Default value: atl::NIL. | |||
inCoordinateValueStep | double? | <0, INF> | Determines the distance between consecutive extracted profiles. Default value: atl::NIL. | ||
inSmoothRadius | int | <0, INF> | Increases the number of neighbouring profiles taken into account extracting a single profile. | ||
inProfileDomainStart | double? | Minimal X coordinate of the output profiles. Default value: atl::NIL. | |||
inProfileDomainEnd | double? | Maximal X coordinate of the output profiles. Default value: atl::NIL. | |||
inMaxInterpolationLength | int? | <0, INF> | Maximal number of consecutive not existing profile points to be interpolated. Default value: atl::NIL. | ||
inDefaultValue | float | Default value of the not existing and not interpolated surface point. | |||
outProfiles | System.Collections.Generic.IList<AvlNet.Profile> | The resulting profiles of the surface height. | |||
outCoordinateValues | AvlNet.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
- SurfaceMultipleProfilesAlongAxis(Surface, Axis, Int32, Single, IList<Profile>)
- SurfaceMultipleProfilesAlongAxis(Surface, Axis, Nullable<Double>, Nullable<Double>, Nullable<Double>, Int32, Nullable<Double>, Nullable<Double>, Nullable<Int32>, Single, IList<Profile>)