This page covers the scenic.core.regions.Region class and its subclasses; for an introduction to the concept of regions in Scenic and the basic operations available for them, see region.
- local
scenic.core.regions.Region
scenic.core.regions.PointSetRegion
scenic.core.regions.PolylineRegion
scenic.core.regions.PathRegion
2D regions represent a 2D shape parallel to the XY plane, at a certain elevation in space. All 2D regions inherit from PolygonalRegion.
Unlike the more PolygonalRegion, the simple geometric shapes are allowed to depend on random values: for example, the visible region of an Object is a SectorRegion based at the object's position, which might not be fixed.
Since 2D regions cannot contain an Object (which must be 3D), they define a footprint for convenience. Footprints are always a PolygonalFootprintRegion, which represents a 2D polygon extruded infinitely in the positive and negative vertical direction. When checking containment of an Object in a 2D region, Scenic will atuomatically use the footprint.
scenic.core.regions.PolygonalRegion
scenic.core.regions.CircularRegion
scenic.core.regions.SectorRegion
scenic.core.regions.RectangularRegion
3D regions represent points in 3D space.
Most 3D regions inherit from either MeshVolumeRegion or MeshSurfaceRegion, which represent the volume (of a watertight mesh) and the surface of a mesh respectively. Various region classes are also provided to create primitive shapes. MeshVolumeRegion can be converted to MeshSurfaceRegion (and vice versa) using the the getSurfaceRegion and getVolumeRegion methods.
PolygonalFootprintRegions represent the footprint of a 2D region. See 2D Regions for more details.
scenic.core.regions.MeshVolumeRegion
scenic.core.regions.MeshSurfaceRegion
scenic.core.regions.BoxRegion
scenic.core.regions.SpheroidRegion
scenic.core.regions.PolygonalFootprintRegion
3.0
scenic.core.regions.GridRegion