M

RebarUpdateCurvesData.SetHookPlaneNormalForBarIdx

Description:
Set the normal of plane in which the hook at end of bar with index barPositionIndex will stay. This information is set to the rebar after the API execution is finished successfully.

Remarks:
This information is set to the rebar after the API execution is finished successfully. Before setting the value a validation will be done. We consider a hook plane normal valid if it's perpendicular with the bar direction at end.

public void SetHookPlaneNormalForBarIdx(
	int end,
	int barPositionIndex,
	XYZ hookNormal
)

Public Sub SetHookPlaneNormalForBarIdx ( 
	end As Integer,
	barPositionIndex As Integer,
	hookNormal As XYZ
)

public:
void SetHookPlaneNormalForBarIdx(
	int end, 
	int barPositionIndex, 
	XYZ^ hookNormal
)

member SetHookPlaneNormalForBarIdx : 
        end : int * 
        barPositionIndex : int * 
        hookNormal : XYZ -> unit

Int32

end

The end of bar. Should be 0 for start or 1 for end.
Int32

barPositionIndex

Index of the bar for which it will set hook plane normal.
XYZ

hookNormal

The normal of plane in which the hook at end of bar with index barPositionIndex will stay.

ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

Invalid end. -or- hookNormal has zero length.