RebarShapeDefinitionBySegments

Public Class

Definition of a shape in terms of one or more straight segments of rebar, with arc bends between the segments.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Structure.RebarShapeDefinition
Autodesk.Revit.DB.Structure.RebarShapeDefinitionBySegments

Namespace: Autodesk.Revit.DB.Structure

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class RebarShapeDefinitionBySegments : RebarShapeDefinition

The RebarShapeDefinitionBySegments type exposes the following members.

Constructors

Name

Description

---

Public Method
RebarShapeDefinitionBySegments

Create a rebar shape definition with a given number of segments.

---

Properties

Name

Description

---

Public Property

Complete

Report whether the shape definition is fully constrained.
(Inherited from RebarShapeDefinition)

---

Public Property

IsPlanar

Reports whether the shape definition lies within a plane: false if a spiral, true in all other cases.
(Inherited from RebarShapeDefinition)

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RebarShapeDefinition)

---

Public Property

MajorSegmentIndex

Index of a segment that can be considered the most important. Revit attempts to preserve the orientation of this segment when a Rebar instance changes its RebarShape to one with a different number of segments.

---

Public Property

NumberOfSegments

The number of straight segments in this shape.

---

Public Property

NumberOfVertices

The number of vertices in this shape, always equal to NumberOfSegments + 1.

---

Methods

Name

Description

---

Public Method
AddBendDefaultRadius

Specify a default-radius bend.

---

Public Method
AddBendVariableRadius

Specify a variable-radius bend.

---

Public Method

AddConstraintParallelToSegment

Constrain the length of a segment by parameterizing its length.

---

Public Method
AddConstraintToSegment

Add a constraint that helps determine the length of a segment.

---

Public Method
AddFormulaParameter

Add a formula-driven parameter to the shape definition.
(Inherited from RebarShapeDefinition)

---

Public Method
AddListeningDimensionBendToBend

Specify a dimension between two bends, measured by a read-only parameter.

---

Public Method

AddListeningDimensionSegmentToBend

Specify a dimension perpendicular to one fixed-direction segment, referring to that segment and some other bend in the shape, measured by a read-only parameter.

---

Public Method
AddListeningDimensionSegmentToSegment

Specify a dimension perpendicular to two fixed-direction segments, measured by a read-only parameter.

---

Public Method
AddParameter

Add a parameter to the shape definition.
(Inherited from RebarShapeDefinition)

---

Public Method
CheckDefaultParameterValues

Check that the shape can be solved with the default parameter values.
(Inherited from RebarShapeDefinition)

---

Public Method

Dispose

(Inherited from RebarShapeDefinition)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetParameterDefaultValue

Return the parameter’s default value as stored in the definition.
(Inherited from RebarShapeDefinition)

---

Public Method

GetParameterFormula

Return the parameter’s formula, if one is associated with it.
(Inherited from RebarShapeDefinition)

---

Public Method

GetParameters

Return the Ids of the shared parameters in the Definition.
(Inherited from RebarShapeDefinition)

---

Public Method

GetSegment

Return a reference to one of the segments in the definition.

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

GetVertex

Return a reference to one of the vertices in the definition.

---

Public Method

HasParameter

Whether the definition stores the parameter.
(Inherited from RebarShapeDefinition)

---

Public Method
RemoveParameter

Remove the parameter from the definition.
(Inherited from RebarShapeDefinition)

---

Public Method
RemoveParameterFromSegment

Remove constraints from a segment.

---

Public Method

SetParameterDefaultValue

Change the parameter’s value as stored in the definition.
(Inherited from RebarShapeDefinition)

---

Public Method

SetParameterFormula

Associate a formula with the parameter.
(Inherited from RebarShapeDefinition)

---

Public Method

SetSegmentAs180DegreeBend(Int32)

Indicates that a segment is a “virtual” segment introduced to describe a 180-degree bend. The radius of the bend will be taken from the Bar Type.

---

Public Method

SetSegmentAs180DegreeBend(Int32, ElementId, Boolean)

Indicate that a segment is a “virtual” segment introduced to describe a 180-degree bend. The radius of the bend will be driven by radiusParam.

---

Public Method
SetSegmentFixedDirection

Fix the direction of a segment.

---

Public Method
SetSegmentVariableDirection

Remove the fixed direction from a segment.

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

The segments are represented by RebarShapeSegment objects. The segments are numbered starting with 0, and they have a direction; so the beginning of the shape is end 0 of segment 0, and the end of the shape is end 1 of segment (NumberOfSegments-1).

The ends and junctions are represented by RebarShapeVertex objects. The number of vertices is always one greater than the number of segments. The first vertex represents the start of the shape; the last vertex represents the end of the shape; and the intermediate vertices represent the bends between segments.