Alignment
Represents an object which provides access to an underlying Revit alignment element.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.Infrastructure.Alignment
Namespace: Autodesk.Revit.DB.Infrastructure
Assembly: Autodesk.CivilAlignments.DBApplication (in Autodesk.CivilAlignments.DBApplication.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class AlignmentThe Alignment type exposes the following members.
Properties
Name
Description
Public Property
Description
The Description of this alignment.
Public Property
DisplayedEndStation
Specifies the station at which the alignment’s display ends, in Revit internal model units (standard Imperial feet).
Public Property
DisplayedStartStation
Specifies the station at which the alignment’s display starts, in Revit internal model units (standard Imperial feet).
Public Property
Element
The underlying DirectShape element.
Public Property
EndStation
Specifies the station at which the alignment’s geometric definition ends, in Revit internal model units (standard Imperial feet).
Public Property
GUID
The GUID of this alignment.
Public Property
Name
The Name of this alignment.
Public Property
StartStation
Specifies the station at which the alignment’s geometric definition starts, in Revit internal model units (standard Imperial feet).
Methods
Name
Description
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
Static Member
Get(Element)
Returns an Alignment object given a Revit alignment element.
Public Method
Static Member
Get(Document, Guid)
Returns an Alignment in the document given its GUID.
Public Method
Static Member
GetAlignments(Document)
Returns all alignments in the given document.
Public Method
Static Member
GetAlignments(View)
Returns all alignments visible in the given view.
Public Method
GetClosestPoint
Calculates the point on the alignment’s geometry which is closest to the given model point.
Public Method
GetClosestStation
Calculates the alignment station closest to the given model point.
Public Method
GetDisplayedHorizontalCurveEndpoints
Returns the endpoints of the alignment’s horizontal curves. Only the points between DisplayedStartStation and DisplayedEndStation are returned.
Public Method
GetDistance
Calculates the relative distance along the alignment between two stations based on their alignment distances according to Revit Internal Origin Coordinate Base. The distance may be positive or negative depending on the relative positions of the input stations on the alignment.
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object)
Public Method
GetHCurveNormalAtStation
Calculate 2d (X and Y components of returned vector) horizontal normal at given station.
Public Method
GetHCurveTangentAtStation
Calculate 2d (X and Y components of returned vector) horizontal tangent at given station.
Public Method
GetPointAtStation
Calculates the model point for a given alignment station.
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
GetVCurveNormalAtStation
Calculate 2d (X and Y components of returned vector) vertical normal at given station.
Public Method
GetVCurveTangentAtStation
Calculate 2d (X and Y components of returned vector) vertical tangent at given station.
Public Method
IsValid.
Checks if this object is a valid alignment.
Public Method
Static Member
IsValid(Element)
Checks if the element is a valid alignment.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)
Remarks
The element is a DirectShape. The element’s category is OST_Alignments.