Added additional documentation for using footprint w/ intersects op

BerkeleyLearnVerify · Oct 31, 2023 · 9da91dc · 9da91dc
1 parent 5f78382
commit 9da91dc
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -47,7 +47,7 @@ Glossary
 	footprint
 		The infinite extrusion of a 2D `region` in the positive and negative Z directions.
 		Testing containment of an `object` in a 2D region automatically uses its footprint, so that the object is considered contained if and only if its projection into the plane of the region is contained in the region.
-		Footprints are represented internally by instances of the `PolygonalFootprintRegion` class.
+		Footprints are represented internally by instances of the `PolygonalFootprintRegion` class, and can be accessed using the `fooprint` attribute.
 
 	global parameters
 		Parameters of a scene like weather or time of day which are not associated with any object.

diff --git a/docs/reference/operators.rst b/docs/reference/operators.rst
@@ -71,7 +71,7 @@ Whether a position or `Object` lies in the `Region`; for the latter, the object
 
 (*Object* | *region*) intersects (*Object* | *region*)
 ------------------------------------------------------
-Whether an `Object`/`Region` intersects another `Object`/`Region`, i.e. whether any portion of the occupied spaces intersect.
+Whether an `Object`/`Region` intersects another `Object`/`Region`, i.e. whether any portion of the occupied spaces intersect. It can often be useful to check intersection with the :term:`footprint` of a region, e.g. when checking whether a car intersects a given lane. In this case, one would write :scenic:`car intersects lane.footprint` instead of :scenic:`car intersects lane`. For more details, see :term:`footprint`.
 
 
 Orientation Operators