M

StairsRun.SetLocationPathForSpiralRun

Description:
Set Location path for a spiral run.

public static bool SetLocationPathForSpiralRun(
	StairsRun stairsRun,
	XYZ center,
	double radius,
	double startAngle,
	double includedAngle,
	bool clockwise,
	StairsRunJustification justification
)

Public Shared Function SetLocationPathForSpiralRun ( 
	stairsRun As StairsRun,
	center As XYZ,
	radius As Double,
	startAngle As Double,
	includedAngle As Double,
	clockwise As Boolean,
	justification As StairsRunJustification
) As Boolean

public:
static bool SetLocationPathForSpiralRun(
	StairsRun^ stairsRun, 
	XYZ^ center, 
	double radius, 
	double startAngle, 
	double includedAngle, 
	bool clockwise, 
	StairsRunJustification justification
)

static member SetLocationPathForSpiralRun : 
        stairsRun : StairsRun * 
        center : XYZ * 
        radius : float * 
        startAngle : float * 
        includedAngle : float * 
        clockwise : bool * 
        justification : StairsRunJustification -> bool

StairsRun

stairsRun

The run whose location path will be set.
XYZ

center

The center of the location arc of the spiral run. The Z coordinate of the center is the base elevation for the new run (in model coordinates). It must be greater than or equal to the stairs base elevation.
Double

radius

The radius of the location arc of the spiral run.
Double

startAngle

The start angle of the location arc of the spiral run. The angle's coordinate system is world coordinate system which always is XYZ.BasisX and XYZ.BasisY.
Double

includedAngle

The total angle covered by the spiral run. Must be a positive value (direction is determined by the clockwise flag).
Boolean

clockwise

True if the spiral run will be created along clockwise direction, False otherwise.
StairsRunJustification

justification

The location path justification of the new stairs run.

Return Value Boolean Indicate if set is success or not.

ArgumentException

The given value for startAngle is not finite -or- The input center is not a valid center for spiral run (probably the Z coordinate doesn't meet the restrictions) -or- The includedAngle doesn't satisfy riser restriction to generate spiral run (probably it's too small).
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

The given value for radius must be greater than 0 and no more than 30000 feet. -or- The given value for includedAngle must be positive. -or- A value passed for an enumeration argument is not a member of that enumeration
ArgumentsInconsistentException

The radius is too small to generate a spiral run at the given justification.
InvalidOperationException

The stairs element represented by stairsRun is not in an active StairsEditScope. The run cannot be modified.
RegenerationFailedException

The center, radius, startAngle, includedAngle don't satisfy restrictions to generate spiral run.