M

RebarSpliceUtils.CanRebarBeSpliced

Description:
Verifies if the rebar can be spliced with the provided 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 spliced.

Otherwise, the line will be extended to exceed the bounding box of the bar.

Overloads (3):

CanRebarBeSpliced

CanRebarBeSpliced(Rebar,RebarSpliceOptions,Line,ElementId)

CanRebarBeSpliced(Rebar,RebarSpliceOptions,Line,XYZ)

CanRebarBeSpliced(Rebar,RebarSpliceOptions,RebarSpliceGeometry)

public static RebarSpliceError CanRebarBeSpliced(
	Rebar rebar,
	RebarSpliceOptions spliceOptions,
	Line line,
	XYZ linePlaneNormal
)

Public Shared Function CanRebarBeSpliced ( 
	rebar As Rebar,
	spliceOptions As RebarSpliceOptions,
	line As Line,
	linePlaneNormal As XYZ
) As RebarSpliceError

public:
static RebarSpliceError CanRebarBeSpliced(
	Rebar^ rebar, 
	RebarSpliceOptions^ spliceOptions, 
	Line^ line, 
	XYZ^ linePlaneNormal
)

static member CanRebarBeSpliced : 
        rebar : Rebar * 
        spliceOptions : RebarSpliceOptions * 
        line : Line * 
        linePlaneNormal : XYZ -> RebarSpliceError

Rebar

rebar

The rebar to be spliced.
RebarSpliceOptions

spliceOptions

The RebarSpliceOptions.
Line

line

The line to splice the rebar with.
XYZ

linePlaneNormal

The normal that determines the plane of the line.

Return Value RebarSpliceError Will return RebarSpliceError.Success if it's possible to splice with line or other enum value corresponding to the error that occurred.

ArgumentNullException

A non-optional argument was null