2027 Members
Changes 0
M

RebarConstraint Methods

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 This method creates a constraint of 'ToHostFace' or 'ToCover' type for a given RebarConstrainedHandle. Using this method for Shape-Driven Rebar will throw exception. If you need a new RebarConstraint for a handle of a Shape-Driven Rebar, you can obtain a list of possible constraints using one of the RebarConstraintsManager.GetConstraintCandidatesForHandle functions, choose the desired one, and set it as preferred.
M CreateConstraintToCustomTarget(RebarConstrainedHandle, Double) RebarConstraint This method creates a constraint of 'ToCustomTarget' type for a given RebarConstrainedHandle. The RebarConstrainedHandle should belong to a Free Form Rebar should allow constrains to custom target.
M CreateConstraintToHostEdge(RebarConstrainedHandle, IList<Reference>) RebarConstraint This method creates a constraint of 'ToHostEdge' type for a given RebarConstrainedHandle. The RebarConstrainedHandle should belong to a Free Form Rebar and must be allowed to constrain to host edges.
M CreateConstraintToHostEdgeCover(RebarConstrainedHandle, IList<Reference>) RebarConstraint This method creates a constraint of 'ToHostEdgeCover' type for a given RebarConstrainedHandle. The RebarConstrainedHandle should belong to a Free Form Rebar and must be allowed to constrain to host edges. The RebarConstrainedHandle that is constrained 'ToHostEdgeCover' must allow offset value.
M CreateConstraintToRebarEdge(RebarConstrainedHandle, IList<ConstraintToRebarEdgeProperties>) RebarConstraint This method creates a constraint of 'ToOtherRebar' type with Edge target type for a given RebarConstrainedHandle. The RebarConstrainedHandle should belong to a Free Form Rebar, otherwise it will throw exception.
M CreateConstraintToSurface(RebarConstrainedHandle, Surface) RebarConstraint This method creates a constraint of 'ToSurface' type for a given RebarConstrainedHandle. The RebarConstrainedHandle should belong to a Shape Driven Rebar, otherwise it will throw exception.
M Dispose() None
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 GetConstraintToRebarEdgeProperties() IList<ConstraintToRebarEdgeProperties> Gets the properties for all target rebar edges.
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 GetDistanceToCustomTarget() Double Gets the distance from the RebarConstrainedHandle to the custom target.
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 GetDistanceToTargetHostEdge() Double Returns the distance from the RebarConstrainedHandle to the target host edge. The RebarConstraintType of the RebarConstraint must be 'ToHostEdge' and must allow offset value.
M GetDistanceToTargetHostEdgeCover() Double Returns the distance from the RebarConstrainedHandle to the target host edge cover. The RebarConstraintType of the RebarConstraint must be 'ToHostEdgeCover'.
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 default positive offset direction vector for a constraint to a Shape Driven Rebar.
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 GetTargetCoverTypeForToHostEdgeConstraint(Int32, Int32) RebarCoverType Returns the RebarCoverType for the face provided at faceIndex, that forms the edge of this RebarConstraint at the specified targetIndex. The RebarConstraintType of the RebarConstraint must be 'ToHostEdge' or 'ToHostEdgeCover'. Returns null if no RebarHostData is present for target element.
M GetTargetElement() Element Gets the Element object (either Host or Rebar) which provides the target reference at index 0 for this 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 target reference at specified index for this constraint.
M GetTargetHostEdgeAndTransform(Int32) TargetHostEdgeAndTransform Returns the target host edge and the transform that is associated to the host edge's geometry. The RebarConstraintType of the RebarConstraint must be 'ToHostEdge' or 'ToHostEdgeCover'. Only applied to Free Form Rebar.
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 GetTargetHostFaceReferenceForEdgeConstraint(Int32, Int32) Reference Returns a reference to the host Element face provided at faceIndex, that forms the edge of this RebarConstraint at the specified targetIndex. The RebarConstraintType of the RebarConstraint must be 'ToHostEdge' or 'ToHostEdgeCover'.
M GetTargetRebarAngleOnBarOrHookBend() Int32 Returns the angular increment along a bar or hook bend to which the RebarConstraint is attached.
M GetTargetRebarBendNumber() Int32 Gets 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 Gets the TargetRebarConstraintType of the handle on the other Rebar Element to which this RebarConstraint is attached. The RebarConstraintType of the RebarConstraint must be 'ToOtherRebar'.
M GetTargetRebarEdgeNumber() Int32 Gets 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 GetTargetRebarHandleBehavior() RebarHandleBehavior 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'.
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 IsReferenceAValidEdgeForConstraint(Document, Reference) Boolean Checks if the reference provided can be used in creating 'ToHostEdge' or 'ToHostEdgeCover' constraint.
M IsReferenceAValidFaceForConstraint(Document, Reference) Boolean Checks if the reference provided can be used in creating 'ToFace' or 'ToCover' constraints.
M IsReferenceValidForConstraint(Reference) Boolean Obsolete. Checks if the reference provided can be used in creating 'ToFace' or 'ToCover' 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 IsToCustomTarget() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'ToCustomTarget'.
M IsToHostEdge() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'ToHostEdge'.
M IsToHostEdgeCover() Boolean Checks if the RebarConstraintType of the RebarConstraint is 'ToHostEdgeCover'.
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(IList<Reference>, RebarConstraintType) None Replaces the current set of references, with the newly provided ones. Will throw exception if this is a constraint for Shape Driven Rebar.
M ReplaceReferenceTargets(RebarConstrainedHandle, IList<Reference>, Boolean, Double) None Obsolete. Replaces the current set of references, the type of constraint and the offset value, with the newly provided ones. Will throw exception if this is a constraint for Shape Driven Rebar.
M SetConstraintToRebarEdgeProperties(ConstraintToRebarEdgeProperties) None Sets the properties of the constraint to target rebar edges.
M SetDistanceToCustomTarget(Double) None Sets the distance from the RebarConstrainedHandle to the custom target.
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 SetDistanceToTargetHostEdge(Double) None Sets the distance from the RebarConstrainedHandle to the target host edge. The RebarConstraintType of the RebarConstraint must be 'ToHostEdge' and must allow offset value.
M SetDistanceToTargetHostEdgeCover(Double) None Sets the distance from the RebarConstrainedHandle to the target host edge cover. The RebarConstraintType of the RebarConstraint must be 'ToHostEdgeCover'.
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 TargetRebarConstraintType of the RebarConstraint is 'BarBend'.
M TargetIsHookBend() Boolean Returns true if the TargetRebarConstraintType 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