M

RebarTrimExtendData.CreateStartConstraint

Description:
Creates a constraint for the start handle of the rebar. This constraint will be set preferred after the API execution is finished successfully.

public bool CreateStartConstraint(
	IList<Reference> targetReferences,
	bool isConstraintToCover,
	double offsetValue
)

Public Function CreateStartConstraint ( 
	targetReferences As IList(Of Reference),
	isConstraintToCover As Boolean,
	offsetValue As Double
) As Boolean

public:
bool CreateStartConstraint(
	IList<Reference^>^ targetReferences, 
	bool isConstraintToCover, 
	double offsetValue
)

member CreateStartConstraint : 
        targetReferences : IList<Reference> * 
        isConstraintToCover : bool * 
        offsetValue : float -> bool

IList<Reference>

targetReferences

The references to which the rebar handle will be constrained. Will throw exception if it's empty or if it's anything but Face(s) from a structural that can host rebar.
Boolean

isConstraintToCover

If true the RebarConstraintType will be set to ToCover, otherwise RebarConstraintType will be set to FixedDistanceToHostFace.
Double

offsetValue

The distance from references to the rebar handle.

Return Value Boolean Returns true if a start constraint can be created with the given references, false otherwise. The reference should be faces from structurals that can host rebar.

ArgumentNullException

A non-optional argument was null