Struct Circle

Structure defining a circle curve in three-dimensional euclidean space.

Implements
IEquatable<Circle>
Namespace: BRIDGES.Geometry.Euclidean3D
Assembly: BRIDGES.dll
Syntax
public struct Circle : IGeometricallyEquatable<Circle>

Constructors

| Improve this Doc View Source

Circle(Plane, Double)

Initialises a new instance of the Circle structure by defining its centre, orientation and radius.

Declaration
public Circle(Plane plane, double radius)
Parameters
Type Name Description
Plane plane

Plane defining the centre and the orientation of the Circle.
Double radius

Radius of the Circle.
| Improve this Doc View Source

Circle(Point, Double)

Initialises a new instance of the Circle structure, parallel to the WorldXY plane, by defining its centre and radius.

Declaration
public Circle(Point centre, double radius)
Parameters
Type Name Description
Point centre

Centre of the Circle.
Double radius

Radius of the Circle.

Properties

| Improve this Doc View Source

Centre

Gets or sets the centre of the current Circle.

Declaration
public Point Centre { get; set; }
Property Value
Type Description
Point
| Improve this Doc View Source

IsClosed

Gets a boolean evaluating whether the current Circle is closed or not;

Declaration
public readonly bool IsClosed { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Plane

Gets or sets the plane defining the centre and the orientation of the current Circle

Declaration
public Plane Plane { get; set; }
Property Value
Type Description
Plane
| Improve this Doc View Source

Radius

Gets or sets the radius of the current Circle.

Declaration
public double Radius { get; set; }
Property Value
Type Description
Double

Methods

| Improve this Doc View Source

Equals(Circle)

Evaluates whether the current Circle is memberwise equal to another Circle.

Declaration
public bool Equals(Circle other)
Parameters
Type Name Description
Circle other

Circle to compare with.
Returns
Type Description
Boolean

true if the two Circle are equal, false otherwise.
Remarks

Two Circle are equal if their centre, radius and plane are equal.

| Improve this Doc View Source

Equals(Object)

Structure defining a circle curve in three-dimensional euclidean space.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
| Improve this Doc View Source

Flip()

Flips the current Circle by reversing the normal axis (and the in-plane YAxis).

Declaration
public void Flip()
| Improve this Doc View Source

GeometricallyEquals(Circle)

Evaluates whether the current object is geometrically equal to the given T.

Declaration
public bool GeometricallyEquals(Circle other)
Parameters
Type Name Description
Circle other
Returns
Type Description
Boolean

true if the two objects are geometrically equal, false otherwise.
| Improve this Doc View Source

GetHashCode()

Structure defining a circle curve in three-dimensional euclidean space.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
| Improve this Doc View Source

PointAt(Double, CurveParameterFormat)

Evaluates the current Line at the given parameter.

Declaration
public Point PointAt(double t, CurveParameterFormat format)
Parameters
Type Name Description
Double t

Parameter to evaluate the Line.
CurveParameterFormat format

Format of the parameter.

  • Normalised The point at t = 0.5 is diametrically opposed to the start point at t = 0.0.
  • ArcLength The point at t = is diametrically opposed to the start point at t = 0.0.
Returns
Type Description
Point

The Point on the Circle at the given parameter.
| Improve this Doc View Source

PointAt(Double)

Evaluates the current Circle at the given angle.

Declaration
public Point PointAt(double angle)
Parameters
Type Name Description
Double angle

Value of the anlgle (in radians).
Returns
Type Description
Point

The Point on the Circle at the given angle.
| Improve this Doc View Source

ToString()

Structure defining a circle curve in three-dimensional euclidean space.

Declaration
public override string ToString()
Returns
Type Description
String

Implements

IEquatable<>