M

Rebar.CreateFromRebarShape

Description:
Creates a new shape driven Rebar, as an instance of a RebarShape. The instance will have the default shape parameters from the RebarShape, and its location is based on the bounding box of the shape in the shape definition.

public static Rebar CreateFromRebarShape(
	Document doc,
	RebarShape rebarShape,
	RebarBarType barType,
	Element host,
	XYZ origin,
	XYZ xVec,
	XYZ yVec
)

Public Shared Function CreateFromRebarShape ( 
	doc As Document,
	rebarShape As RebarShape,
	barType As RebarBarType,
	host As Element,
	origin As XYZ,
	xVec As XYZ,
	yVec As XYZ
) As Rebar

public:
static Rebar^ CreateFromRebarShape(
	Document^ doc, 
	RebarShape^ rebarShape, 
	RebarBarType^ barType, 
	Element^ host, 
	XYZ^ origin, 
	XYZ^ xVec, 
	XYZ^ yVec
)

static member CreateFromRebarShape : 
        doc : Document * 
        rebarShape : RebarShape * 
        barType : RebarBarType * 
        host : Element * 
        origin : XYZ * 
        xVec : XYZ * 
        yVec : XYZ -> Rebar

Document

doc

A document.
RebarShape

rebarShape

A RebarShape element that defines the shape of the rebar.
RebarBarType

barType

A RebarBarType element that defines bar diameter, bend radius and material of the rebar.
Element

host

The element to which the rebar belongs. The element must support rebar hosting; RebarHostData.
XYZ

origin

The lower-left corner of the shape's bounding box will be placed at this point in the project.
XYZ

xVec

The x-axis in the shape definition will be mapped to this direction in the project.
XYZ

yVec

The y-axis in the shape definition will be mapped to this direction in the project.

Return Value Rebar The newly created Rebar instance, or if the operation fails.

// Create 2 adjacent rebars with the given RebarShape and RebarBarType
private List<Rebar> CreateRebar(Document doc, Wall wall, RebarShape barShape, RebarBarType barType)
{
    List<Rebar> newRebars = new List<Rebar>();

    Rebar bar = Rebar.CreateFromRebarShape(doc, barShape, barType, wall, new XYZ(2, 0, 2), new XYZ(1, 0, 0), new XYZ(0, 0, 1));
    // call regenerate so that the TotalLength will be calculated before the transaction is committed
    doc.Regenerate();
    newRebars.Add(bar);

    // add a second bar adjacent to the first one
    double barLength = bar.TotalLength;
    bar = Rebar.CreateFromRebarShape(doc, barShape, barType, wall, new XYZ(2 + barLength, 0, 2), new XYZ(1, 0, 0), new XYZ(0, 0, 1));
    newRebars.Add(bar);

    return newRebars;
}

ArgumentException

The element host was not found in the given document. -or- host is not a valid rebar host.
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

xVec has zero length. -or- yVec has zero length.