GetCouplerPositionTransform Method


Return a transform representing the relative position of the coupler at index couplerPositionIndex in the set.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 18.0.0.0 (18.2.0.0)
Since: 2017

Syntax

C#
public Transform GetCouplerPositionTransform(
	int couplerPositionIndex
)
Visual Basic
Public Function GetCouplerPositionTransform ( _
	couplerPositionIndex As Integer _
) As Transform
Visual C++
public:
Transform^ GetCouplerPositionTransform(
	int couplerPositionIndex
)

Parameters

couplerPositionIndex
Type: System Int32
An index between 0 and (CouplerQuantity-1).

Return Value

Returns a transformation that is composed from : - a translation from (0, 0, 0) to coupler origin - a rotation that will align the coupler with the bar segment on which it stays.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentOutOfRangeException couplerPositionIndex is not in the range [ 0, CouplerQuantity-1 ].

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →