Sign in
2021 Class
Changes 0
C

CylindricalHelix

Description:
A cylindrical helix.
Remarks:
The helix winds around a cylinder making constant angle with the axis of the cylinder. In this release, CylindricalHelix curves are used only in specific applications in stairs and railings, and should not be used or encountered when accessing curves of other Revit elements and geometry.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.APIObject
    Autodesk.Revit.DB.GeometryObject
      Autodesk.Revit.DB.Curve
        Autodesk.Revit.DB.CylindricalHelix
public class CylindricalHelix : Curve
Name Return Type Description Inherited From
M Create(XYZ, Double, XYZ, XYZ, Double, Double, Double) CylindricalHelix Create a cylindrical helix.
M Dispose() None Causes the object to release immediately any resources it may be utilizing. APIObject
M op_Equality(GeometryObject, GeometryObject) bool Determines whether two GeometryObjects are the same. GeometryObject
M Equals(Object) bool Determines whether the specified is equal to the current . GeometryObject
M GetHashCode() int Gets the integer value of the geometry object as hash code GeometryObject
M op_Inequality(GeometryObject, GeometryObject) bool Determines whether two GeometryObjects are different. GeometryObject
M Clone() Curve Returns a copy of this curve. Curve
M ComputeClosestPoints(Curve, Boolean, Boolean, Boolean, IList<ClosestPointsPairBetweenTwoCurves>) None Find the closest points between two curves. Closest points mean closest pairs of points, each pair consisting of a point on this, say P1, and a point on other curve, say P2. P1 and P2 are closest locally. Curve
M ComputeDerivatives(Double, Boolean) Transform Returns the vectors describing the curve at the specified parameter. Curve
M ComputeNormalizedParameter(Double) double Computes the normalized curve parameter from the raw parameter. Curve
M ComputeRawParameter(Double) double Computes the raw parameter from the normalized parameter. Curve
M CreateOffset(Double, XYZ) The new curve. Creates a new curve that is an offset of the existing curve. Curve
M CreateReversed() The new curve. Creates a new curve with the opposite orientation of the existing curve. Curve
M CreateTransformed(Transform) The new curve. Crates a new instance of a curve as a transformation of this curve. Curve
M Distance(XYZ) double Returns the shortest distance from the specified point to this curve. Curve
M Evaluate(Double, Boolean) XYZ Evaluates and returns the point that matches a parameter along the curve. Curve
M GetEndParameter(Int32) The parameter. Returns the raw parameter value at the start or end of this curve. Curve
M GetEndPoint(Int32) The curve endpoint. Returns the 3D point at the start or end of this curve. Curve
M GetEndPointReference(Int32) nullNothingnullptr Returns a stable reference to the start point or the end point of the curve. Curve
M Intersect(Curve) SetComparisonResult Calculates the intersection of this curve with the specified curve. Curve
M Intersect(Curve, IntersectionResultArray%) SetComparisonResult Calculates the intersection of this curve with the specified curve and returns the intersection results. Curve
M IsInside(Double) bool Indicates whether the specified parameter value is within this curve's bounds. Curve
M IsInside(Double, Int32%) bool Indicates whether the specified parameter value is within this curve's bounds and outputs the end index. Curve
M MakeBound(Double, Double) None Changes the bounds of this curve to the specified values. Curve
M MakeUnbound() None Makes this curve unbound. Curve
M Project(XYZ) IntersectionResult Projects the specified point on this curve. Curve
M SetGraphicsStyleId(ElementId) None Sets the graphics style id for this curve. Curve
M Tessellate() IList<XYZ> Valid only if the curve is bound. Returns a polyline approximation to the curve. Curve
Name Return Type Description Inherited From
P BasePoint XYZ The base point of the axis of the cylindrical helix.
P Height double Height of the cylindrical helix.
P IsRightHanded bool True if the helix is right handed, false if the helix is left handed.
P Pitch double The pitch of the cylindrical helix.
P Radius double The radius of the cylindrical helix.
P XVector XYZ The X direction vector.
P YVector XYZ The Y direction vector.
P ZVector XYZ The Z direction vector, which is same as the axis direction vector.
P IsReadOnly bool Identifies if the object is read-only or modifiable. APIObject
P GraphicsStyleId ElementId The ElementId of the GeometryObject's GraphicsStyle GeometryObject
P Id int A unique integer identifying the GeometryObject in its associated non view-specific GeometryElement. GeometryObject
P IsElementGeometry bool Indicates whether this geometry is obtained directly from an Element. GeometryObject
P Visibility Visibility The visibility. GeometryObject
P ApproximateLength double The approximate length of the curve. Curve
P IsBound bool Describes whether the parameter of the curve is restricted to a particular interval. Curve
P IsClosed bool Describes whether the curve is closed. Curve
P IsCyclic bool The boolean value that indicates whether this curve is cyclic. Curve
P Length double The exact length of the curve. Curve
P Period double The period of this curve. Curve
P Reference Reference Returns a stable reference to the curve. Curve