M

CylindricalHelix.Create

Description:
Create a cylindrical helix.

public static CylindricalHelix Create(
	XYZ basePoint,
	double radius,
	XYZ xVector,
	XYZ zVector,
	double pitch,
	double startAngle,
	double endAngle
)

Public Shared Function Create ( 
	basePoint As XYZ,
	radius As Double,
	xVector As XYZ,
	zVector As XYZ,
	pitch As Double,
	startAngle As Double,
	endAngle As Double
) As CylindricalHelix

public:
static CylindricalHelix^ Create(
	XYZ^ basePoint, 
	double radius, 
	XYZ^ xVector, 
	XYZ^ zVector, 
	double pitch, 
	double startAngle, 
	double endAngle
)

static member Create : 
        basePoint : XYZ * 
        radius : float * 
        xVector : XYZ * 
        zVector : XYZ * 
        pitch : float * 
        startAngle : float * 
        endAngle : float -> CylindricalHelix

XYZ

basePoint

Base point of the axis. It can be any point in 3d.
Double

radius

Radius. It should be a positive number.
XYZ

xVector

X vector. Should be Non-zero vector.
XYZ

zVector

Z vector = axis direction. Should be non-zero and orthogonal to X Vector.
Double

pitch

Pitch. It should be non-zero number, can be positive or negative. Positive means right handed and negative means left handed.
Double

startAngle

Start angle. It specifies the start point of the Helix.
Double

endAngle

End angle. It specifies the end point of the Helix. End angle should not be equal to start angle.

Return Value CylindricalHelix CylindricalHelix

ArgumentException

The radius is negative -or- the pitch is zero -or- the xVector or zVector is zero length -or- zVector is not orthogonal to xVector -or- endAngle is equal to startAngle.