GRegion Class

GRegion entity definition. By convention the first contour in the list is the outer and has counterclockwise orientation. Inners are oriented clockwise.
Public Class GRegion 
Inherits GPlanarEntity 
Implements IGFace
This language is not supported or no code example is available.
public class GRegion : GPlanarEntity
IGFace
This language is not supported or no code example is available.
Name Description
Protected constructor GRegion(GRegion) Copy constructor.
Public constructor GRegion(IGCurve) Single contour constructor.
Public constructor GRegion(IGCurve, Plane) Single contour and plane constructor.
Public constructor GRegion(IGCurve, Plane, bool) Single contour, plane and sorting flag constructor.
Public constructor GRegion(IList<IGCurve>) List of contours constructor.
Public constructor GRegion(IList<IGCurve>, Plane) List of contours and plane constructor.
Public constructor GRegion(IList<IGCurve>, Plane, bool) List of contours, plane and sorting flag constructor.
Public constructor GRegion(SerializationInfo, StreamingContext) Constructor for deserializing objects.
Public constructor GRegion(params IGCurve[]) List of contours constructor.
Top
Name Description
Public property ContourList Gets o sets the list of contours inside the region.
Public property EntityData Gets or sets the entity custom data. (inherited from GEntity).
Public property HasHoles Returns true when the number of contours is bigger than one.
Public property Plane Gets or sets the planar entity supporting plane. (inherited from GPlanarEntity).
Top
Methods
 
Name Description
Public method Clone() Creates a deep copy of this region.
Protected method ComputeApproximatedBoundingBox(out Point3D, out Point3D) Computes the primitive's approximated bounding box.
Public method ComputeTessellation(IRegenParams, out TessellationData)
Public method ComputeTessellation(double, out TessellationData)
Public method ConvertToMesh(double, natureType) Converts this region to a GMesh object.
Public method ConvertToMesh(double, double, natureType, bool)
Public method ConvertToMesh<T>(ComputeTessellationParams, natureType) Converts this region to a GMesh object.
Public method ConvertToMesh<T>(double, natureType) Converts this region to a GMesh object.
Public method ConvertToSolid(double) Converts this region to a GSolid object.
Public method ConvertToSolid<T>(double) Converts this region to a GSolid object.
Public method ConvertToSurface() Converts this region to a GSurface object.
Public method ConvertToSurrogate() Converts the GEntity to its surrogate, for serialization purpose.
Public method Static CreateCircle(Plane, Point2D, double) Creates a circular region by plane and position.
Public method Static CreateCircle(Plane, double) Creates a circular region by plane.
Public method Static CreateCircle(Plane, double, double, double) Creates a circular region by plane and position.
Public method Static CreateCircle(double) Creates a circular region.
Public method Static CreateCircle(double, double, double) Creates a circular region by position.
Public method Static CreateCircularSlot(Plane, double, double, double) Creates a region with the shape of a circular slot by plane.
Public method Static CreateCircularSlot(Plane, double, double, double, double) Creates a region with the shape of a circular slot by plane and start angle.
Public method Static CreateCircularSlot(Plane, double, double, double, double, double) Creates a region with the shape of a circular slot by plane and position.
Public method Static CreateCircularSlot(Plane, double, double, double, double, double, double) Creates a region with the shape of a circular slot by plane, position and start angle.
Public method Static CreateCircularSlot(double, double, double) Creates a region with the shape of a circular slot.
Public method Static CreateCircularSlot(double, double, double, double) Creates a region with the shape of a circular slot by start angle.
Public method Static CreateCircularSlot(double, double, double, double, double) Creates a region with the shape of a circular slot by position.
Public method Static CreateCircularSlot(double, double, double, double, double, double) Creates a region with the shape of a circular slot by position and start angle.
Public method Static CreateEllipse(Plane, Point2D, double, double) Creates an elliptical region by plane and position.
Public method Static CreateEllipse(Plane, double, double) Creates an elliptical region by plane.
Public method Static CreateEllipse(Plane, double, double, double, double) Creates an elliptical region by plane and position.
Public method Static CreateEllipse(double, double) Creates an elliptical region.
Public method Static CreateEllipse(double, double, double, double) Creates an elliptical region by position.
Public method Static CreateHexagon(Plane, double, bool) Creates an hexagonal region by plane.
Public method Static CreateHexagon(Plane, double, double, double, double, bool) Creates an hexagonal region by plane and position.
Public method Static CreateHexagon(double, bool) Creates an hexagonal region.
Public method Static CreateHexagon(double, double, double, double, bool) Creates an hexagonal region by position.
Public method Static CreatePolygon(Plane, IList<Point2D>) Creates a polygonal region by plane.
Public method Static CreatePolygon(params Point2D[]) Creates a polygonal region.
Public method Static CreatePolygon(params Point3D[]) Creates a polygonal region.
Public method Static CreateRectangle(Plane, double, double, bool) Creates a rectangular region by plane.
Public method Static CreateRectangle(Plane, double, double, double, double, double, bool) Creates a rectangular region by plane and position.
Public method Static CreateRectangle(double, double, bool) Creates a rectangular region.
Public method Static CreateRectangle(double, double, double, double, double, bool) Creates a rectangular region by position.
Public method Static CreateRoundedRectangle(Plane, double, double, double, bool) Creates a rounded rectangular region by plane.
Public method Static CreateRoundedRectangle(Plane, double, double, double, double, double, double, bool) Creates a rounded rectangular region by plane and position.
Public method Static CreateRoundedRectangle(double, double, double, bool) Creates a rounded rectangular region.
Public method Static CreateRoundedRectangle(double, double, double, double, double, double, bool) Creates a rounded rectangular region by position.
Public method Static CreateSlot(Plane, double, double, bool) Creates a region with the shape of a slot by plane.
Public method Static CreateSlot(Plane, double, double, double, double, double, bool) Creates a region with the shape of a slot by plane and position.
Public method Static CreateSlot(double, double, bool) Creates a region with the shape of a slot.
Public method Static CreateSlot(double, double, double, double, double, bool) Creates a region with the shape of a slot by position.
Public method Static Difference<T>(T, params T[]) Boolean difference between one region and a list of regions.
Public method Static Difference<T>(T, T) Boolean difference between two regions.
Public method Dump() Returns a description of this entity.
Public method Equals(Object) (inherited from Object).
Public method ExtrudeAsBrep(Interval, double, double) Extrudes the region to create a new GBrep.
Public method ExtrudeAsBrep(Vector3D, double, double) Extrudes the region to create a new GBrep.
Public method ExtrudeAsBrep(double, double, double) Extrudes a region creating a new GBrep.
Public method ExtrudeAsMesh(Vector3D, ComputeTessellationParams, natureType) Extrudes a region creating a new GMesh.
Public method ExtrudeAsMesh(Vector3D, double, natureType) Extrudes a region creating a new GMesh.
Public method ExtrudeAsMesh(double, double, natureType) Extrudes a region creating a new GMesh along plane's Z-axis.
Public method ExtrudeAsMesh<T>(Vector3D, ComputeTessellationParams, natureType) Extrudes a region creating a new GMesh.
Public method ExtrudeAsMesh<T>(Vector3D, double, natureType) Extrudes a region creating a new GMesh.
Public method ExtrudeAsMesh<T>(double, double, natureType) Extrudes a region creating a new GMesh along plane's Z-axis.
Public method ExtrudeAsSolid(Vector3D, ComputeTessellationParams) Extrudes this region.
Public method ExtrudeAsSolid(Vector3D, double) Extrudes this region.
Public method ExtrudeAsSolid(double, double) Extrudes this region.
Public method ExtrudeAsSolid(double, double, double, double) Extrudes this region.
Public method ExtrudeAsSolid<T>(Vector3D, ComputeTessellationParams) Extrudes this region.
Public method ExtrudeAsSolid<T>(Vector3D, double) Extrudes this region.
Public method ExtrudeAsSolid<T>(double, double) Extrudes this region.
Public method ExtrudeAsSolid<T>(double, double, double, double) Extrudes this region.
Public method ExtrudeAsSurface(Vector3D) Extrudes a region creating a new GSurface.
Public method ExtrudeAsSurface(Vector3D, double, double)
Public method ExtrudeAsSurface(double) Extrudes a region creating a new GSurface.
Public method ExtrudeAsSurface(double, double, double)
Protected method Finalize (inherited from Object).
Public method FlipNormal()
Protected method Static GetClosestMainAxis(Vector3D) (inherited from GEntity).
Public method GetCoarseSampling() Returns a small set of points that gives a coarse idea of the 3D extent of the primitive.
Public method GetHashCode (inherited from Object).
Public method GetObjectData(SerializationInfo, StreamingContext) Populates a SerializationInfo instance with the data needed to serialize the target object.
Protected method Static GetOffsetDistance(Vector3D, Vector3D, double) (inherited from GEntity).
Public method GetPerimeter() Computes the perimeter of the region.
Public method GetType (inherited from Object).
Public method GetXElement()
Public method Static Intersection<T>(T, T) Boolean intersection between two regions.
Public method IsPointInside(Point2D) Tests if a 2D point is inside the region.
Public method IsPointInside(Point3D) Tests if a 3D point is inside the region.
Public method IsPointOnContour(Point3D, double) Tests if a 3D point is on one of the region's contours.
Public method IsValid() Returns true if all the entity fields contain reasonable information.
Protected method MemberwiseClone (inherited from Object).
Public method Offset(double, double) Offsets the region of the specified amount.
Public method Offset(double, double, bool) Offsets the region of the specified amount.
Public method Pocket(double, cornerType, double, double) Obsolete. Pocket function for NC toolpaths.
Public method Pocket(double, cornerType, double) Obsolete. Pocket function for NC toolpaths.
Public method Pocket(double, double) Pocket function for NC toolpaths.
Public method QuickOffset(double, cornerType, double, double) Obsolete. Quick offset function for NC toolpaths.
Public method QuickOffset(double, cornerType, double) Obsolete. Quick offset function for NC toolpaths.
Public method QuickOffset(double, double) Quick offset function for NC toolpaths.
Public method ResetComputedData() Resets needed primitive's geometrical attributes to recompute. (inherited from GEntity).
Public method RevolveAsBrep(double, Vector3D, Point3D, double) Revolves this region around an axis.
Public method RevolveAsBrep(double, double, Point3D, Point3D, double) Revolves this region around an axis.
Public method RevolveAsBrep(double, double, Vector3D, Point3D, double) Revolves this region around an axis.
Public method RevolveAsMesh(double, double, Point3D, Point3D, int, double, natureType) Revolves this region around an axis.
Public method RevolveAsMesh(double, double, Vector3D, Point3D, int, double, natureType) Revolves this region around an axis.
Public method RevolveAsMesh<T>(double, double, Point3D, Point3D, int, double, natureType) Revolves this region around an axis.
Public method RevolveAsMesh<T>(double, double, Vector3D, Point3D, int, double, natureType) Revolves this region around an axis.
Public method RevolveAsSolid(double, double, Point3D, Point3D, int, double) Revolves this region around an axis.
Public method RevolveAsSolid(double, double, Vector3D, Point3D, int, double) Revolves this region around an axis.
Public method RevolveAsSolid<T>(double, double, Point3D, Point3D, int, double) Revolves this region around an axis.
Public method RevolveAsSolid<T>(double, double, Vector3D, Point3D, int, double) Revolves this region around an axis.
Public method RevolveAsSurface(double, double, Point3D, Point3D) Revolves this region around an axis.
Public method RevolveAsSurface(double, double, Vector3D, Point3D) Revolves this region around an axis.
Public method Rotate(double, Vector3D, Point3D) Rotates the entity around an arbitrary axis by the specified angle. (inherited from GEntity).
Public method Rotate(double, Point3D, Point3D) Rotates the entity around an arbitray axis by the specified angle. (inherited from GEntity).
Public method Rotate(double, Vector3D) Rotates the entity around an arbitray axis by the specified angle. (inherited from GEntity).
Public method Scale(Point3D, double, double, double) Scales the entity of the specified scale factor. (inherited from GEntity).
Public method Scale(Point3D, double) Scales the entity of the specified scale factor. (inherited from GEntity).
Public method Scale(Vector3D) Scales the entity of the specified scale factor. (inherited from GEntity).
Public method Scale(double) Scales the entity of the specified scale factor. (inherited from GEntity).
Public method Scale(double, double, double) Scales the entity of the specified scale factor. (inherited from GEntity).
Public method Section(Plane, double)
Public method SortAndOrient() Sorts and orients internal contours.
Public method SweepAsBrep(IGCurve, double, sweepMethodType) Creates a GBrep by sweeping the region along a rail.
Public method SweepAsBrep(IGCurve, double, bool, sweepMethodType) Creates a GBrep by sweeping the region along a rail.
Public method SweepAsMesh(IGCurve, double, sweepMethodType, natureType) Creates a mesh by sweeping the region along a rail.
Public method SweepAsMesh(IGCurve, double, bool, sweepMethodType, natureType) Creates a mesh by sweeping the region along a rail.
Public method SweepAsMesh<T>(IGCurve, double, sweepMethodType, natureType) Creates a mesh by sweeping the region along a rail.
Public method SweepAsMesh<T>(IGCurve, double, bool, sweepMethodType, natureType) Creates a mesh by sweeping the region along a rail.
Public method SweepAsSolid(IGCurve, double, bool, sweepMethodType) Sweeps this region along the provided trajectory.
Public method SweepAsSolid(IGCurve, double, sweepMethodType) Sweeps this region along the provided trajectory.
Public method SweepAsSolid<T>(IGCurve, double, bool, sweepMethodType) Sweeps this region along the provided trajectory.
Public method SweepAsSolid<T>(IGCurve, double, sweepMethodType) Sweeps this region along the provided trajectory.
Public method SweepAsSurface(IGCurve, double, sweepMethodType) Creates a gSurface by sweeping the region along a rail.
Public method ToString()
Internal protected (Protected Friend) method TransformAllVertices(Point3D[], Transformation, bool, bool) (inherited from GEntity).
Public method TransformBy(Transformation) Transforms all the entity's vertices by the specified transformation.
Public method Translate(double, double, double) Translates the entity. (inherited from GEntity).
Public method Translate(Vector3D) Translates the entity. (inherited from GEntity).
Public method Triangulate(double, int, IList<GLinearPath>) Triangulates this GRegion.
Public method Static Trim(GRegion, IList<IGCurve>, double, out GRegion[]) Trims the region using the given - open - curves.
Public method Static Trim(GRegion, IList<IGCurve>, out GRegion[]) Trims the region using the given - open - igCurves.
Public method Static Union<T>(T, T) Boolean union between two regions.
Protected method Update(GPlanarEntity) Updates the contents of this entity with the contents of another entity. (inherited from GPlanarEntity).
Top

.NET Framework

Supported in: 4.7.2

In this article

Definition