Skip to content

DiGi.Rhino.Geometry.Planar

github-actions[bot] edited this page Jul 15, 2026 · 2 revisions

DiGi.Rhino.Geometry.Planar Namespace

Classes

Inspect Class

public static class Inspect

Inheritance System.Object → Inspect

Methods

Inspect.A(this Ellipse2D) Method

Retrieves the semi-major axis length (A) of the specified 2D ellipse.

public static GH_Number? A(this DiGi.Geometry.Planar.Classes.Ellipse2D? ellipse2D);

Parameters

ellipse2D DiGi.Geometry.Planar.Classes.Ellipse2D

The 2D ellipse to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the semi-major axis length, or null if the ellipse is null.

Inspect.Area(this PolygonalFace2D) Method

Gets the area of the specified polygonal face.

public static GH_Number? Area(this DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face to evaluate.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the area, or null if the input is null.

Inspect.Area(this Rectangle2D) Method

Calculates the area of the specified rectangle as a GH_Number.

public static GH_Number? Area(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the area, or null if the rectangle is null.

Inspect.B(this Ellipse2D) Method

Retrieves the semi-minor axis length (B) of the specified 2D ellipse.

public static GH_Number? B(this DiGi.Geometry.Planar.Classes.Ellipse2D? ellipse2D);

Parameters

ellipse2D DiGi.Geometry.Planar.Classes.Ellipse2D

The 2D ellipse to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the semi-minor axis length, or null if the ellipse is null.

Inspect.BottomLeft(this BoundingBox2D) Method

Gets the bottom-left corner of the specified 2D bounding box.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? BottomLeft(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

GooPoint2D
A GooPoint2D representing the bottom-left corner, or null if the bounding box is null.

Inspect.BottomRight(this BoundingBox2D) Method

Gets the bottom-right corner of the specified 2D bounding box.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? BottomRight(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

GooPoint2D
A GooPoint2D representing the bottom-right corner, or null if the bounding box is null.

Inspect.BoundinBox2D(this IBoundable2D) Method

Calculates the 2D bounding box for the specified boundable 2D object.

public static DiGi.Rhino.Geometry.Planar.Classes.GooBoundingBox2D? BoundinBox2D(this DiGi.Geometry.Planar.Interfaces.IBoundable2D? boundable2D);

Parameters

boundable2D DiGi.Geometry.Planar.Interfaces.IBoundable2D

The 2D object that implements DiGi.Geometry.Planar.Interfaces.IBoundable2D.

Returns

GooBoundingBox2D
A GooBoundingBox2D representing the bounding box, or null if the provided boundable2D is null.

Inspect.BoundingBox(this Rectangle2D) Method

Gets the 2D bounding box of the specified rectangle.

public static DiGi.Rhino.Geometry.Planar.Classes.GooBoundingBox2D? BoundingBox(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

GooBoundingBox2D
A GooBoundingBox2D representing the bounding box, or null if the rectangle is null.

Inspect.Centroid(this BoundingBox2D) Method

Gets the centroid of the specified 2D bounding box.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? Centroid(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

GooPoint2D
A GooPoint2D representing the centroid, or null if the bounding box is null.

Inspect.Centroid(this Ellipse2D) Method

Retrieves the centroid (center point) of the specified 2D ellipse.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? Centroid(this DiGi.Geometry.Planar.Classes.Ellipse2D? ellipse2D);

Parameters

ellipse2D DiGi.Geometry.Planar.Classes.Ellipse2D

The 2D ellipse to inspect.

Returns

GooPoint2D
A GooPoint2D representing the center point, or null if the ellipse is null.

Inspect.Centroid(this PolygonalFace2D) Method

Gets the centroid of the specified polygonal face.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? Centroid(this DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face to evaluate.

Returns

GooPoint2D
A GooPoint2D representing the centroid, or null if the input is null.

Inspect.Centroid(this Rectangle2D) Method

Gets the centroid point of the specified rectangle.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? Centroid(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

GooPoint2D
A GooPoint2D representing the centroid, or null if the rectangle is null.

Inspect.ExternalEdge(this PolygonalFace2D) Method

Gets the external edge of the specified polygonal face.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPolygonal2D? ExternalEdge(this DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face to evaluate.

Returns

GooPolygonal2D
A GooPolygonal2D representing the outer boundary, or null if the input is null.

Inspect.FocalPoints(this Ellipse2D) Method

Retrieves the focal points of the specified 2D ellipse.

public static System.Collections.Generic.IEnumerable<DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D>? FocalPoints(this DiGi.Geometry.Planar.Classes.Ellipse2D? ellipse2D);

Parameters

ellipse2D DiGi.Geometry.Planar.Classes.Ellipse2D

The 2D ellipse to inspect.

Returns

System.Collections.Generic.IEnumerable<GooPoint2D>
A collection of GooPoint2D representing the focal points, or null if the ellipse is null.

Inspect.Height(this BoundingBox2D) Method

Gets the height of the specified 2D bounding box.

public static GH_Number? Height(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the height, or null if the bounding box is null.

Inspect.Height(this Rectangle2D) Method

Gets the height of the specified rectangle as a GH_Number.

public static GH_Number? Height(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the height, or null if the rectangle is null.

Inspect.HeightDirection(this Rectangle2D) Method

Gets the vector representing the height direction of the specified rectangle.

public static DiGi.Rhino.Geometry.Planar.Classes.GooVector2D? HeightDirection(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

GooVector2D
A GooVector2D representing the height direction, or null if the rectangle is null.

Inspect.InternalEdges(this PolygonalFace2D) Method

Gets the internal edges of the specified polygonal face.

public static System.Collections.IEnumerable? InternalEdges(this DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face to evaluate.

Returns

System.Collections.IEnumerable
An enumerable collection of GooPolygonal2D representing internal boundaries, or null if the input is null.

Inspect.InternalPoint(this PolygonalFace2D) Method

Gets an internal point of the specified polygonal face.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? InternalPoint(this DiGi.Geometry.Planar.Classes.PolygonalFace2D? polygonalFace2D);

Parameters

polygonalFace2D DiGi.Geometry.Planar.Classes.PolygonalFace2D

The polygonal face to evaluate.

Returns

GooPoint2D
A GooPoint2D representing a point inside the face, or null if the input is null.

Inspect.Inversed(this Vector2D) Method

Returns the inversed version of the provided 2D vector as a GooVector2D.

public static DiGi.Rhino.Geometry.Planar.Classes.GooVector2D? Inversed(this DiGi.Geometry.Planar.Classes.Vector2D? vector2D);

Parameters

vector2D DiGi.Geometry.Planar.Classes.Vector2D

The 2D vector to invert.

Returns

GooVector2D
A GooVector2D containing the inverted vector, or null if the input vector is null.

Inspect.Length(this Vector2D) Method

Returns the length of the provided 2D vector as a Grasshopper.Kernel.Types.GH_Number.

public static GH_Number? Length(this DiGi.Geometry.Planar.Classes.Vector2D? vector2D);

Parameters

vector2D DiGi.Geometry.Planar.Classes.Vector2D

The 2D vector whose length is to be calculated.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the length, or null if the input vector is null.

Inspect.Length(this ISegmentable2D) Method

Gets the length of the specified 2D segmentable object as a Grasshopper.Kernel.Types.GH_Number.

public static GH_Number? Length(this DiGi.Geometry.Planar.Interfaces.ISegmentable2D? segmentable2D);

Parameters

segmentable2D DiGi.Geometry.Planar.Interfaces.ISegmentable2D

The 2D segmentable object to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the length, or null if the input is null.

Inspect.Origin(this Rectangle2D) Method

Gets the origin point of the specified rectangle.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? Origin(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

GooPoint2D
A GooPoint2D representing the origin, or null if the rectangle is null.

Inspect.Points(this BoundingBox2D) Method

Gets the corner points of the specified 2D bounding box.

public static System.Collections.Generic.IEnumerable<DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D>? Points(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

System.Collections.Generic.IEnumerable<GooPoint2D>
A collection of GooPoint2D representing the corners, or null if the bounding box is null.

Inspect.Points(this Rectangle2D) Method

Gets the corner points of the specified rectangle converted to GooPoint2D objects.

public static System.Collections.Generic.IEnumerable<DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D>? Points(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

System.Collections.Generic.IEnumerable<GooPoint2D>
An enumerable collection of GooPoint2D, or null if the rectangle is null.

Inspect.Points(this ISegmentable2D) Method

Retrieves the points of the specified 2D segmentable object as a collection of GooPoint2D.

public static System.Collections.Generic.IEnumerable<DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D>? Points(this DiGi.Geometry.Planar.Interfaces.ISegmentable2D? segmentable2D);

Parameters

segmentable2D DiGi.Geometry.Planar.Interfaces.ISegmentable2D

The 2D segmentable object to inspect.

Returns

System.Collections.Generic.IEnumerable<GooPoint2D>
An enumerable collection of GooPoint2D, or null if the input is null.

Inspect.Rectangle2D(this ISegmentable2D) Method

Gets the bounding rectangle of the specified 2D segmentable object as a GooRectangle2D.

public static DiGi.Rhino.Geometry.Planar.Classes.GooRectangle2D? Rectangle2D(this DiGi.Geometry.Planar.Interfaces.ISegmentable2D? segmentable2D);

Parameters

segmentable2D DiGi.Geometry.Planar.Interfaces.ISegmentable2D

The 2D segmentable object to inspect.

Returns

GooRectangle2D
A GooRectangle2D representing the bounding rectangle, or null if the input is null.

Inspect.Segments(this BoundingBox2D) Method

Gets the boundary segments of the specified 2D bounding box.

public static System.Collections.Generic.IEnumerable<DiGi.Rhino.Geometry.Planar.Classes.GooSegment2D>? Segments(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

System.Collections.Generic.IEnumerable<GooSegment2D>
A collection of GooSegment2D representing the edges, or null if the bounding box is null.

Inspect.Segments(this ISegmentable2D) Method

Retrieves the segments of the specified 2D segmentable object as a collection of GooSegment2D.

public static System.Collections.Generic.IEnumerable<DiGi.Rhino.Geometry.Planar.Classes.GooSegment2D>? Segments(this DiGi.Geometry.Planar.Interfaces.ISegmentable2D? segmentable2D);

Parameters

segmentable2D DiGi.Geometry.Planar.Interfaces.ISegmentable2D

The 2D segmentable object to inspect.

Returns

System.Collections.Generic.IEnumerable<GooSegment2D>
An enumerable collection of GooSegment2D, or null if the input is null.

Inspect.TopLeft(this BoundingBox2D) Method

Gets the top-left corner of the specified 2D bounding box.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? TopLeft(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

GooPoint2D
A GooPoint2D representing the top-left corner, or null if the bounding box is null.

Inspect.TopRight(this BoundingBox2D) Method

Gets the top-right corner of the specified 2D bounding box.

public static DiGi.Rhino.Geometry.Planar.Classes.GooPoint2D? TopRight(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

GooPoint2D
A GooPoint2D representing the top-right corner, or null if the bounding box is null.

Inspect.Unit(this Vector2D) Method

Returns the unit (normalized) version of the provided 2D vector as a GooVector2D.

public static DiGi.Rhino.Geometry.Planar.Classes.GooVector2D? Unit(this DiGi.Geometry.Planar.Classes.Vector2D? vector2D);

Parameters

vector2D DiGi.Geometry.Planar.Classes.Vector2D

The 2D vector to normalize.

Returns

GooVector2D
A GooVector2D containing the unit vector, or null if the input vector is null.

Inspect.Width(this BoundingBox2D) Method

Gets the width of the specified 2D bounding box.

public static GH_Number? Width(this DiGi.Geometry.Planar.Classes.BoundingBox2D? boundingBox2D);

Parameters

boundingBox2D DiGi.Geometry.Planar.Classes.BoundingBox2D

The 2D bounding box to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the width, or null if the bounding box is null.

Inspect.Width(this Rectangle2D) Method

Gets the width of the specified rectangle as a GH_Number.

public static GH_Number? Width(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the width, or null if the rectangle is null.

Inspect.WidthDirection(this Rectangle2D) Method

Gets the vector representing the width direction of the specified rectangle.

public static DiGi.Rhino.Geometry.Planar.Classes.GooVector2D? WidthDirection(this DiGi.Geometry.Planar.Classes.Rectangle2D? rectangle2D);

Parameters

rectangle2D DiGi.Geometry.Planar.Classes.Rectangle2D

The rectangle to inspect.

Returns

GooVector2D
A GooVector2D representing the width direction, or null if the rectangle is null.

Inspect.X(this Point2D) Method

Extracts the X coordinate of a 2D point as a Grasshopper number.

public static GH_Number? X(this DiGi.Geometry.Planar.Classes.Point2D? point2D);

Parameters

point2D DiGi.Geometry.Planar.Classes.Point2D

The 2D point to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the X coordinate, or null if the input point is null.

Inspect.X(this Vector2D) Method

Returns the X coordinate of the provided 2D vector as a Grasshopper.Kernel.Types.GH_Number.

public static GH_Number? X(this DiGi.Geometry.Planar.Classes.Vector2D? vector2D);

Parameters

vector2D DiGi.Geometry.Planar.Classes.Vector2D

The 2D vector whose X coordinate is to be retrieved.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the X coordinate, or null if the input vector is null.

Inspect.Y(this Point2D) Method

Extracts the Y coordinate of a 2D point as a Grasshopper number.

public static GH_Number? Y(this DiGi.Geometry.Planar.Classes.Point2D? point2D);

Parameters

point2D DiGi.Geometry.Planar.Classes.Point2D

The 2D point to inspect.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the Y coordinate, or null if the input point is null.

Inspect.Y(this Vector2D) Method

Returns the Y coordinate of the provided 2D vector as a Grasshopper.Kernel.Types.GH_Number.

public static GH_Number? Y(this DiGi.Geometry.Planar.Classes.Vector2D? vector2D);

Parameters

vector2D DiGi.Geometry.Planar.Classes.Vector2D

The 2D vector whose Y coordinate is to be retrieved.

Returns

Grasshopper.Kernel.Types.GH_Number
A Grasshopper.Kernel.Types.GH_Number representing the Y coordinate, or null if the input vector is null.

Clone this wiki locally