| Revit 2016 API |
| Rebar Members |
| Rebar Class Methods Properties See Also |
The Rebar type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element.) |
| CanApplyPresentationMode |
Checks if a presentation mode can be applied for this rebar in the given view.
|
| CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element.) |
| CanBeLocked |
Identifies if the element can be locked.
(Inherited from Element.) |
| CanHaveAnalyticalModel |
Indicates whether the Element can have an Analytical Model.
(Inherited from Element.) |
| CanHaveTypeAssigned()()()() |
Identifies if the element can have a type assigned.
(Inherited from Element.) |
| CanUseHookType |
Checks if the specified RebarHookType id is of a valid RebarHookType for the Rebar's RebarBarType
|
| ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from Element.) |
| ClearPresentationMode |
Sets the presentation mode for this rebar set to the default (either for a single view, or for all views).
|
| ComputeDrivingCurves |
Compute the driving curves.
|
| ConstraintsCanBeEdited |
Returns true, if the Rebar element's external constraints are available for editing using the
RebarConstraintsManager class. Examples of where this method would return false are:
Rebar in Groups (which do not have constraints), or legacy, sketch-based Rebar elements
created before the introduction of RebarShape families in version 2009.
|
 | ContainsValidArcRadiiForStyleAndBarType |
Checks that all arcs in the chain of curves have radii that are not less than minimum bend radius for bar type and style
|
| CreateFromCurves |
Creates a new instance of a Rebar element within the project.
|
| CreateFromCurvesAndShape |
Creates a new instance of a Rebar element within the project.
The instance will have the default shape parameters from the RebarShape.
If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to true,
then both the curves and hooks must match the RebarShape definition.
Otherwise, the hooks can be different than the defaults specified in the RebarShape
|
| CreateFromRebarShape |
Creates a new 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.
Hooks are removed from the shape before computing its bounding box.
If appropriate hooks can be found in the document, they will be assigned arbitrarily.
|
| DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from Element.) |
| Dispose | (Inherited from Element.) |
| DoesBarExistAtPosition |
Checks whether a bar exists at the specified position.
|
| Equals | (Inherited from Object.) |
| FindMatchingPredefinedPresentationMode |
Determines if there is a matching RebarPresentationMode for the current set of selected hidden and unhidden bars assigned to the given view.
|
| GetAnalyticalModel |
Retrieves writeable Analytical Model for Element.
(Inherited from Element.) |
| GetAnalyticalModelId |
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from Element.) |
| GetBarPositionTransform |
Return a transform representing the relative position of any
individual bar in the set.
|
| GetBendData |
Gets the RebarBendData, containing bar and hook information, of the instance.
|
| GetCenterlineCurves(Boolean, Boolean, Boolean) |
A chain of curves representing the centerline of the rebar.
|
| GetCenterlineCurves(Boolean, Boolean, Boolean, MultiplanarOption) |
A chain of curves representing the centerline of the rebar.
|
| GetDistributionPath |
The distribution path of a rebar set.
|
| GetEntity |
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise.
(Inherited from Element.) |
| GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element.) |
| GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from Element.) |
| GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.) |
| GetExternalResourceReferences |
Gets the full map of the external resource references referenced
by the element.
(Inherited from Element.) |
| GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element.) |
| GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHookOrientation |
Returns the orientation of the hook plane at the start or at the end of the rebar with respect to the orientation of the first or the last curve and the plane normal.
|
| GetHookTypeId |
Get the id of the RebarHookType to be applied to the rebar.
|
| GetHostId |
The element that contains the rebar.
|
| GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from Element.) |
| GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from Element.) |
| GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from Element.) |
| GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from Element.) |
| GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from Element.) |
| GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from Element.) |
| GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element.) |
| GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element.) |
| GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from Element.) |
| GetPresentationMode |
Gets the presentation mode for this rebar set when displayed in the given view.
|
| GetRebarConstraintsManager |
Returns an object for managing the external constraints on the Rebar element
|
| GetReinforcementRoundingManager |
Returns an object for managing reinforcement rounding override settings.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeId |
Returns the identifier of this element's type.
(Inherited from Element.) |
| GetValidTypes()()()() |
Obtains a set of types that are valid for this element.
(Inherited from Element.) |
| HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element.) |
| HasPresentationOverrides |
Identifies if this Rebar has overridden default presentation settings for the given view.
|
| HookAngleMatchesRebarShapeDefinition |
Checks that the hook angle of the specified RebarHookType matches the hook angle used in the Rebar's RebarShape at the specified end of the bar.
|
| IsBarHidden |
Identifies if a given bar in this rebar set is hidden in this view.
|
| IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from Element.) |
| IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element.) |
| IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element.) |
| IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from Element.) |
| IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element.) |
| IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element.) |
| IsRebarInSection |
Identifies if this Rebar is shown as a cross-section in the given view.
|
| IsSolidInView |
Checks if this rebar element is shown solidly in a 3D view.
|
| IsUnobscuredInView |
Checks if this rebar element is shown unobscured in a view.
|
| IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from Element.) |
| LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element.) |
| RebarShapeMatchesCurvesAndHooks |
Checks if rebarShape matches curves and hooks.
If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to false,
then this method will only check the curves argument, and will ignore the hook information.
|
| RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from Element.) |
| RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from Element.) |
| ScaleToBox |
Move and resize the bar to fit within a specified box.
The arguments are interpreted as an arbitrary
rectangle in 3D with vertices: origin, origin+xVec,
origin+xVec+yVec, origin+yVec. The algorithm then
proceeds as follows. First the bar is given the
default values of the shape parameters from the shape
definition. Then, if it is possible to do so without
violating the shape definition, the parameter values
are scaled so that the width and height of the shape
(including bar thickness) match the lengths of xVec and yVec.
If there is no way to do this within the shape definition
due to overconstraining, a compromise is attempted, such as
scaling the whole shape until either the width or the
height is correct. Finally the shape is rotated to
match the coordinate system of the box. The algorithm
is the same one used in one-click placement.
|
| ScaleToBoxFor3D |
Move and resize a spiral or multiplanar instance to fit within a specified box.
The arguments are interpreted as an arbitrary rectangle in 3D with
vertices: origin, origin+xVec, origin+xVec+yVec, origin+yVec. One end of the
rebar shape is inscribed in this rectangle following the procedure described
for the ScaleToBox method. The other end is placed in the parallel plane at
distance (center-to-center) given by the height argument, in the
direction of (xVec x yVec).
Note that spiral shapes interpret the input arguments using a different convention
than multiplanar shapes. For spiral shapes, the spiral start will be placed in
the rectangle defined by origin, xVec, yVec, and the end of the spiral will be
placed in the parallel plane. For multiplanar shapes, the rebar is placed with
its primary shape definition located in the parallel plane defined by the height
argument, and its connector segments extending in the direction opposite (xVec x yVec).
This method replaces ScaleToBoxForSpiral() from prior releases.
|
| SetBarHiddenStatus |
Sets the bar in this rebar set to be hidden or unhidden in the given view.
|
| SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from Element.) |
| SetHookOrientation |
Defines the orientation of the hook plane at the start or at the end of the rebar with respect to the orientation of the first or the last curve and the plane normal.
|
| SetHookTypeId |
Set the id of the RebarHookType to be applied to the rebar.
|
| SetHostId |
The element that contains the rebar.
|
| SetLayoutAsFixedNumber |
Sets the Layout Rule property of rebar set to FixedNumber.
|
| SetLayoutAsMaximumSpacing |
Sets the Layout Rule property of rebar set to MaximumSpacing
|
| SetLayoutAsMinimumClearSpacing |
Sets the Layout Rule property of rebar set to MinimumClearSpacing
|
| SetLayoutAsNumberWithSpacing |
Sets the Layout Rule property of rebar set to NumberWithSpacing
|
| SetLayoutAsSingle |
Sets the Layout Rule property of rebar set to Single.
|
| SetPresentationMode |
Sets the presentation mode for this rebar set when displayed in the given view.
|
| SetSolidInView |
Sets this rebar element to be shown solidly in a 3D view.
|
| SetUnobscuredInView |
Sets this rebar element to be shown unobscured in a view.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | ArrayLength |
Identifies the distribution path length of rebar set.
|
| AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from Element.) |
| BarsOnNormalSide |
Identifies if the bars of the rebar set are on the same side of the rebar plane indicated by the normal.
|
| BaseFinishingTurns |
For a spiral, the number of finishing turns at the lower end of the spiral.
|
| BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element.) |
| Category | Retrieves a Category object that represents the category or sub category in which the
element resides. (Inherited from Element.) |
| CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from Element.) |
| DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from Element.) |
| DesignOption | Returns the design option to which the element belongs. (Inherited from Element.) |
| Document | Returns the Document in which the Element resides. (Inherited from Element.) |
| Geometry | Retrieves the geometric representation of the element. (Inherited from Element.) |
| GroupId |
The id of the group to which an element belongs.
(Inherited from Element.) |
| Height |
For a spiral, the overall height.
|
| Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element.) |
| IncludeFirstBar |
Identifies if the first bar in rebar set is shown.
|
| IncludeLastBar |
Identifies if the last bar in rebar set is shown.
|
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element.) |
| LayoutRule |
Identifies the layout rule of rebar set.
|
| LevelId |
The id of the level associated with the element.
(Inherited from Element.) |
| Location | This property is used to find the physical location of an element within a project. (Inherited from Element.) |
| MaxSpacing |
Identifies the maximum spacing between rebar in rebar set.
|
| MultiplanarDepth |
For a multiplanar rebar, the depth of the instance.
|
| Name | A human readable name for the Element. (Inherited from Element.) |
| Normal |
A unit-length vector normal to the plane of the rebar
|
| NumberOfBarPositions |
The number of potential bars in the set.
|
| OwnerViewId |
The id of the view that owns the element.
(Inherited from Element.) |
| Parameter[([( Guid])]) | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element.) |
| Parameter[([( BuiltInParameter])]) | Retrieves a parameter from the element given a parameter id. (Inherited from Element.) |
| Parameter[([( Definition])]) | Retrieves a parameter from the element based on its definition. (Inherited from Element.) |
| Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element.) |
| ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element.) |
| Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from Element.) |
| Pitch |
For a spiral, the pitch, or vertical distance traveled in one rotation.
|
| Quantity |
Identifies the number of bars in rebar set.
|
| RebarShapeId |
The RebarShape element that defines the shape of the rebar.
|
| ScheduleMark |
The Schedule Mark parameter. On creation, the Schedule Mark is set
to a value that is unique to the host, but it can be set to
any value.
|
| TopFinishingTurns |
For a spiral, the number of finishing turns at the upper end of the spiral.
|
| TotalLength |
The length of an individual bar multiplied by Quantity.
|
| UniqueId |
A stable unique identifier for an element within the document.
(Inherited from Element.) |
| ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from Element.) |
| Volume |
The volume of an individual bar multiplied by Quantity.
|
| WorksetId |
Get Id of the Workset which owns the element.
(Inherited from Element.) |