M

RebarFreeFormAccessor.CanBeTerminationPlaneNormal

Description:
A vector can be termination (e.g. hook, crank) plane normal if for a bar specified by index, the bar direction is not parallel with the vector.

Remarks:

This method does not take into account the rotation of the bar relative to its default position along the distribution path.

public bool CanBeTerminationPlaneNormal(
	int barIndex,
	int end,
	XYZ normal
)

Public Function CanBeTerminationPlaneNormal ( 
	barIndex As Integer,
	end As Integer,
	normal As XYZ
) As Boolean

public:
bool CanBeTerminationPlaneNormal(
	int barIndex, 
	int end, 
	XYZ^ normal
)

member CanBeTerminationPlaneNormal : 
        barIndex : int * 
        end : int * 
        normal : XYZ -> bool

Int32

barIndex

The index of bar for which it will try to see if termination plane normal is applicable.
Int32

end

The end of bar. Should be 0 for start, 1 for end.
XYZ

normal

The termination's plane normal that will be tested.

Return Value Boolean A vector can be termination (e.g. hook, crank) plane normal if for a bar specified by index, the bar direction is not parallel with the vector.

ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

barIndex is not in the range [ 0, NumberOfBarPositions-1 ]. -or- Invalid end.