CircularBase Class |
[This is preliminary documentation and is subject to change.]
Base class for any kind of circular geometry
Inheritance HierarchySystemObject
Infrastructure.Geometry.CurvesCurve
Infrastructure.Geometry.CurvesCircularBase
Infrastructure.Geometry.CurvesCircle3Points
Infrastructure.Geometry.CurvesCircularArc
Infrastructure.Geometry.CurvesCurve
Infrastructure.Geometry.CurvesCircularBase
Infrastructure.Geometry.CurvesCircle3Points
Infrastructure.Geometry.CurvesCircularArc
Namespace: Infrastructure.Geometry.Curves
Assembly: Infrastructure.Geometry (in Infrastructure.Geometry.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
SyntaxC#
public abstract class CircularBase : Curve
The CircularBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CircularBase |
Creates a circular curve from the provided points
|
Properties| Name | Description | |
|---|---|---|
 | Begin |
The first point of the curve
(Inherited from Curve.) |
| Center |
The center point of the circle on which the arc is positioned
|
 | CenterAngle |
The angle formed between the lines of center to head and center to tail
|
| End |
The last point of the curve
(Inherited from Curve.) |
| IsValid |
Determines if the data provided makes for a valid circle
|
| NumberOfPointsRequiredForRendering |
Determines how many points the curve needs in order to be rendered correctly
(Overrides CurveNumberOfPointsRequiredForRendering.) |
| Points |
The list of points that make up the curve
(Inherited from Curve.) |
| Radius |
The distance between the center and any point on the arc
|
Methods| Name | Description | |
|---|---|---|
| CalculatePointOnPosition |
Calculates the coordinates of the point at the requested, relative, position
|
| CheckRelativeParameters |
Checks the given relative parameters if they are OK
(Overrides CurveCheckRelativeParameters(Double, Double).) |
| DetermineRelativePart | (Overrides CurveDetermineRelativePart(Double, Double).) |
 | GetAbsolutePart(Double, Double) |
Retrieves an absolute part of the curve as new curve
(Inherited from Curve.) |
| GetAbsolutePart(Double, Double, Origin) |
Retrieves an absolute part of the curve as a new curve.
The origin parameter will dictate the direction of the curve
(Inherited from Curve.) |
| GetCoordinateSystemOnRelativePosition |
Returns the coordinate system in a given point on the curve
(Overrides CurveGetCoordinateSystemOnRelativePosition(Double, CoordinateSystemAdjustment).) |
| GetPointOnPosition |
Retrieve a point on the specified position of the curve
(Overrides CurveGetPointOnPosition(Double).) |
| GetPositions |
Generate a list of relative values that represent positions on the curve.
All values are between 0 and 1
(Inherited from Curve.) |
| GetPositionsByApproximation |
Generate a list of relative values that represent positions on the curve.
The amount of values returned is determined by GetSegmentCount (Inherited from Curve.) |
| GetPositionsByCount |
Generate a number of relative values that represent positions on the curve.
All values are between 0 and 1
(Inherited from Curve.) |
| GetRelativePart(Double, Double) |
Retrieves a relative part of the curve as new curve
(Inherited from Curve.) |
| GetRelativePart(Double, Double, Origin) |
Retrieves a relative part of the curve as a new curve.
The origin parameter will dictate the direction of the curve
(Inherited from Curve.) |
 | GetSegmentCount |
Determines out of how many "segments" the curve should exist when rendering.
(Overrides CurveGetSegmentCount.) |
| GetTangentVector |
Retrieves the tangent vector of the curve at the specified position
(Overrides CurveGetTangentVector(Double).) |
| IsPointOn |
Verifies the given point is on the curve
(Inherited from Curve.) |
| Length |
Determines the length of the curve, in meters
(Overrides CurveLength.) |
Fields| Name | Description | |
|---|---|---|
 | CenterToHead |
Vector that describes the change in XYZ from the center point of the circle to the head of the circumference
|
| CenterToIntermediate |
Vector that describes the change in XYZ from the center point to an intermediate point on the circumference
|
 | Precision |
The precision of doubles used when doing calculations / comparisons
|
| ZNormalVector |
Vector that describes the normal of the Z axis
|
Remarks
The code found in CreateVectors(IEnumerablePoint) and SolveArc(Double) comes from the following SO:
https://stackoverflow.com/a/16641390
See Also