2021 Members
Changes 6
M

RebarConstraint

Name Return Type Description Inherited From
M AreGeometryTargetsTheSame(RebarConstraint) bool Returns true if the gemetrical targets (ex. face references, other rebar segment references) of "this" constriant are the same as the targets of the "other" constraint. Returns false otherwise. Only the reference to the target piece of geometry is taken into account(ex. only face references, only other rebar segment references). Target Element (elementId) is not taken into account. Distance to target is not taken into account.
M ConstrainsRebarEnds() bool Returns true if this constraint constrains two rebar ends.
M Create(RebarConstrainedHandle, IList<Reference>, Boolean, Double) RebarConstraint This method creates a constraint for a given Rebar Constrained Handle Tag. Will throw exception if used for Shape Driven Rebar.
M Dispose() None Releases all resources used by the RebarConstraint
M Equals None (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 GetConstraintType() RebarConstraintType Returns the RebarConstraintType of a RebarConstraint.
M GetCustomHandleTag() int 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 (Inherited from Object .) Object .
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 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) Requested 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.() Requested 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) Requested 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() int Returns the angular increment along a bar or hook bend to which the RebarConstraint is attached.
M GetTargetRebarBendNumber() int 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() int 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() int 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 (Inherited from Object .) Object .
M HasAnEdgeNumber() bool Checks if the getTargetRebarEdgeNumber method can be called for the RebarConstraint.
M IsBindingHandleWithTarget() bool Gets the relationship between two RebarConstrainedHandles.
M IsEqual(RebarConstraint) bool Returns true 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() bool Returns true if the RebarConstraintType of the RebarConstraint is 'FixedDistanceToHostFace.'
M IsReferenceValidForConstraint(Reference) bool Checks if the reference provided can be used in creating Rebar constraints
M IsToCover() bool Returns true if the RebarConstraintType of the RebarConstraint is 'ToCover.'
M IsToHostFaceOrCover() bool Returns true if the RebarConstraintType of the RebarConstraint is either 'FixedDistanceToHostFace' or 'ToCover.'
M IsToOtherRebar() bool Returns true if the RebarConstraintType of the RebarConstraint is 'ToOtherRebar.'
M IsUsingClearBarSpacing() bool Returns true if the RebarConstrainedHandle to target offset is the clear bar distance, false if the offset is measured between bar centers.
M IsValid() bool Checks that the RebarConstraint still has access to valid Rebar constraint data and that its RebarConstraintsManager is still valid.
M ReplaceReferenceTargets(RebarConstrainedHandle, IList<Reference>, Boolean, Double) None 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 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() bool Returns true if the RebarTargetConstraintType of the RebarConstraint is 'BarBend'.
M TargetIsHookBend() bool Returns true if the RebarTargetConstraintType of the RebarConstraint is 'HookBend'.
M TargetRebarConstraintTypeIsEdge() bool 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 (Inherited from Object .) Object .
Name Return Type Description Inherited From
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.
P NumberOfTargets int Identifies the number of references associated to the rebar handle.