mahautils.shapes.ClosedShape2D¶

class mahautils.shapes.ClosedShape2D(default_num_coordinates: int | None = None, construction: bool = False, polygon_file_enclosed_conv: int = 1, units: str | None = None)¶

Bases: Shape2D

A class that represents a closed, two-dimensional shape

This class is intended to represent closed shapes (i.e., shapes for which any given point in space is either inside or outside the shape, or on the perimeter).

Attributes

`area`	Returns the area enclosed by the shape
`polygon_file_enclosed_conv`	Convention for considering enclosed area when generating a polygon file from `ClosedShape2D` objects

Methods

`__init__`([default_num_coordinates, ...])	Creates an object representing a closed, 2D geometric shape
`is_inside`(point[, perimeter_is_inside])	Returns whether a point is inside the shape
`points`([repeat_end])	Returns a list containing discretized points around the perimeter of the shape
`xy_coordinates`([repeat_end])	Generates Cartesian coordinates of the shape

Inherited Attributes

`construction`	Whether the shape is a "construction shape" meant for visual display but not functional geometry
`default_num_coordinates`	The number of coordinates to use when representing a discretized form of the shape
`is_closed`	Whether the shape is bounded by a closed perimeter
`units`	The units in which the geometry is defined

Inherited Methods

`reflect`(pntA, pntB)	Reflects the shape across a line defined by two points
`reflect_x`()	Reflects the shape over the \(x\)-axis
`reflect_y`()	Reflects the shape over the \(y\)-axis
`rotate`(center, angle[, angle_units])	Rotates the shape in the \(xy\)-plane
`translate`([x, y])	Translates the shape in the \(xy\)-plane

__init__(default_num_coordinates: int | None = None, construction: bool = False, polygon_file_enclosed_conv: int = 1, units: str | None = None) → None¶

Creates an object representing a closed, 2D geometric shape

Defines an object which represents a closed shape in the 2D Cartesian coordinate system.

Parameters:

default_num_coordinates (int, optional) – The default number of coordinates to use when representing the shape (default is None)
construction (bool, optional) – Whether the shape is a “construction shape” meant for visual display but not functional geometry (default is False)
polygon_file_enclosed_conv (int, optional) – Convention for considering enclosed area when generating a polygon file from ClosedShape2D objects (default is 1)
units (str, optional) – The units in which the geometry is defined, or None to indicate dimensionless geometry or that units are to be ignored (default is None)

property area: float¶: Returns the area enclosed by the shape

property polygon_file_enclosed_conv: int¶

Convention for considering enclosed area when generating a polygon file from ClosedShape2D objects

This property is exclusively intended for use when generating Maha Multics polygon files. As discussed on the Polygon File Format page, when generating Maha Multics polygon files, the ENCLOSED_CONV option can be set for any given closed shape to indicate whether the area inside the shape (as determined by the winding number algorithm) is considered by the polygon file to to be “enclosed” area. This property is designed to store the value of this ENCLOSED_CONV option for any ClosedShape2D objects that are to be incorporated into a polygon file.

Note

For more information about the interpretation of this option, refer to the Polygon File Format page.

is_inside(point: List[float] | Tuple[float, float] | ndarray | CartesianPoint2D, perimeter_is_inside: bool = True) → bool¶

Returns whether a point is inside the shape

Parameters:

point (list or tuple or CartesianPoint2D) – The point whose location is to be checked. Must be either a CartesianPoint2D instance, or a list or tuple containing two elements of type float
perimeter_is_inside (bool, optional) – Whether to consider points on the perimeter of the shape to be inside the shape (default is True)

Returns:

If perimeter_is_inside is True, returns True if point is inside the shape or on the perimeter, and False otherwise. If perimeter_is_inside is False, returns True if point is inside the shape but NOT on the perimeter, and False otherwise

Return type:

bool

points(repeat_end: bool = False) → Tuple[ndarray, ...]¶

Returns a list containing discretized points around the perimeter of the shape

This method returns a tuple, of which each element is a point along the perimeter of the shape.

Parameters:: repeat_end (bool, optional) – Whether the first and last coordinate returned should be the same point (default is False). This is useful, for instance, when plotting the shape with Matplotlib: if repeat_end is set to False, there may be a slight gap visible between the end points of the shape