SurfaceSingleProfileAlongAxis


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

Syntax

C++
C#
Python
 
def SurfaceSingleProfileAlongAxis(
	inSurface: Surface,
	outProfile: Profile,
	/,
	*,
	inAxis: Axis = Axis.X,
	inCoordinateValue: float = 0,
	inSmoothRadius: int = 0,
	inProfileDomainStart: float | None = None,
	inProfileDomainEnd: float | None = None,
	inMaxInterpolationLength: int | None = None,
	inDefaultValue: float = 0
)
-> outCoordinateValue: float

Parameters

Name Type Range Default Description
Input value inSurface Surface Input surface
Input value inAxis Axis Axis.X Axis along which the profile is extracted
Input value inCoordinateValue float 0 Determines the coordinate the profile will be extracted from
Input value inSmoothRadius int 0 - 0 Increases the number of neighbouring profiles taken into account extracting a profile
Input value inProfileDomainStart float | None None Minimal X coordinate of the output profile
Input value inProfileDomainEnd float | None None Maximal X coordinate of the output profile
Input value inMaxInterpolationLength int | None 0 - None Maximal number of consecutive not existing profile points to be interpolated
Input value inDefaultValue float 0 Default value of the not existing and not interpolated surface point
Output value outProfile Profile The resulting profile of the surface height
Output value outCoordinateValue float The coordinate the output profile was extracted from