2027 Members
Changes 0
M

RebarFreeFormAccessor Methods

Name Return Type Description Inherited From
M AddUpdatingSharedParameter(ElementId) None Add existing shared parameter as a dependency for the calculation of the rebar curves.
M CanBeTerminationPlaneNormal(Int32, Int32, XYZ) Boolean A vector can be termination (e.g. hook, crank) plane normal if for a bar specified by index, the bar direction is not parallel with the vector.
M DisconnectFromServer() None Sets the GUID of the API server to invalid value and removes all the server related data from the Rebar (ex. the current constraints and the handle tags are removed). Calling this method will result in a Rebar that will not react to host changes anymore, however it will still have all the properties that it used to have.
M Dispose() None
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M Flip3dPathSet() None For a free form set distributed along a 3D path, this method flips the distribution path. The set should not have Single layout rule.
M GetComputationDataFor3DPathSet() ComputationDataFor3DPathSet For a free form set distributed along a 3D path, this method gets the computation data.
M GetCouplerIdAtIndex(Int32, Int32) ElementId Gets the id of the Rebar Coupler that is applied to the bar with index barPositionIndex at the specified end.
M GetCrankTypeIdAtIndex(Int32, Int32) ElementId Gets the id of the Rebar Crank Type that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetCustomDistributionPath() IList<Curve> Gets the custom distribution path for free form rebar set.
M GetDefaultPositiveDirectionForMorphedTargetEdgesHandle(Document, TargetRebarEdge, Int32) XYZ Gets the default positive direction of the specified target rebar edge in terms of how Morphed Free Form Rebar is defining the default positive direction.
M GetEndTreatmentTypeIdAtIndex(Int32, Int32) ElementId Gets the id of the EndTreatmentType that is applied to the bar with index barPositionIndex at the specified end.
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetHookTypeIdAtIndex(Int32, Int32) ElementId Gets the id of the RebarHookType that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetServerGUID() Guid Returns the GUID of the API server.
M GetShapeIdAtIndex(Int32) ElementId Gets the Rebar Shape id for the bar with index barPositionIndex.
M GetTerminationOrientationAtIndex(Int32, Int32) RebarTerminationOrientation Gets the termination's (e.g. hook, crank ) orientation that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetTerminationPlaneNormalForBarIndex(Int32, Int32) XYZ Gets the plane's normal in which the termination (e.g. hook, crank) at end of bar with index barPositionIndex will stay.
M GetTerminationRotationAngleAtIndex(Int32, Int32) Double Gets the termination (e.g hook,crank) rotation angle that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M GetUpdatingSharedParameters() IList<ElementId> Get the shared parameters listed as dependencies in the calculation of the rebar curves
M HasValid3DPathServer() Boolean Returns true if the current rebar is created with the 3D Path Free Form rebar server, false otherwise.
M HasValidAlignedServer() Boolean Returns true if the current rebar is created with the Aligned Free Form rebar server, false otherwise.
M HasValidMorphedServer() Boolean Returns true if the current rebar is created with the Morphed Free Form rebar server, false otherwise.
M HasValidServer() Boolean Returns true if the current rebar contains a valid server GUID, false otherwise.
M HasValidSurfaceServer() Boolean Returns true if the current rebar is created with the Surface Free Form rebar server, false otherwise.
M IsBarMatchedWithShapeInReverseOrder(Int32) Boolean Checks if the bar at index barPositionIndex it's matched in reversed order with its shape.
M IsUnconstrained() Boolean Returns true if the current rebar doesn't contains a valid server GUID, or contains a valid server GUID and no valid constraints.
M IsValidRebarTargetForMorphedRebar(Rebar) Boolean Checks if the rebar can be used as a target for morphed rebar. A rebar is a valid target for morphed rebar if all the bars in set have the same number of segments and all are planar. Multiplanar bars are considered invalid.
M RemoveUpdatingSharedParameter(ElementId) None Remove existing shared parameter as a dependency for the calculation of the rebar curves.
M SetComputationDataFor3DPathSet(ComputationDataFor3DPathSet) None For a free form set distributed along a 3D path, this method sets the computation data.
M SetCurves(IList<CurveLoop>) RebarFreeFormValidationResult Set the curves into a free form Rebar. Will throw exception if the rebar has valid constraints.
M SetCurves(IList<IList<Curve>>) RebarFreeFormValidationResult Set the curves into a free form Rebar. Will throw exception if the rebar has valid constraints.
M SetLayoutAsCustomSpacing(String) None Sets the Layout Rule property of rebar set to Custom Spacing.
M SetLayoutAsFixedNumber(Int32) None Sets the Layout Rule property of rebar set to Fixed Number.
M SetLayoutAsMaximumSpacing(Double) None Sets the Layout Rule property of rebar set to Maximum Spacing.
M SetLayoutAsMinimumClearSpacing(Double) None Sets the Layout Rule property of rebar set to Minimum Clear Spacing.
M SetLayoutAsNumberWithSpacing(Int32, Double) None Sets the Layout Rule property of rebar set to Number With Spacing.
M SetLayoutAsSingle() None Sets the Layout Rule property of rebar set to Single.
M SetReportedShape(ElementId) None This method changes the RebarShape of a Free Form Rebar that is using RebarWorkInstructions.Straight property to the provided RebarShape.
M SetTerminationPlaneNormalForBarIndex(Int32, Int32, XYZ) None Sets the plane's normal in which the termination (e.g. hook, crank) at end of bar with index barPositionIndex will stay. Will throw exception if the rebar has valid constraints.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object