Represents a Rail/Handrail/Toprail End element.
typedef struct {
API_Elem_Head head;
API_Guid owner;
API_Guid symbID;
API_RailEndTypeID type;
API_RailEndBaseConnectionID baseConnection;
double firstExtrusionOffset;
double firstExtrusionLength;
double filletRadius;
API_RailEndFixtureConnectionID fixtureConnection;
API_RailEndArcAngleModeID arcAngleMode;
double arcAngle;
double arcRadius;
double secondExtrusionLength;
double thirdExtrusionLength;
API_RailEndExtrusionModeID secondExtrusionMode;
UInt32 filler_1;
API_RailingFinishType finishDef;
} API_RailingRailEndType;
Members
- head
- General element header.
- owner
- GUID of the Railing Node element owning this Rail End.
- symbID
- The identifier of the symbol of this element.
- type
-
The type of the Rail End:
APIRE_ExtensionThe type is extension.
APIRE_CurveThe type is curved.
APIRE_FullReturnThe type is full return.
APIRE_ConnectWithDuplicateThe type is connection between duplicated handrails.
- baseConnection
-
Connection type between the Rail End and a base:
APIBC_HorizontalConnection type is horizontal.
APIBC_TangentialConnection type is tangential.
- firstExtrusionOffset
- Offset of the first extrusion.
- firstExtrusionLength
- Length of the first extrusion.
- filletRadius
- Radius of the filleting of the Rail End.
- fixtureConnection
-
The type of the curving in case of Curved type:
APIRC_SegmentPlaneThe curving is in the plane of the segment.
APIRC_HorizontalRightThe curving is horizontal to the right.
APIRC_HorizontalLeftThe curving is horizontal to the left.
- arcAngleMode
-
Angle mode of the Rail End’s arc:
APIAM_SetToVerticalThe angle is absolute vertical.
APIAM_CustomAngleThe angle is relative to the first extrusion.
- arcAngle
- Angle of the Rail End’s arc.
- arcRadius
- Radius of the Rail End’s arc.
- secondExtrusionLength
- Length of the second extrusion.
- thirdExtrusionLength
- Length of the third extrusion.
- secondExtrusionMode
-
Mode of the second extrusion:
APIEM_CustomLengthThe length is custom.
APIEM_ToReferenceLineThe length of the extrusion will be set so that it will reach the reference line.
APIEM_ToHandrailSiblingIn case of a handrail the length will be set so that it will reach the other handrail. If this is set for one of the handrails, then the other handrail’s
secondExtrusionModewill be automatically set toAPIEM_ToHandrailSibling, too. - lastCutAngle
- Angle of the Rail End’s last cut.
- finishDef
- Default finish for the Rail End.
Requirements
- Version: API 21 or later
- Header: APIdefs_Elements.h
See Also
API_Element,
API_RailingType,
API_RailingNodeType
Element Manager,
API Types