RebarFreeFormAccessor

Description:
A class that is used to access the properties and capabilities of free-form Rebar.

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.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Structure.RebarFreeFormAccessor

public class RebarFreeFormAccessor : IDisposable

Public Class RebarFreeFormAccessor
	Implements IDisposable

public ref class RebarFreeFormAccessor : IDisposable

type RebarFreeFormAccessor = 
    class
        interface IDisposable
    end

Name	Return Type	Description	Inherited From
M AddUpdatingSharedParameter(ElementId)	None	Add existing shared parameter as a dependency for the calculation of the rebar curves.
M CanBeHookNormal(Int32, Int32, XYZ)	Boolean	Obsolete. A vector can be termination's (e.g. hook, crank) normal if for a bar specified by index, the bar direction is not parallel with the vector.
M CanBeTerminationPlaneNormal(Int32, Int32, XYZ)	Boolean	A vector can be termination (e.g. hook, crank) plane normal if for a bar specified by index, the bar direction is not parallel with the vector.
M DisconnectFromServer()	None	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.
M Dispose()	None	Releases all resources used by the RebarFreeFormAccessor
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetCouplerIdAtIndex(Int32, Int32)	ElementId	Gets the id of the Rebar Coupler that is applied to the bar with index barPositionIndex at the specified end.
M GetCrankTypeIdAtIndex(Int32, Int32)	ElementId	Gets the id of the Rebar Crank Type that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetCustomDistributionPath()	IList<Curve>	Gets the custom distribution path for free form rebar set.
M GetEndTreatmentTypeIdAtIndex(Int32, Int32)	ElementId	Gets the id of the EndTreatmentType that is applied to the bar with index barPositionIndex at the specified end.
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetHookOrientationAngle(Int32)	Double	Obsolete. Get the termination's rotation angle at end. The angle is used for both hook and crank.
M GetHookOrientationAngleAtIndex(Int32, Int32)	Double	Obsolete. Gets the termnination's rotation angle that is applied to this Rebar at the bar with index barPositionIndex at the specified end. The rotation angle it's the same for both hook and crank.
M GetHookOrientationAtIndex(Int32, Int32)	RebarHookOrientation	Obsolete. Gets the termination's orientation that is applied to this Rebar at the bar with index barPositionIndex at the specified end. The orientation it's the same for both hook and crank.
M GetHookPlaneNormalForBarIdx(Int32, Int32)	XYZ	Obsolete. Returns the plane's normal in which the termination (e.g. hook, crank) at end of bar with index barPositionIndex will stay. The plane's normal is used for both hook and crank.
M GetHookTypeIdAtIndex(Int32, Int32)	ElementId	Gets the id of the RebarHookType that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetServerGUID()	Guid	Returns the GUID of the API server.
M GetShapeIdAtIndex(Int32)	ElementId	Gets the Rebar Shape id for the bar with index barPositionIndex.
M GetTerminationOrientationAtIndex(Int32, Int32)	RebarTerminationOrientation	Gets the termination's (e.g. hook, crank ) orientation that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetTerminationPlaneNormalForBarIndex(Int32, Int32)	XYZ	Gets the plane's normal in which the termination (e.g. hook, crank) at end of bar with index barPositionIndex will stay.
M GetTerminationRotationAngleAtIndex(Int32, Int32)	Double	Gets the termination (e.g hook,crank) rotation angle that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M GetUpdatingSharedParameters()	IList<ElementId>	Get the shared parameters listed as dependencies in the calculation of the rebar curves
M HasValidAlignedServer()	Boolean	Returns true if the current rebar is created with the Aligned Free Form rebar server, false otherwise.
M HasValidServer()	Boolean	Returns true if the current rebar contains a valid server GUID, false otherwise.
M IsBarMatchedWithShapeInReverseOrder(Int32)	Boolean	Checks if the bar at index barPositionIndex it's matched in reversed order with its shape.
M IsUnconstrained()	Boolean	Returns true if the current rebar doesn't contains a valid server GUID, or contains a valid server GUID and no valid constraints.
M RemoveUpdatingSharedParameter(ElementId)	None	Remove existing shared parameter as a dependency for the calculation of the rebar curves.
M SetCurves(IList<CurveLoop>)	RebarFreeFormValidationResult
M SetCurves(IList<IList<Curve>>)	RebarFreeFormValidationResult
M SetHookOrientationAngle(Int32, Double)	None	Obsolete. Set the termination's rotation angle at end. The angle will be used for both hook and crank. Will throw exception if the rebar has valid constraints.
M SetHookPlaneNormalForBarIdx(Int32, Int32, XYZ)	None	Obsolete. Set the plane's normal in which the termination at end of bar with index barPositionIndex will stay. The plane's normal will be used for both hook and crank. Will throw exception if the rebar has valid constraints.
M SetLayoutAsFixedNumber(Int32)	None	Sets the Layout Rule property of rebar set to Fixed Number.
M SetLayoutAsMaximumSpacing(Double)	None	Sets the Layout Rule property of rebar set to Maximum Spacing.
M SetLayoutAsMinimumClearSpacing(Double)	None	Sets the Layout Rule property of rebar set to Minimum Clear Spacing.
M SetLayoutAsNumberWithSpacing(Int32, Double)	None	Sets the Layout Rule property of rebar set to Number With Spacing.
M SetLayoutAsSingle()	None	Sets the Layout Rule property of rebar set to Single.
M SetReportedShape(ElementId)	None	This method changes the RebarShape of a Free Form Rebar that is using RebarWorkInstructions.Straight property to the provided RebarShape.
M SetTerminationPlaneNormalForBarIndex(Int32, Int32, XYZ)	None	Sets the plane's normal in which the termination (e.g. hook, crank) at end of bar with index barPositionIndex will stay. Will throw exception if the rebar has valid constraints.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P AlignedFreeFormSetOrientationOptions	AlignedFreeFormSetOrientationOptions	Orientation options for an Aligned Free Form Rebar set.
P CycleCounter	int	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.
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P RebarStyle	RebarStyle	Identifies the RebarStyle of the current Rebar element.
P StirrupTieAttachmentType	StirrupTieAttachmentType	Identifies the StirrupTieAttachmentType of the current Rebar element. The RebarStyle of the Rebar element must be StirrupTie.
P WorkshopInstructions	RebarWorkInstructions	Identifies the workshop instructions of the current Rebar element.