2025.3 Class
Changes 7
C

RebarConstraint

Description:
A class representing a constraint on a handle of a rebar element.
Remarks:

For Shape Driven Rebar Constraints:

Each handle on a rebar is defined by a plane, and can be constrained along the direction perpendicular to a surface. Rebar constraints work by locking the handle planes to targets. These targets can be: surfaces of host elements (faces or cover), the handle planes of other Rebar element or any generic surface.

A special case is for of a straight, standard style bar, running perpendicular to the plane of the stirrup bar. This bar can constrain itself to distinct locations along bends in stirrup bars - points located at 0 degrees, 45 degrees, 90 degrees, etc. around each bend. This is done by simultaneously locking both the straight bar's edge handle and its planar position handle to one or both of the stirrup edges adjacent to the bend in the stirrup.

Usually, to form a constraint, the handle plane and the reference plane must be parallel. However, bar end or segment handles can be constrained to planes at angles up to 84 degrees. Arc-shaped rebar is a special case, and can form constraints to concentric host surfaces.

For Free Form Rebar Constraints:

Each handle of the Rebar can be constrained to multiple host faces or to the face cover.

In order to create a Free Form Rebar Constraint you will need:

  1. RebarConstraintsManager which will manage the constraint.
  2. The rebar handle you want to constraint.
  3. A list of target references which must be element faces to which this handle is constrained.
  4. A Boolean value specifying that the constraint is to cover or directly to face. It will be the same value for all target references
  5. A double value that represent the offset distance from the rebar handle to target references.

RebarConstraints for Free Form Rebar should be created using the Create method and then added to the RebarConstraintsManager using the method SetPreferredConstraintForHandle.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Structure.RebarConstraint
public class RebarConstraint : IDisposable
Name Return Type Description Inherited From
M ConstrainsRebarEnds() Boolean Returns true if this constraint constrains two rebar ends.
M Create(RebarConstrainedHandle, IList<Reference>, Boolean, Double) RebarConstraint
M CreateConstraintToSurface(RebarConstrainedHandle, Surface) RebarConstraint 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.
M Dispose() None Releases all resources used by the RebarConstraint
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M FlipHandleOverTarget() None Flips the RebarConstrainedHandle to the other side of the target bar handle, maintaining the distance in absolute value.
M FlipSideForClearBarSpacingZeroDistanceConstraint() None Flips the side on which a RebarConstrainedHandle constrained using clear bar distance with zero offset connects to another Rebar target handle.
M GetConstraintType() RebarConstraintType Returns the RebarConstraintType of a RebarConstraint.
M GetCustomHandleTag() Int32 Returns the handle tag of the RebarConstrainedHandle. This is valid only for Free Form Rebar.
M GetDistanceToTargetCover() Double Returns the distance from the RebarConstrainedHandle to the target Host Cover Element surface. The RebarConstraintType of the RebarConstraint must be 'ToCover'.
M GetDistanceToTargetHostFace() Double Returns the distance from the RebarConstrainedHandle to the target Host Element surface. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace'.
M GetDistanceToTargetRebar() Double Gets the distance from the RebarConstrainedHandle to the target Rebar handle surface. The RebarConstraintType of the RebarConstraint must be 'ToOtherRebar'.
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetPositiveOffsetDirectionForToOtherRebarConstraint() XYZ Returns the positive offset direction vector.
M GetRebarConstrainedHandle() RebarConstrainedHandle Gets the RebarConstrainedHandle for which this constraint is.
M GetRebarConstraintTargetHostFaceType() RebarConstraintTargetHostFaceType 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.
M GetRebarConstraintTargetHostFaceType(Int32) RebarConstraintTargetHostFaceType Returns the RebarConstraintTargetHostFaceType of the host Element face to which the RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace' or 'ToCover'.
M GetSurfaceForConstraintToSurface() Surface This method retrieves the surface for a constraint of 'To Surface' type.
M GetTargetCoverType(Int32) RebarCoverType Returns the RebarCoverType for the face specified by targetIndex. Returns null if no RebarHostData is present for target element.
M GetTargetElement() Element Gets the Element object (either Host or Rebar) which provides the constraint. Will throw exception if it's a multi target constraint.
M GetTargetElement(Int32) Element Gets the Element object (either Host or Rebar) which provides the constraint. Will return the Element which contains the face at targetIndex.
M GetTargetHostFaceAndTransform(Int32, Transform) Face 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'.
M GetTargetHostFaceReference() Reference 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.
M GetTargetHostFaceReference(Int32) Reference 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'.
M GetTargetRebarAngleOnBarOrHookBend() Int32 Returns the angular increment along a bar or hook bend to which the RebarConstraint is attached.
M GetTargetRebarBendNumber() Int32 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.
M GetTargetRebarConstraintType() TargetRebarConstraintType 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.
M GetTargetRebarEdgeNumber() Int32 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.
M GetTargetRebarHookBarEnd() Int32 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.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M HasAnEdgeNumber() Boolean Checks if the getTargetRebarEdgeNumber method can be called for the RebarConstraint.
M IsBindingHandleWithTarget() Boolean Gets the relationship between two RebarConstrainedHandles.
M IsEqual(RebarConstraint) Boolean 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.
M IsFixedDistanceToHostFace() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'FixedDistanceToHostFace'.
M IsReferenceValidForConstraint(Reference) Boolean Checks if the reference provided can be used in creating Rebar constraints
M IsToCover() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'ToCover'. Returns true if the RebarConstraintType of the RebarConstraint is 'ToCover', false otherwise.
M IsToHostFaceOrCover() Boolean Returns true if the RebarConstraintType of the RebarConstraint is either 'FixedDistanceToHostFace' or 'ToCover'.
M IsToOtherRebar() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'ToOtherRebar'.
M IsToSurface() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'ToSurface'.
M IsUsingClearBarSpacing() Boolean Returns true if the RebarConstrainedHandle to target offset is the clear bar distance, false if the offset is measured between bar centers.
M IsValid() Boolean Checks that the RebarConstraint still has access to valid Rebar constraint data and that its RebarConstraintsManager is still valid.
M IsValidSurfaceToConstraintHandleTo(RebarConstrainedHandle, Surface) Boolean Checks if the surface can be used to create a constraint to it for the input handle.
M ReplaceReferenceTargets(RebarConstrainedHandle, IList<Reference>, Boolean, Double) None
M SetDistanceToTargetCover(Double) None Sets the distance from the RebarConstrainedHandle to the target Host Cover Element surface. The RebarConstraintType of the RebarConstraint must be 'ToCover'.
M SetDistanceToTargetHostFace(Double) None Sets the distance from the RebarConstrainedHandle to the target Host Element surface. The RebarConstraintType of the RebarConstraint must be 'FixedDistanceToHostFace'.
M SetDistanceToTargetRebar(Double) None Sets the offset distance between the constrained RebarConstrainedHandle and its target Rebar handle surface.
M SetToBindHandleWithTarget(Boolean) None Sets the relationship between two RebarConstrainedHandles.
M SetToUseClearBarSpacing(Boolean) None Sets whether the RebarConstrainedHandle to target offset is the clear bar distance, or is measured between bar centers.
M TargetIsBarBend() Boolean Returns true if the RebarTargetConstraintType of the RebarConstraint is 'BarBend'.
M TargetIsHookBend() Boolean Returns true if the RebarTargetConstraintType of the RebarConstraint is 'HookBend'.
M TargetRebarConstraintTypeIsEdge() Boolean Returns true if the RebarConstraintType of the RebarConstraint is 'ToOtherRebar,' and the RebarConstraint is attached to an edge of the other Rebar Element.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity.
P NumberOfTargets int Identifies the number of references associated to the rebar handle.