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