RebarFreeFormAccessor
A class that is used to access the properties and capabilities of free-form Rebar.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.Structure.RebarFreeFormAccessor
Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class RebarFreeFormAccessor : IDisposableThe RebarFreeFormAccessor type exposes the following members.
Properties
Name
Description
Public Property
AlignedFreeFormSetOrientationOptions
Orientation options for an Aligned Free Form Rebar set.
Public Property
CycleCounter
Identifies the cycle counter. It can be zero or a pozitive number.
Its value is changed when the free form Rebar element is selected and the user press Space key -or- through the setter of this property -or- by the server if it considers that the counter reaches the maximum value and reset it (set it to 0). This property can be accessed just for Rebars that are controlled by a server.
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
Public Property
RebarStyle
Identifies the RebarStyle of the current Rebar element.
Public Property
StirrupTieAttachmentType
Identifies the StirrupTieAttachmentType of the current Rebar element. The RebarStyle of the Rebar element must be StirrupTie.
Public Property
WorkshopInstructions
Identifies the workshop instructions of the current Rebar element.
Methods
Name
Description
Public Method
AddUpdatingSharedParameter
Add existing shared parameter as a dependency for the calculation of the rebar curves.
Public Method
CanBeHookNormal
A vector can be hook normal if for a bar specified by index, the bar direction is not parallel with the vector.
Public Method
DisconnectFromServer
Sets the GUID of the API server to invalid value and removes all the server related data from the Rebar (ex. the current constraints and the handle tags are removed). Calling this method will result in a Rebar that will not react to host changes anymore, however it will still have all the properties that it used to have.
Public Method
Dispose
Releases all resources used by the RebarFreeFormAccessor
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
GetCouplerIdAtIndex
Gets the id of the Rebar Coupler that is applied to the bar with index barPositionIndex at the specified end.
Public Method
GetCustomDistributionPath
Gets the custom distribution path for free form rebar set.
Public Method
GetEndTreatmentTypeIdAtIndex
Gets the id of the EndTreatmentType that is applied to the bar with index barPositionIndex at the specified end.
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object)
Public Method
GetHookOrientationAngle
Get the hook orientation angle at end.
Public Method
GetHookOrientationAngleAtIndex
Gets the hook orientation angle that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
Public Method
GetHookOrientationAtIndex
Gets the hook orientation that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
Public Method
GetHookPlaneNormalForBarIdx
Returns the normal of plane in which the hook at end of bar with index barPositionIndex will stay.
Public Method
GetHookTypeIdAtIndex
Gets the id of the RebarHookType that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
Public Method
GetServerGUID
Returns the GUID of the API server.
Public Method
GetShapeIdAtIndex
Gets the Rebar Shape id for the bar with index barPositionIndex.
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
GetUpdatingSharedParameters
Get the shared parameters listed as dependencies in the calculation of the rebar curves
Public Method
HasValidAlignedServer
Returns true if the current rebar is created with the Aligned Free Form rebar server, false otherwise.
Public Method
HasValidServer
Returns true if the current rebar contains a valid server GUID, false otherwise.
Public Method
IsBarMatchedWithShapeInReverseOrder
Checks if the bar at index barPositionIndex it’s matched in reversed order with its shape.
Public Method
IsUnconstrained
Returns true if the current rebar doesn’t contains a valid server GUID, or contains a valid server GUID and no valid constraints.
Public Method
RemoveUpdatingSharedParameter
Remove existing shared parameter as a dependency for the calculation of the rebar curves.
Public Method
SetCurves(IList.CurveLoop.)
Set the curves into a free form Rebar. Will throw exception if the rebar has valid constraints.
Public Method
SetCurves(IList.IList.Curve..)
Set the curves into a free form Rebar. Will throw exception if the rebar has valid constraints.
Public Method
SetHookOrientationAngle
Set the hook orientation angle at end. Will throw exception if the rebar has valid constraints.
Public Method
SetHookPlaneNormalForBarIdx
Set the normal of plane in which the hook at end of bar with index barPositionIndex will stay. Will throw exception if the rebar has valid constraints.
Public Method
SetLayoutAsFixedNumber
Sets the Layout Rule property of rebar set to Fixed Number.
Public Method
SetLayoutAsMaximumSpacing
Sets the Layout Rule property of rebar set to Maximum Spacing.
Public Method
SetLayoutAsMinimumClearSpacing
Sets the Layout Rule property of rebar set to Minimum Clear Spacing.
Public Method
SetLayoutAsNumberWithSpacing
Sets the Layout Rule property of rebar set to Number With Spacing.
Public Method
SetLayoutAsSingle
Sets the Layout Rule property of rebar set to Single.
Public Method
SetReportedShape
This method changes the RebarShape of a Free Form Rebar that is using RebarWorkInstructions.Straight property to the provided RebarShape.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)
Remarks
Obtain an instance of this class from
GetFreeFormAccessor.
. The accessor includes a reference to the Rebar element. If the referenced Rebar element is deleted, using the methods form this class will throw exception.