RebarSpliceUtils.SpliceRebar(Document, ElementId, RebarSpliceOptions, Line, XYZ)
Method
Description:
Splice a rebar with a line.
Splice a rebar with a line.
Remarks:
If the provided linePlaneNormal is parallel with the bar plane normal the bounded line will be used to calculate the splice geometries where the bar will be split.
Otherwise, the line will be extended to exceed the bounding box of the bar.
Syntax
public static IList<ElementId> SpliceRebar(
Document document,
ElementId rebarIdToSplit,
RebarSpliceOptions spliceOptions,
Line line,
XYZ linePlaneNormal
)
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document |
rebarIdToSplit | ElementId | Rebar id to split. |
spliceOptions | RebarSpliceOptions | The rebar splice options. |
line | Line | The line used for splice. |
linePlaneNormal | XYZ | The normal of the plane of the line. |
Return Value
Type | Description |
---|---|
IList | Returns the ids of the rebars that are considered to be spliced. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | Free Form Rebars, or Shape Driven Rebars that are Multiplanar or have a shape that whose definition is RebarShapeDefinitionByArc can't be spliced. Also, if the Rebar is member of a Group it cannot be spliced. -or- The rebar cannot be spliced with the provided line. |
ArgumentNullException | A non-optional argument was null |