M

RebarFreeFormAccessor.SetHookPlaneNormalForBarIdx

Description:
Set the normal of plane in which the hook at end of bar with index barPositionIndex will stay. Will throw exception if the rebar has valid constraints.

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

An index between 0 and (NumberOfBarPositions-1).
XYZ

hookNormal

The normal of plane in which the hook at end of bar with index barPositionIndex will stay. The normal should be perpendicular to the bar direction at the specified end of bar.

ArgumentException

Normal hookNormal for end end isn't a valid normal for bar with index barPositionIndex
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

barPositionIndex is not in the range [ 0, NumberOfBarPositions-1 ]. -or- Invalid end. -or- hookNormal has zero length.
InvalidOperationException

This RebarFreeFormAccessor Rebar is constrained.