RebarContainerAppendItemFromCurves Method

Appends an Item to the RebarContainer. Fills its data on base of the Rebar.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public RebarContainerItem AppendItemFromCurves(
	RebarStyle style,
	RebarBarType barType,
	RebarHookType startHook,
	RebarHookType endHook,
	XYZ normal,
	IList<Curve> curves,
	RebarHookOrientation startHookOrient,
	RebarHookOrientation endHookOrient,
	bool useExistingShapeIfPossible,
	bool createNewShape
)

Public Function AppendItemFromCurves ( 
	style As RebarStyle,
	barType As RebarBarType,
	startHook As RebarHookType,
	endHook As RebarHookType,
	normal As XYZ,
	curves As IList(Of Curve),
	startHookOrient As RebarHookOrientation,
	endHookOrient As RebarHookOrientation,
	useExistingShapeIfPossible As Boolean,
	createNewShape As Boolean
) As RebarContainerItem

public:
RebarContainerItem^ AppendItemFromCurves(
	RebarStyle style, 
	RebarBarType^ barType, 
	RebarHookType^ startHook, 
	RebarHookType^ endHook, 
	XYZ^ normal, 
	IList<Curve^>^ curves, 
	RebarHookOrientation startHookOrient, 
	RebarHookOrientation endHookOrient, 
	bool useExistingShapeIfPossible, 
	bool createNewShape
)

member AppendItemFromCurves : 
        style : RebarStyle * 
        barType : RebarBarType * 
        startHook : RebarHookType * 
        endHook : RebarHookType * 
        normal : XYZ * 
        curves : IList<Curve> * 
        startHookOrient : RebarHookOrientation * 
        endHookOrient : RebarHookOrientation * 
        useExistingShapeIfPossible : bool * 
        createNewShape : bool -> RebarContainerItem

Parameters

style RebarStyle: The usage of the bar, "standard" or "stirrup/tie".
barType RebarBarType: A RebarBarType element that defines bar diameter, bend radius and material of the rebar.
startHook RebarHookType: A RebarHookType element that defines the hook for the start of the bar. If this parameter is , it means to create a rebar with no hook.
endHook RebarHookType: A RebarHookType element that defines the hook for the end of the bar. If this parameter is , it means to create a rebar with no hook.
normal XYZ: The normal to the plane that the rebar curves lie on.
curves IListCurve: An array of curves that define the shape of the rebar curves. They must belong to the plane defined by the normal and origin. Bends and hooks should not be included in the array of curves.
startHookOrient RebarHookOrientation: Defines the orientation of the hook plane at the start of the rebar with respect to the orientation of the first curve and the plane normal. Only two values are permitted: Value = Right: The hook is on your right as you stand at the end of the bar, with the bar behind you, taking the bar's normal as "up." Value = Left: The hook is on your left as you stand at the end of the bar, with the bar behind you, taking the bar's normal as "up."
endHookOrient RebarHookOrientation: Defines the orientation of the hook plane at the end of the rebar with respect to the orientation of the last curve and the plane normal. Only two values are permitted: Value = Right: The hook is on your right as you stand at the end of the bar, with the bar behind you, taking the bar's normal as "up." Value = Left: The hook is on your left as you stand at the end of the bar, with the bar behind you, taking the bar's normal as "up."
useExistingShapeIfPossible Boolean: Attempts to assign a RebarShape from those existing in the document. If no shape matches, NewRebar returns or creates a new shape, according to the parameter createNewShape. When both parameters are "true", the behavior is the same as sketching rebar in the UI. At least one of these parameters must be "true". If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to false, and a RebarShape cannot be found with both matching curves and hooks, then this method will perform a second search, ignoring hook information.
createNewShape Boolean: Creates a shape in the document to match the curves, hooks, and style specified, and assigns it to the new rebar instance. Shape creation will not succeed unless one or more other shapes already exist in the document, and these shapes have enough shape parameters to define a shape for these curves.

Return Value

RebarContainerItem
The Rebar Container Item.

Exceptions

Exception	Condition
ArgumentException	The input curves is empty. -or- The input curves contains at least one curve which is not a bound Line or bound Arc and is not supported for this operation. -or- curves do not form a valid CurveLoop. -or- The input curves contains at least one helical curve and is not supported for this operation.
ArgumentNullException	A non-optional argument was null
ArgumentOutOfRangeException	normal has zero length. -or- A value passed for an enumeration argument is not a member of that enumeration
ArgumentsInconsistentException	Both useExistingShapeIfPossible and createNewShape are false. -or- curves contains non-fillet arcs with radii that are less than the minimum bend radius for the RebarBarType and bar style.

Example

C++

Copy

void AddItemsToRebarContainer(RebarContainer container, FamilyInstance beam, RebarBarType barType, RebarHookType hookType)
{
    // Define the rebar geometry information - Line rebar
    LocationCurve location = beam.Location as LocationCurve;
    XYZ origin = location.Curve.GetEndPoint(0);
    // create rebar along the length of the beam
    XYZ rebarLineEnd = location.Curve.GetEndPoint(1);
    Line line = Line.CreateBound(origin, rebarLineEnd);
    XYZ normal = new XYZ(1, 0, 0);
    Curve rebarLine = line.CreateOffset(0.5, normal);

    // Create the line rebar
    IList<Curve> curves = new List<Curve>();
    curves.Add(rebarLine);

    RebarContainerItem item = container.AppendItemFromCurves(RebarStyle.Standard, barType, hookType, hookType, normal, curves, RebarHookOrientation.Right, RebarHookOrientation.Left,
                                                                true, true);

    if (null != item)
    {
        // set specific layout for new rebar as fixed number, with 10 bars, distribution path length of 1.5'
        // with bars of the bar set on the same side of the rebar plane as indicated by normal
        // and both first and last bar in the set are shown
        item.SetLayoutAsFixedNumber(10, 1.5, true, true, true);
    }

    // Hide the new item in the active view
    container.SetItemHiddenStatus(container.Document.ActiveView, item.ItemIndex, true);
}

Private Sub AddItemsToRebarContainer(container As RebarContainer, beam As FamilyInstance, barType As RebarBarType, hookType As RebarHookType)
    ' Define the rebar geometry information - Line rebar
    Dim location As LocationCurve = TryCast(beam.Location, LocationCurve)
    Dim origin As XYZ = location.Curve.GetEndPoint(0)
    ' create rebar along the length of the beam
    Dim rebarLineEnd As XYZ = location.Curve.GetEndPoint(1)
    Dim line__1 As Line = Line.CreateBound(origin, rebarLineEnd)
    Dim normal As New XYZ(1, 0, 0)
    Dim rebarLine As Curve = line__1.CreateOffset(0.5, normal)

    ' Create the line rebar
    Dim curves As IList(Of Curve) = New List(Of Curve)()
    curves.Add(rebarLine)

    Dim item As RebarContainerItem = container.AppendItemFromCurves(RebarStyle.Standard, barType, hookType, hookType, normal, curves, _
        RebarHookOrientation.Right, RebarHookOrientation.Left, True, True)

    If item IsNot Nothing Then
        ' set specific layout for new rebar as fixed number, with 10 bars, distribution path length of 1.5'
        ' with bars of the bar set on the same side of the rebar plane as indicated by normal
        ' and both first and last bar in the set are shown
        item.SetLayoutAsFixedNumber(10, 1.5, True, True, True)
    End If

    ' Hide the new item in the active view
    container.SetItemHiddenStatus(container.Document.ActiveView, item.ItemIndex, True)
End Sub

Reference

RebarContainer Class

Autodesk.Revit.DB.Structure Namespace