Struct Circle

Represents a circle that is composed of a 32-bit signed integer center point and radius.

Implements

IEquatable<Circle>

IComparable<Circle>

IComparable

Namespace: X10D.Drawing

Assembly: X10D.dll

Syntax

public struct Circle : IEquatable<Circle>, IComparable<Circle>, IComparable

Constructors

Circle(Point, Int32)

Initializes a new instance of the Circle struct.

Declaration

public Circle(Point center, int radius)

Parameters

Type	Name	Description
Point	center	The center point of the circle.
System.Int32	radius	The radius of the circle.

Circle(Int32, Int32, Int32)

Initializes a new instance of the Circle struct.

Declaration

public Circle(int centerX, int centerY, int radius)

Parameters

Type	Name	Description
System.Int32	centerX	The X coordinate of the center point.
System.Int32	centerY	The Y coordinate of the center point.
System.Int32	radius	The radius of the circle.

Fields

Circle

The unit circle. That is, a circle whose center point is (0, 0) and whose radius is 1.

Declaration

public static readonly Circle

Field Value

Type	Description
Circle

Circle

The unit circle. That is, a circle whose center point is (0, 0) and whose radius is 1.

Declaration

public static readonly Circle

Field Value

Type	Description
Circle

Empty

The empty circle. That is, a circle whose center point is (0, 0) and whose radius is 0.

Declaration

public static readonly Circle Empty

Field Value

Type	Description
Circle

Unit

The unit circle. That is, a circle whose center point is (0, 0) and whose radius is 1.

Declaration

public static readonly Circle Unit

Field Value

Type	Description
Circle

Properties

Area

Gets the area of the circle.

Declaration

public float Area { get; }

Property Value

Type	Description
System.Single	The area of the circle, calculated as πr².

Center

Gets the center point of the circle.

Declaration

public Point Center { get; }

Property Value

Type	Description
Point	The center point.

Circumference

Gets the circumference of the circle.

Declaration

public float Circumference { get; }

Property Value

Type	Description
System.Single	The circumference of the circle, calculated as 2πr.

Diameter

Gets the diameter of the circle.

Declaration

public int Diameter { get; }

Property Value

Type	Description
System.Int32	The diameter. This is always twice the Radius.

Radius

Gets the radius of the circle.

Declaration

public int Radius { get; }

Property Value

Type	Description
System.Int32	The radius.

Methods

CompareTo(Nullable<Object>)

Compares this instance to another Circle.

Declaration

public int CompareTo(object? obj)

Parameters

Type	Name	Description
System.Nullable<System.Object>	obj	The other object.

Returns

Type	Description
System.Int32	A signed number indicating the relative values of this instance and obj. Return value Meaning Less than zero The Radius of this instance is less than that of obj. Zero This instance is equal to obj, or the Radius of both this instance and obj are not a number (), , or . Greater than zero The Radius of this instance is greater than that of obj, or obj is null.

Remarks

Comparison only takes into consideration the Radius.

CompareTo(Circle)

Compares this instance to another Circle.

Declaration

public int CompareTo(Circle other)

Parameters

Type	Name	Description
Circle	other	The other circle.

Returns

Type	Description
System.Int32	A signed number indicating the relative values of this instance and other. Return value Meaning Less than zero The Radius of this instance is less than that of other. Zero This instance is equal to other, or the Radius of both this instance and other are not a number (), , or . Greater than zero The Radius of this instance is greater than that of other.

Remarks

Comparison only takes into consideration the Radius.

Equals(Nullable<Object>)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
System.Nullable<System.Object>	obj

Returns

Type	Description
System.Boolean

Equals(Circle)

Returns a value indicating whether this instance and another instance are equal.

Declaration

public bool Equals(Circle other)

Parameters

Type	Name	Description
Circle	other	The instance with which to compare.

Returns

Type	Description
System.Boolean	true if this instance and other are considered equal; otherwise, false.

FromCircleF(CircleF)

Converts a Circle to a CircleF.

Declaration

public static Circle FromCircleF(CircleF circle)

Parameters

Type	Name	Description
CircleF	circle	The circle to convert.

Returns

Type	Description
Circle	The converted circle.

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Operators

Equality(Circle, Circle)

Returns a value indicating whether two instances of Circle are equal.

Declaration

public static bool operator ==(Circle left, Circle right)

Parameters

Type	Name	Description
Circle	left	The first instance.
Circle	right	The second instance.

Returns

Type	Description
System.Boolean	true if left and right are considered equal; otherwise, false.

Explicit(CircleF to Circle)

Explicitly converts a Circle to a CircleF.

Declaration

public static explicit operator Circle(CircleF circle)

Parameters

Type	Name	Description
CircleF	circle	The circle to convert.

Returns

Type	Description
Circle	The converted circle.

GreaterThan(Circle, Circle)

Returns a value indicating whether the radius of one circle is greater than to that of another.

Declaration

public static bool operator>(Circle left, Circle right)

Parameters

Type	Name	Description
Circle	left	The first instance.
Circle	right	The second instance.

Returns

Type	Description
System.Boolean	true if the Radius of left is greater than that of right; otherwise, false.

GreaterThanOrEqual(Circle, Circle)

Returns a value indicating whether the radius of one circle is greater than or equal to that of another.

Declaration

public static bool operator >=(Circle left, Circle right)

Parameters

Type	Name	Description
Circle	left	The first instance.
Circle	right	The second instance.

Returns

Type	Description
System.Boolean	true if the Radius of left is greater than or equal to that of right; otherwise, false.

Inequality(Circle, Circle)

Returns a value indicating whether two instances of Circle are not equal.

Declaration

public static bool operator !=(Circle left, Circle right)

Parameters

Type	Name	Description
Circle	left	The first instance.
Circle	right	The second instance.

Returns

Type	Description
System.Boolean	true if left and right are considered not equal; otherwise, false.

LessThan(Circle, Circle)

Returns a value indicating whether the radius of one circle is less than that of another.

Declaration

public static bool operator <(Circle left, Circle right)

Parameters

Type	Name	Description
Circle	left	The first instance.
Circle	right	The second instance.

Returns

Type	Description
System.Boolean	true if the Radius of left is less than that of right; otherwise, false.

LessThanOrEqual(Circle, Circle)

Returns a value indicating whether the radius of one circle is less than or equal to that of another.

Declaration

public static bool operator <=(Circle left, Circle right)

Parameters

Type	Name	Description
Circle	left	The first instance.
Circle	right	The second instance.

Returns

Type	Description
System.Boolean	true if the Radius of left is less than or equal to that of right; otherwise, false.

Implements

IEquatable<>

IComparable<>

IComparable

Extension Methods

Extensions.AsArrayValue<T>(T)

Extensions.AsEnumerableValue<T>(T)

Extensions.RepeatValue<T>(T, Int32)

Extensions.ToJson<T>(T, Nullable<JsonSerializerOptions>)