Sign in
2027 Members
Changes 0
M

Rebar Methods

Name Return Type Description Inherited From
M AreBarIndicesValidForSplit(Document, ElementId, ISet<Int32>) Boolean Verifies that all bar indices in the input set are within the valid range of [0, NumberOfBarPositions - 2]. For a 3D Path or Morphed Free Form Rebar, single layout Rebar sets cannot result from a split, so the bar indices in the input set must not be consecutive. For a 3D Path Free Form Rebar, this also validates that each new set created by the split will have at least one bar plane intersecting a path edge.
M ArePhasesModifiable() Boolean Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) Element
M CanApplyPresentationMode(View) Boolean Checks if a presentation mode can be applied for this rebar in the given view.
M CanBeHidden(View) Boolean Indicates if the element can be hidden in the view. (Inherited from Element ) Element
M CanBeLocked() Boolean Identifies if the element can be locked. (Inherited from Element ) Element
M CanBeMatchedWithMultipleShapes() Boolean Checks if this Rebar can be matched with multiple Rebar Shapes.
M CanDeleteSubelement(Subelement) Boolean Checks if given subelement can be removed from the element. (Inherited from Element ) Element
M CanElementBeSplit(Document, ElementId) Boolean Checks if the element is a rebar that can be split.
M CanHaveTypeAssigned() Boolean Identifies if the element can have a type assigned. (Inherited from Element ) Element
M CanSuppressFirstOrLastBar(View, Int32) Boolean Checks if the first or last bar in rebar set can be hidden in the given view.
M CanUseHookType(ElementId) Boolean Checks if the specified RebarHookType id is of a valid RebarHookType for the Rebar's RebarBarType
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element ) Element
M ClearPresentationMode(View) None Sets the presentation mode for this rebar set to the default (either for a single view, or for all views).
M ComputeSpacingsBetweenBars(Document, String, Double) IList<Double> Computes the spacings between all bars as we would have a set with CustomSpacing layout, the customSpacingFormula and its length being distributionLength.
M ConstraintsCanBeEdited() Boolean For ShapeDriven Rebar: returns true, if the Rebar element's external constraints are available for editing using the RebarConstraintsManager class. It will return false if Rebar is in Group For FreeForm rebar: constraints can be edited if there is a valid external server Guid assigned to that Rebar
M ContainsValidArcRadiiForStyleAndBarType(IList<Curve>, RebarStyle, RebarBarType) Boolean Checks that all arcs in the chain of curves have radii that are not less than minimum bend radius for bar type and style
M CreateFreeForm(Document, Guid, RebarBarType, Element) Rebar Creates a free form rebar that can have constraints.
M CreateFreeForm(Document, RebarBarType, Element, IList<CurveLoop>, RebarStyle) RebarFreeFormCreationResult Creates a free form rebar that will be unconstrained. Constraints can't be added later to this rebar.
M CreateFreeForm(Document, RebarBarType, Element, IList<IList<Curve>>, RebarStyle) RebarFreeFormCreationResult Creates a free form rebar that will be unconstrained. Constraints can't be added later to this rebar.
M CreateFromCurves(Document, RebarStyle, RebarBarType, Element, XYZ, IList<Curve>, BarTerminationsData, Boolean, Boolean) Rebar Creates a new instance of a shape driven Rebar element within the project.
M CreateFromCurvesAndShape(Document, RebarShape, RebarBarType, Element, XYZ, IList<Curve>, BarTerminationsData) Rebar Creates a new instance of a shape driven Rebar element within the project. The instance will have the default shape parameters from the RebarShape. The curves and terminations data should match the rebar shape definition. If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to false, the hooks and their rotation angles can be different than the defaults specified in the RebarShape. If the RebarShapeDefinesEndTreatment flag in ReinforcementSettings has been set to false, the end treatments can be different than the defaults specified in the RebarShape.
M CreateFromRebarShape(Document, RebarShape, RebarBarType, Element, XYZ, XYZ, XYZ) Rebar 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. Hooks and cranks are removed from the shape before computing its bounding box. If appropriate hooks and cranks can be found in the document, they will be assigned arbitrarily.
M DeleteEntity(Schema) Boolean Deletes the existing entity created by %schema% in the element (Inherited from Element ) Element
M DeleteSubelement(Subelement) Boolean Removes a subelement from the element. (Inherited from Element ) Element
M DeleteSubelements(IList<Subelement>) Boolean Removes the subelements from the element. (Inherited from Element ) Element
M Dispose() None (Inherited from Element ) Element
M DoesBarExistAtPosition(Int32) Boolean Checks whether a bar is included at the specified position.
M EnableCrankLengthOverride(Boolean) None Enables or disables the ability to override crank lengths for this rebar instance.
M EnableHookLengthOverride(Boolean) None Enables or disables the ability to override hook lengths for this rebar instance.
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M EvaluateAllParameterValues() IList<EvaluatedParameter> Evaluates all the parameters' values of the element. (Inherited from Element ) Element
M EvaluateParameterValues(ISet<ElementId>) IList<EvaluatedParameter> Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) Element
M FindMatchingPredefinedPresentationMode(View) RebarPresentationMode Determines if there is a matching RebarPresentationMode for the current set of selected hidden and unhidden bars assigned to the given view.
M GetAllRebarShapeIds() IList<ElementId> Gets the ids of the RebarShapes elements that defines the shapes of the rebar.
M GetBarIndexFromReference(Reference) Int32 Given a reference that represents a part of a bar, this method will return the bar index.
M GetBendData() RebarBendData Gets the RebarBendData, containing bar and hook information, of the instance.
M GetCenterlineCurves(Boolean, Boolean, Boolean, MultiplanarOption, Int32) IList<Curve> A chain of curves representing the centerline of the rebar.
M GetCouplerId(Int32) ElementId Get the id of the Rebar Coupler that is applied to the rebar at the specified end.
M GetCrankAngledLength(Int32) Double Gets the crank angled length at the indicated bar end. If the crank lengths are overriden will return the overriden value. Otherwise will return the value from the RebarBarType for the existing Crank Type.
M GetCrankLength(Int32) Double Gets the crank length at the indicated bar end. If the crank lengths are overriden will return the overriden value. Otherwise will return the value from the RebarBarType for the existing Crank Type.
M GetCrankOffsetLength(Int32) Double Gets the crank offset length at the indicated bar end. If the crank lengths are overriden will return the overriden value. Otherwise will return the value from the RebarBarType for the existing Crank Type.
M GetCrankRatio(Int32) Double Gets the crank ratio at the indicated bar end.
M GetCrankStraightLength(Int32) Double Gets the crank straight length at the indicated bar end. If the crank lengths are overriden will return the overriden value. Otherwise will return the value from the RebarBarType for the existing Crank Type.
M GetCrankTypeId(Int32) ElementId Gets the id of the Crank Type id that is applied to the rebar.
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) Element
M GetEndTreatmentTypeId(Int32) ElementId Get the id of the EndTreatmentType that is applied to the rebar.
M GetEntity(Schema) Entity Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element ) Element
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. (Inherited from Element ) Element
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) Element
M GetExternalResourceReferenceExpanded(ExternalResourceType) IList<ExternalResourceReference> Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) Element
M GetExternalResourceReferences() IDictionary<ExternalResourceType,ExternalResourceReference> Gets the map of the external resource references referenced by the element. (Inherited from Element ) Element
M GetExternalResourceReferencesExpanded() ExternalResourceType Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) Element
M GetFreeFormAccessor() RebarFreeFormAccessor Returns an interface providing access to free-form properties and methods for this Rebar element.
M GetFullGeometryForView(View) GeometryElement Generates full geometry for the Rebar for a specific view.
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) Element
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetHookTypeId(Int32) ElementId Get the id of the RebarHookType that is applied to the rebar.
M GetHostId() ElementId The element that contains the rebar.
M GetLapLength(Int32) Double Gets the lap length that is used for the specified end - 0 for start, 1 for end.
M GetLayoutFormula(Boolean) String Gets the formula that is used to compute the spacings between bars.
M GetMaterialArea(ElementId, Boolean) Double Gets the area of the material with the given id. (Inherited from Element ) Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element ) Element
M GetMaterialVolume(ElementId) Double Gets the volume of the material with the given id. (Inherited from Element ) Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. (Inherited from Element ) Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. (Inherited from Element ) Element
M GetMovedBarTransform(Int32) Transform Returns a transform representing the movement of the bar relative to its default position along the distribution path.
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element ) Element
M GetOverridableCrankParameters() RebarCrankOverridableParameters Gets the formula parameter ids defined in the RebarShape family which are associated with crank length, crank offset length, crank straight length and crank angled length parameters.
M GetOverridableHookParameters(ISet<ElementId>, ISet<ElementId>, ISet<ElementId>, ISet<ElementId>) None Outputs the formula parameter ids defined in the RebarShape family which are associated with hook length and hook tangent length parameters.
M GetParameter(ForgeTypeId) Parameter Retrieves a parameter from the element given identifier. (Inherited from Element ) Element
M GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. (Inherited from Element ) Element
M GetParameterValueAtIndex(ElementId, Int32) ParameterValue Get the parameter value for a bar at the specified index.
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element ) Element
M GetPresentationMode(View) RebarPresentationMode Gets the presentation mode for this rebar set when displayed in the given view.
M GetRebarConstraintsManager() RebarConstraintsManager Returns an object for managing the external constraints on the Rebar element
M GetRebarSplice(Int32) RebarSplice Gets the rebar splice at the specified bar end - 0 for start, 1 for end.
M GetReinforcementRoundingManager() RebarRoundingManager Returns an object for managing reinforcement rounding override settings.
M GetShapeDrivenAccessor() RebarShapeDrivenAccessor Returns an interface providing access to shape-driven properties and methods for this Rebar element.
M GetShapeId() ElementId Returns the id of the RebarShape element that defines the shape of the rebar.
M GetSpacingsBetweenBars() IList<Double> Gets the spacings between all bars in set that have CustomSpacing layout. It will consider that there are no moved or removed bars from the set.
M GetSpliceStaggerLength(Int32) Double Gets the stagger length that is used for the specified end - 0 for start, 1 for end.
M GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element ) Element
M GetTerminationOrientation(Int32) RebarTerminationOrientation Gets the orientation of the termination's (e.g. hook, crank) 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.
M GetTerminationRotationAngle(Int32) Double Gets the termination's (e.g hook, crank) out of plane rotation angle at the specified end.
M GetTransformedCenterlineCurves(Boolean, Boolean, Boolean, MultiplanarOption, Int32) IList<Curve> A chain of curves representing the centerline of the rebar.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M GetTypeId() ElementId Returns the identifier of this element's type. (Inherited from Element ) Element
M GetValidTypes() ICollection<ElementId> Obtains a set of types that are valid for this element. (Inherited from Element ) Element
M HasPhases() Boolean Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) Element
M HasPresentationOverrides(View) Boolean Identifies if this Rebar has overridden default presentation settings for the given view.
M HookAngleMatchesRebarShapeDefinition(Int32, ElementId) Boolean 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.
M IsBarHidden(View, Int32) Boolean Identifies if a given bar in this rebar set is hidden in this view.
M IsCrankLengthOverrideEnabled() Boolean Returns true if the ability to override crank lengths is enabled for this rebar instance, false otherwise.
M IsCreatedPhaseOrderValid(ElementId) Boolean Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) Element
M IsCustomSpacingWithPredefinedNumberOfBars() Boolean Checks if the layout is defined as a Custom Spacing Layout with a predefined number of bars. Custom Spacing layout will have a predefined number of bars if the formula is fixed (not variable and without percentage members).
M IsDemolishedPhaseOrderValid(ElementId) Boolean Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) Element
M IsExternalFileReference() Boolean Determines whether this Element represents an external file. (Inherited from Element ) Element
M IsHidden(View) Boolean Identifies if the element has been permanently hidden in the view. (Inherited from Element ) Element
M IsHookLengthOverrideEnabled() Boolean Returns True if the ability to override hook lengths is enabled for this rebar instance, False otherwise.
M IsMonitoringLinkElement() Boolean Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) Element
M IsMonitoringLocalElement() Boolean Indicate whether an element is monitoring other local elements. (Inherited from Element ) Element
M IsPhaseCreatedValid(ElementId) Boolean Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) Element
M IsPhaseDemolishedValid(ElementId) Boolean Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) Element
M IsRebarFreeForm() Boolean Returns true if the rebar is free form and false if shape driven.
M IsRebarInSection(View) Boolean Identifies if this Rebar is cut by the view plane of the given view.
M IsRebarShapeDriven() Boolean Returns true if the rebar is shape driven and false if free form.
M IsUnobscuredInView(View) Boolean Checks if this rebar element is shown unobscured in a view.
M IsValidCustomSpacingFormula(Document, String) Boolean Checks if the specified formula is valid (has a valid syntax).
M IsValidType(ElementId) Boolean Checks if given type is valid for this element. (Inherited from Element ) Element
M LookupParameter(String) Parameter Attempts to find a parameter on the element which has the given name. (Inherited from Element ) Element
M MoveBarInSet(Int32, Transform) None This method applies the transformation matrix to the rebar bar at the desired position in the rebar set. If the bar was already moved, the method will concatenate the transformation matrix with the existing movement.
M RefersToExternalResourceReference(ExternalResourceType) Boolean Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) Element
M RefersToExternalResourceReferences() Boolean Determines whether this Element uses external resources. (Inherited from Element ) Element
M RemoveSplice(Int32) None Removes the splice relation at the specified end and all the Rebar Constraints involved in splice.
M ResetMovedBarTransform(Int32) None Reset the transformation representing the movement of the bar relative to its default position along the distribution path. The moved bar transform will be set to Identity.
M SetBarHiddenStatus(View, Int32, Boolean) None Sets the bar in this rebar set to be hidden or unhidden in the given view.
M SetBarIncluded(Boolean, Int32) None Sets if the bar at the desired index is included or not.
M SetCrankAngledLengthOverride(Int32, Double) None Sets the crank angled length at the indicated bar end as an override value.
M SetCrankLengthOverride(Int32, Double) None Sets the crank length at the indicated bar end as an override value.
M SetCrankOffsetLengthOverride(Int32, Double) None Sets the crank offset length at the indicated bar end as an override value.
M SetCrankRatioOverride(Int32, Double) None Sets the crank ratio at the indicated bar end as an override value.
M SetCrankStraightLengthOverride(Int32, Double) None Sets the crank straight length at the indicated bar end as an override value.
M SetCrankTypeId(Int32, ElementId) None Sets the id of the Crank Type to be applied to the rebar.
M SetEndTreatmentTypeId(Int32, ElementId) None Sets the id of the EndTreatmentType to be applied to the rebar. This can be done if and only if the end of the bar on which the end treatment is applied has no RebarCoupler on it, otherwise will throw an exception.
M SetEntity(Entity) None Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) Element
M SetHookTypeId(Int32, ElementId) None Set the id of the RebarHookType to be applied to the rebar.
M SetHostId(Document, ElementId) None The element that contains the rebar.
M SetLayoutFormula(String) None Sets the specified formula for custom spacing.
M SetPresentationMode(View, RebarPresentationMode) None Sets the presentation mode for this rebar set when displayed in the given view.
M SetTerminationOrientation(Int32, RebarTerminationOrientation) None Sets the orientation of the termination's (e.g. hook, crank) 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.
M SetTerminationRotationAngle(Int32, Double) None Sets the termination's (e.g hook, crank) out of plane rotation angle at the specified end.
M SetUnobscuredInView(View, Boolean) None Sets this rebar element to be shown unobscured in a view.
M SplitRebar(Document, ElementId, ISet<Int32>, Boolean, Boolean) IList<ElementId> Splits a rebar into multiple sets at specified bar indices. Given split indices (e.g., {ii, jj}) in barIndices, the function creates three rebar sets: from 0 to ii, ii+1 to jj, and jj+1 to NumberOfBarPositions - 1. Edge Case: A split at index 0 creates a first set with one bar; a split at the last index does nothing, as no bars follow. If a split is made at an index where the bar is not included, the split will still occur, and the unincluded bar will remain unchanged in the new set created after the split. This method applies to a Shape Driven Rebar whose definition is RebarShapeDefinitionBySegments, for 3D Path Free Form Rebar and for Morphed Free Form Rebar. For Morphed Free Form Rebar that targets Spiral or Lapped Circle shapes, split cannot be made.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object