RebarShapeDefinitionBySegments Class

Definition of a shape in terms of one or more straight segments of rebar, with arc bends between the segments.
Inheritance Hierarchy
SystemObject
  Autodesk.Revit.DB.StructureRebarShapeDefinition
    Autodesk.Revit.DB.StructureRebarShapeDefinitionBySegments

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
 NameDescription
Public methodRebarShapeDefinitionBySegments Create a rebar shape definition with a given number of segments.
Top
Properties
 NameDescription
Public propertyComplete Report whether the shape definition is fully constrained.
(Inherited from RebarShapeDefinition)
Public propertyIsPlanar Reports whether the shape definition lies within a plane: false if a spiral, true in all other cases.
(Inherited from RebarShapeDefinition)
Public propertyIsValidObject Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RebarShapeDefinition)
Public propertyMajorSegmentIndex 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 propertyNumberOfSegments The number of straight segments in this shape.
Public propertyNumberOfVertices The number of vertices in this shape, always equal to NumberOfSegments + 1.
Top
Methods
 NameDescription
Public methodAddBendDefaultRadius Specify a default-radius bend.
Public methodAddBendVariableRadius Specify a variable-radius bend.
Public methodAddConstraintParallelToSegment Constrain the length of a segment by parameterizing its length.
Public methodAddConstraintToSegment Add a constraint that helps determine the length of a segment.
Public methodAddFormulaParameter Add a formula-driven parameter to the shape definition.
(Inherited from RebarShapeDefinition)
Public methodAddListeningDimensionBendToBend Specify a dimension between two bends, measured by a read-only parameter.
Public methodAddListeningDimensionSegmentToBend 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 methodAddListeningDimensionSegmentToSegment Specify a dimension perpendicular to two fixed-direction segments, measured by a read-only parameter.
Public methodAddParameter Add a parameter to the shape definition.
(Inherited from RebarShapeDefinition)
Public methodCheckDefaultParameterValues Check that the shape can be solved with the default parameter values.
(Inherited from RebarShapeDefinition)
Public methodDispose
(Inherited from RebarShapeDefinition)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetParameterDefaultValue Return the parameter's default value as stored in the definition.
(Inherited from RebarShapeDefinition)
Public methodGetParameterFormula Return the parameter's formula, if one is associated with it.
(Inherited from RebarShapeDefinition)
Public methodGetParameters Return the Ids of the shared parameters in the Definition.
(Inherited from RebarShapeDefinition)
Public methodGetSegment Return a reference to one of the segments in the definition.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetVertex Return a reference to one of the vertices in the definition.
Public methodHasParameter Whether the definition stores the parameter.
(Inherited from RebarShapeDefinition)
Public methodRemoveParameter Remove the parameter from the definition.
(Inherited from RebarShapeDefinition)
Public methodRemoveParameterFromSegment Remove constraints from a segment.
Public methodSetParameterDefaultValue Change the parameter's value as stored in the definition.
(Inherited from RebarShapeDefinition)
Public methodSetParameterFormula Associate a formula with the parameter.
(Inherited from RebarShapeDefinition)
Public methodSetSegmentAs180DegreeBend(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 methodSetSegmentAs180DegreeBend(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 methodSetSegmentFixedDirection Fix the direction of a segment.
Public methodSetSegmentVariableDirection Remove the fixed direction from a segment.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
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.

See Also