T_Rhino_Geometry_Circle - mcneel/rhinocommon-api-docs GitHub Wiki

Circle Structure

Represents a circle in 3D. The values used are a radius and an orthonormal frame of the plane containing the circle, with origin at the center.

The circle is parameterized by radians from 0 to 2 Pi given by

t -> center + cos(t)radiusxaxis + sin(t)radiusyaxis

where center, xaxis and yaxis define the orthonormal frame of the circle plane.

Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

[SerializableAttribute]
public struct Circle

VB

<SerializableAttribute>
Public Structure Circle

The Circle type exposes the following members.

Constructors

 

Name Description
Public method Circle(Double) Initializes a circle with center (0,0,0) in the world XY plane.
Public method Circle(Arc) Initializes a circle from an arc.
Public methodCode example Circle(Plane, Double) Initializes a circle on a plane with a given radius.
Public methodCode example Circle(Point3d, Double) Initializes a circle parallel to the world XY plane with given center and radius.
Public method Circle(Plane, Point3d, Double) Initializes a circle parallel to a given plane with given center and radius.
Public method Circle(Point3d, Point3d, Point3d) Initializes a circle through three 3d points. The start/end of the circle is at point1.
Public method Circle(Point3d, Vector3d, Point3d) Initializes a circle from two 3d points and a tangent at the first point. The start/end of the circle is at point "startPoint".
  Back to Top

Properties

 

Name Description
Public property BoundingBox Gets the circle's 3d axis aligned bounding box.
Public property Center Gets or sets the center point of this circle.
Public property Circumference Gets or sets the circumference of this circle.
Public property Diameter Gets or sets the diameter (radius * 2.0) of this circle. Diameters should be positive values.
Public property IsValid A valid circle has radius larger than 0.0 and a base plane which is must also be valid.
Public property Normal Gets the normal vector for this circle.
Public property Plane Gets or sets the plane of the circle.
Public property Radius Gets or sets the radius of this circle. Radii should be positive values.
Public propertyStatic member Unset Gets a circle with Unset components.
  Back to Top

Methods

 

Name Description
Public method ClosestParameter Gets the parameter on the circle which is closest to a test point.
Public method ClosestPoint Gets the point on the circle which is closest to a test point.
Public method DerivativeAt Determines the value of the Nth derivative at a parameter.
Public method EpsilonEquals Check that all values in other are within epsilon of the values in this
Public method Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsInPlane Evaluates whether or not this circle is co-planar with a given plane.
Public method PointAt Circles use trigonometric parameterization: t -> center + cos(t)radiusxaxis + sin(t)radiusyaxis.
Public method Reverse Reverse the orientation of the circle. Changes the domain from [a,b] to [-b,-a].
Public method Rotate(Double, Vector3d) Rotates the circle through a given angle.
Public method Rotate(Double, Vector3d, Point3d) Rotates the circle through a given angle.
Public method Rotate(Double, Double, Vector3d) Rotates the circle around an axis that starts at the base plane origin.
Public method Rotate(Double, Double, Vector3d, Point3d) Rotates the circle around an axis that starts at the provided point.
Public method TangentAt Circles use trigonometric parameterization: t -> center + cos(t)radiusxaxis + sin(t)radiusyaxis.
Public method ToNurbsCurve() Constructs a nurbs curve representation of this circle. This amounts to the same as calling NurbsCurve.CreateFromCircle().
Public method ToNurbsCurve(Int32, Int32) Create a uniform non-ratonal cubic NURBS approximation of a circle.
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)
Public method Transform Transforms this circle using an xform matrix.
Public method Translate Moves the circle.
Public methodStatic member TryFitCircleTT Try to fit a circle to two curves using tangent relationships.
Public methodStatic member TryFitCircleTTT Try to fit a circle to three curves using tangent relationships.
  Back to Top

Remarks

An IsValid circle has positive radius and an IsValid plane defining the frame.

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️