Share

RebarConstraint Methods

The RebarConstraint type exposes the following members.

Methods

 NameDescription
Public methodConstrainsRebarEnds Returns true if this constraint constrains two rebar ends.
Public methodStatic memberCreate 
Public methodStatic memberCreateConstraintToSurface

This method creates a constraint of 'To Surface' type for a given RebarConstrainedHandle.

The RebarConstrainedHandle should belong to a shape driven rebar, otherwise it will throw exception.

Public methodDispose 
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodFlipHandleOverTarget Flips the RebarConstrainedHandle to the other side of the target bar handle, maintaining the distance in absolute value.
Public methodFlipSideForClearBarSpacingZeroDistanceConstraint Flips the side on which a RebarConstrainedHandle constrained using clear bar distance with zero offset connects to another Rebar target handle.
Public methodGetConstraintType Returns the RebarConstraintType of a RebarConstraint.
Public methodGetCustomHandleTag Returns the handle tag of the RebarConstrainedHandle. This is valid only for Free Form Rebar.
Public methodGetDistanceToTargetCover Returns the distance from the RebarConstrainedHandle to the target Host Cover Element surface. The RebarConstraintType of the RebarConstraint must be 'ToCover'.
Public methodGetDistanceToTargetHostFace Returns the distance from the RebarConstrainedHandle to the target Host Element surface. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace'.
Public methodGetDistanceToTargetRebar Gets the distance from the RebarConstrainedHandle to the target Rebar handle surface. The RebarConstraintType of the RebarConstraint must be 'ToOtherRebar'.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetPositiveOffsetDirectionForToOtherRebarConstraint Returns the positive offset direction vector.
Public methodGetRebarConstrainedHandle Gets the RebarConstrainedHandle for which this constraint is.
Public methodGetRebarConstraintTargetHostFaceType() Returns the RebarConstraintTargetHostFaceType of the host Element face to which the RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace' or 'ToCover'. Will throw exception if it's a multi target constraint.
Public methodGetRebarConstraintTargetHostFaceType(Int32) Returns the RebarConstraintTargetHostFaceType of the host Element face to which the RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace' or 'ToCover'.
Public methodGetSurfaceForConstraintToSurface This method retrieves the surface for a constraint of 'To Surface' type.
Public methodGetTargetCoverType Returns the RebarCoverType for the face specified by targetIndex. Returns null if no RebarHostData is present for target element.
Public methodGetTargetElement() Gets the Element object (either Host or Rebar) which provides the constraint. Will throw exception if it's a multi target constraint.
Public methodGetTargetElement(Int32) Gets the Element object (either Host or Rebar) which provides the constraint. Will return the Element which contains the face at targetIndex.
Public methodGetTargetHostFaceAndTransform Returns the face to which the RebarConstraint is attached associated to the given target index. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace' or 'ToCover'.
Public methodGetTargetHostFaceReference() Returns a reference to the host Element face to which the RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace' or 'ToCover'. Will throw exception if it's a multi target constraint.
Public methodGetTargetHostFaceReference(Int32) Returns a reference that corresponds to the face to which the RebarConstraint is attached specified by the targetIndex. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace' or 'ToCover'.
Public methodGetTargetRebarAngleOnBarOrHookBend Returns the angular increment along a bar or hook bend to which the RebarConstraint is attached.
Public methodGetTargetRebarBendNumber Returns the number of the bend on the other Rebar Element to which this RebarConstraint is attached. The RebarConstraint must be of RebarConstraintType 'ToOtherRebar,' and the TargetRebarConstraintType must be 'BarBend'. Rebar must be Shape Driven Rebar element.
Public methodGetTargetRebarConstraintType Returns the TargetRebarConstraintType of the handle on the other Rebar Element to which this RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'ToOtherRebar'. Rebar must be Shape Driven Rebar element.
Public methodGetTargetRebarEdgeNumber Returns the number of the edge on the other Rebar Element to which this RebarConstraint is attached. The RebarConstraint must be of RebarConstraintType 'ToOtherRebar,' and the TargetRebarConstraintType must be 'Edge'. Rebar must be Shape Driven Rebar element.
Public methodGetTargetRebarHandleBehavior Gets the RebarHandleBehavior of the handle of the other Rebar Element to which this RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'ToOtherRebar'.
Public methodGetTargetRebarHookBarEnd Returns 0 or 1 to indicate which end hook on the other Rebar Element to which this RebarConstraint is attached. The RebarConstraint must be of RebarConstraintType 'ToOtherRebar,' and the TargetRebarConstraintType must be 'HookBend'. Rebar must be Shape Driven Rebar element.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodHasAnEdgeNumber Checks if the getTargetRebarEdgeNumber method can be called for the RebarConstraint.
Public methodIsBindingHandleWithTarget Gets the relationship between two RebarConstrainedHandles.
Public methodIsEqual Checks if the specified RebarConstraint is the same as 'this'. The method can be used to determine which of the RebarConstraint candidates offered by the RebarConstraintsManager is currently active.
Public methodIsFixedDistanceToHostFace Checks if the RebarConstraintType of the RebarConstraint is 'FixedDistanceToHostFace'.
Public methodIsReferenceValidForConstraint Checks if the reference provided can be used in creating Rebar constraints
Public methodIsToCover Checks if the RebarConstraintType of the RebarConstraint is 'ToCover'. Returns true if the RebarConstraintType of the RebarConstraint is 'ToCover', false otherwise.
Public methodIsToHostFaceOrCover Returns true if the RebarConstraintType of the RebarConstraint is either 'FixedDistanceToHostFace' or 'ToCover'.
Public methodIsToOtherRebar Checks if the RebarConstraintType of the RebarConstraint is 'ToOtherRebar'.
Public methodIsToSurface Checks if the RebarConstraintType of the RebarConstraint is 'ToSurface'.
Public methodIsUsingClearBarSpacing Returns true if the RebarConstrainedHandle to target offset is the clear bar distance, false if the offset is measured between bar centers.
Public methodIsValid Checks that the RebarConstraint still has access to valid Rebar constraint data and that its RebarConstraintsManager is still valid.
Public methodStatic memberIsValidSurfaceToConstraintHandleTo Checks if the surface can be used to create a constraint to it for the input handle.
Public methodReplaceReferenceTargets 
Public methodSetDistanceToTargetCover Sets the distance from the RebarConstrainedHandle to the target Host Cover Element surface. The RebarConstraintType of the RebarConstraint must be 'ToCover'.
Public methodSetDistanceToTargetHostFace Sets the distance from the RebarConstrainedHandle to the target Host Element surface. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace'.
Public methodSetDistanceToTargetRebar Sets the offset distance between the constrained RebarConstrainedHandle and its target Rebar handle surface.
Public methodSetToBindHandleWithTarget Sets the relationship between two RebarConstrainedHandles.
Public methodSetToUseClearBarSpacing Sets whether the RebarConstrainedHandle to target offset is the clear bar distance, or is measured between bar centers.
Public methodTargetIsBarBend Returns true if the RebarTargetConstraintType of the RebarConstraint is 'BarBend'.
Public methodTargetIsHookBend Returns true if the RebarTargetConstraintType of the RebarConstraint is 'HookBend'.
Public methodTargetRebarConstraintTypeIsEdge Returns true if the RebarConstraintType of the RebarConstraint is 'ToOtherRebar,' and the RebarConstraint is attached to an edge of the other Rebar Element.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)

See Also

Reference

Was this information helpful?