Revit 2018 API |
ConicalSurface..::..Create Method |
ConicalSurface Class See Also |
Creates a conical surface defined by a local reference frame and a half angle.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 18.0.0.0 (18.0.0.420)
Since:
2017
Syntax
C# |
---|
public static ConicalSurface Create( Frame frameOfReference, double halfAngle ) |
Visual Basic |
---|
Public Shared Function Create ( _ frameOfReference As Frame, _ halfAngle As Double _ ) As ConicalSurface |
Visual C++ |
---|
public: static ConicalSurface^ Create( Frame^ frameOfReference, double halfAngle ) |
Parameters
- frameOfReference
- Type: Autodesk.Revit.DB..::..Frame
frameOfReference is an orthonormal frame that defines a local coordinate system for the cone.- Frame.Origin is a point on the cylinder's axis.
- Frame.BasisZ points along the axis, while Frame.BasisX and Frame.BasisY are orthogonal to the axis.
- 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.
- halfAngle
- Type: System..::..Double
Cone angle. Must be not 0, lesser than PI/2 and greater than -PI/2.
Return Value
The created ConicalSurface.
Remarks
The parametric equation of the cone is S(u, v) = Frame.Origin + v*[sin(halfAngle)(cos(u)*Frame.BasisX + sin(u)*Frame.BasisY) + cos(halfAngle)*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).
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | This Frame object may not be used as a local frame of reference. -or- The supplied value must be not 0, lesser than PI/2 and greater than -PI/2. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |