Namespace: Autodesk.Revit.DB Class: CylindricalSurface

CylindricalSurface.Create

Method

Description:
Construct a cylindrical surface defined by a local coordinate system and a radius.

Remarks:
The parametric equation of the cylinder is S(u, v) = Frame.Origin + radius*cos(u)*Frame.BasisX + radius*sin(u)*Frame.BasisY + v*Frame.BasisZ. This implies the following facts:

Frame.BasisX points from the axis point to the point on the cylinder with coordinates (0, 0).
Frame.BasisY points in the direction of the partial derivative dS/du at (0, 0).
Frame.BasisZ points in the direction of the partial derivative dS/dv at (0, 0).

Syntax

public static CylindricalSurface Create(
	Frame frameOfReference,
	double radius
)

Public Shared Function Create ( 
	frameOfReference As Frame,
	radius As Double
) As CylindricalSurface

public:
static CylindricalSurface^ Create(
	Frame^ frameOfReference, 
	double radius
)

static member Create : 
        frameOfReference : Frame * 
        radius : float -> CylindricalSurface

Parameters

Parameter	Type	Description
frameOfReference	Frame	frameOfReference is an orthonormal frame that defines a local coordinate system for the cylinder. <ul><li>Frame.Origin is a point on the cylinder's axis. </li><li>Frame.BasisZ points along the axis, while Frame.BasisX and Frame.BasisY are orthogonal to the axis. </li><li>The frame may be either left-handed or right-handed (see Frame.IsRightHanded). Note that the "handedness" of the frame does not, by itself, determine the surface's orientation.</li></ul>
radius	Double	Radius of the circle that defines the base of the cylindrical surface.

Return Value

Type	Description
CylindricalSurface	The created CylindricalSurface.

Exceptions

Exception	Condition
ArgumentException	This Frame object may not be used as a local frame of reference.
ArgumentNullException	A non-optional argument was null
ArgumentOutOfRangeException	The given value for radius must be greater than 0 and no more than 30000 feet.