Skip to content

Commit d0ae8e4

Browse files
authored
Merge pull request #470 from OpenSimulationInterface/documentation/ground-clearance_bb_relation
Documentation/ground clearance bb relation
2 parents 4d9597a + c7b7195 commit d0ae8e4

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

osi_detectedobject.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ message DetectedMovingObject
159159
//
160160
// \note The bounding box does NOT includes mirrors for vehicles.
161161
// \note The parent frame of \c base is the sensor's vehicle frame.
162+
// \note The height includes the ground_clearance. It always goes from the
163+
// top to the ground.
162164
//
163165
optional BaseMoving base = 2;
164166

osi_object.proto

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,8 @@ message MovingObject
292292
// The base parameters of the vehicle.
293293
//
294294
// \note The bounding box does NOT include side mirrors for vehicles.
295+
// \note The height includes the ground_clearance. It always goes from the
296+
// top to the ground.
295297
//
296298
optional BaseMoving base = 2;
297299

@@ -442,11 +444,12 @@ message MovingObject
442444
//
443445
optional Vector3d bbcenter_to_front = 5;
444446

445-
// Static minimal distance in m of under-body plane to ground
446-
// surface plane (i.e. disregarding driving dynamic effects or road
447-
// surface effects) under neutral load conditions. Can be useful to
448-
// approximate the clear area under a vehicle that a sensor can see
449-
// through.
447+
// Static minimal distance or space from the lowest point of the vehicle's
448+
// body to the surface plane below it under neutral load conditions. This
449+
// distance disregards, for example, driving-dynamic effects or
450+
// road-surface effects. Can be useful to approximate the clearance area
451+
// under a vehicle that a sensor can see through.
452+
// \note \c ground_clearance is included in the bounding box height.
450453
//
451454
optional double ground_clearance = 6;
452455

0 commit comments

Comments
 (0)