T_Rhino_Geometry_Point2d - mcneel/rhinocommon-api-docs GitHub Wiki

Point2d Structure

Represents the two coordinates of a point in two-dimensional space, using Double-precision floating point numbers.

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

Syntax

C#

[SerializableAttribute]
public struct Point2d : ISerializable, IEquatable<Point2d>, 
	IComparable<Point2d>, IComparable

VB

<SerializableAttribute>
Public Structure Point2d
	Implements ISerializable, IEquatable(Of Point2d), 
	IComparable(Of Point2d), IComparable

The Point2d type exposes the following members.

Constructors

 

Name Description
Public method Point2d(Point2d) Initializes a new instance of Point2d by copying another Point2d.
Public method Point2d(Point3d) Initializes a new instance of Point3d by copying the first two coordiantes of a Point3d.
Public method Point2d(Vector2d) Initializes a new instance of Point2d by converting a vector.
Public method Point2d(Double, Double) Initializes a new instance of Point2d from coordinates.
  Back to Top

Properties

 

Name Description
Public property IsValid If any coordinate of a point is UnsetValue, then the point is not valid.
Public property Item Accesses the coordinates of this point.
Public property MaximumCoordinate Gets the largest valid coordinate, or RhinoMath.UnsetValue if no coordinate is valid.
Public property MinimumCoordinate Gets the smallest (both positive and negative) valid coordinate, or RhinoMath.UnsetValue if no coordinate is valid.
Public propertyStatic member Origin Gets a point at 0,0.
Public propertyStatic member Unset Gets a point at RhinoMath.UnsetValue,RhinoMath.UnsetValue.
Public property X Gets or sets the X (first) coordinate of the point.
Public property Y Gets or sets the Y (second) coordinate of the point.
  Back to Top

Methods

 

Name Description
Public methodStatic member Add(Point2d, Point2d) Adds a point with a point. (Provided for languages that do not support operator overloading. You can use the + operator otherwise)
Public methodStatic member Add(Point2d, Vector2d) Adds a point with a vector. (Provided for languages that do not support operator overloading. You can use the + operator otherwise)
Public methodStatic member Add(Vector2d, Point2d) Adds a vector with a point. (Provided for languages that do not support operator overloading. You can use the + operator otherwise)
Public method CompareTo Compares this Point2d with another Point2d. Coordinates evaluation priority is first X, then Y.
Public methodCode example DistanceTo Computes the distance between two points.
Public methodStatic member Divide Divides a Point2d by a number. (Provided for languages that do not support operator overloading. You can use the / operator otherwise)
Public method EpsilonEquals Check that all values in other are within epsilon of the values in this
Public method Equals(Object) Determines whether the specified System.Object is a Point2d and has the same values as the present point. (Overrides ValueType.Equals(Object).)
Public method Equals(Point2d) Determines whether the specified Point2d has the same values as the present point.
Public method GetHashCode Computes a hash number that represents the current point. (Overrides ValueType.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member Multiply(Double, Point2d) Multiplies a Point2d by a number. (Provided for languages that do not support operator overloading. You can use the * operator otherwise)
Public methodStatic member Multiply(Point2d, Double) Multiplies a Point2d by a number. (Provided for languages that do not support operator overloading. You can use the * operator otherwise)
Public methodStatic member Subtract(Point2d, Point2d) Subtracts the second point from the first point. (Provided for languages that do not support operator overloading. You can use the - operator otherwise)
Public methodStatic member Subtract(Point2d, Vector2d) Subtracts a vector from a point. (Provided for languages that do not support operator overloading. You can use the - operator otherwise)
Public method ToString Constructs the string representation for the current point. (Overrides ValueType.ToString().)
Public method Transform Transforms the present point in place. The transformation matrix acts on the left of the point. i.e., result = transformation*point
  Back to Top

Operators

 

Name Description
Public operatorStatic member Addition(Point2d, Point2d) Adds a point with a point.
Public operatorStatic member Addition(Point2d, Vector2d) Adds a point with a vector.
Public operatorStatic member Addition(Vector2d, Point2d) Adds a vector with a point.
Public operatorStatic member Division Divides a Point2d by a number.
Public operatorStatic member Equality Determines whether two Point2d have equal values.
Public operatorStatic member GreaterThan Determines whether the first specified Point2d comes after (has superior sorting value than) the second point. Coordinates evaluation priority is first X, then Y.
Public operatorStatic member GreaterThanOrEqual Determines whether the first specified Point2d comes after (has superior sorting value than) the second point, or it is equal to it. Coordinates evaluation priority is first X, then Y.
Public operatorStatic member Inequality Determines whether two Point2d have different values.
Public operatorStatic member LessThan Determines whether the first specified point comes before (has inferior sorting value than) the second point. Coordinates evaluation priority is first X, then Y.
Public operatorStatic member LessThanOrEqual Determines whether the first specified point comes before (has inferior sorting value than) the second point, or it is equal to it. Coordinates evaluation priority is first X, then Y.
Public operatorStatic member Multiply(Double, Point2d) Multiplies a Point2d by a number.
Public operatorStatic member Multiply(Point2d, Double) Multiplies a Point2d by a number.
Public operatorStatic member Subtraction(Point2d, Point2d) Subtracts point2 from point1.
Public operatorStatic member Subtraction(Point2d, Vector2d) Subtracts a vector from a point.
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

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