Skip to content

Commit db690dd

Browse files
RIFJopmai
authored andcommitted
remove UNKNOWN field, put DEFAULT = 0
After discussion in the sensors modelling group, we concluded that UNKNOWN should not be used here, and DEFAULT should be the first field. Also: shorten the lines again, restore old documentation comments see also discussion on the enum guidelines: OpenSimulationInterface/osi-documentation#68 Signed-off-by: RIFJo <jochmann@rt.rif-ev.de>
1 parent 0819913 commit db690dd

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

osi_sensorview.proto

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,10 @@ message CameraSensorView
313313

314314
// Raw image data.
315315
//
316-
// The raw image data in the memory layout specified by the camera sensor
317-
// input configuration. The pixel order is specified in CameraSensorViewConfiguration.pixel_order with the default value PIXEL_ORDER_LEFT_RIGHT_TOP_BOTTOM.
316+
// The raw image data in the memory layout specified by the camera
317+
// sensor input configuration. The pixel order is specified in
318+
// CameraSensorViewConfiguration.pixel_order with the
319+
// default value PIXEL_ORDER_LEFT_RIGHT_TOP_BOTTOM.
318320
//
319321
optional bytes image_data = 2;
320322
}

osi_sensorviewconfiguration.proto

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -742,32 +742,34 @@ message CameraSensorViewConfiguration
742742
// Pixel layout documents the order of pixels in the \c image_data
743743
// in CameraSensorView.
744744
//
745-
// \note this enum does not contain an entry for right-to-left and bottom-to-top, because this is equivalent to a
746-
// 180-degree rotation of the default, which should be indicated in the sensor coordinate
745+
// \note this enum does not contain an entry to do mirroring upside down
746+
// and left-to-right at the same time, because this is equivalent to a
747+
// 180-degree rotation, which should be indicated in the sensor coordinate
747748
// system.
748749
//
749750
enum PixelOrder
750751
{
751-
// Pixel order is unknown (must not be used).
752+
// Pixel data is not mirrored (Default).
753+
// Pixels are ordered left-to-right, top-to-bottom.
752754
//
753-
PIXEL_ORDER_UNKNOWN = 0;
755+
PIXEL_ORDER_DEFAULT = 0;
754756

755757
// Known pixel order that is not supported by OSI.
756758
// Consider proposing an additional format if using
757759
// \c #PIXEL_ORDER_OTHER.
758760
//
759761
PIXEL_ORDER_OTHER = 1;
760-
761-
// Pixels are ordered left-to-right, top-to-bottom (default)
762-
//
763-
PIXEL_ORDER_LEFT_RIGHT_TOP_BOTTOM = 2;
764-
765-
// Pixels are ordered right-to-left, top-to-bottom
762+
763+
// Pixels are ordered right-to-left, top-to-bottom.
764+
// Pixel data is mirrored along the vertical axis.
765+
// The image is mirrored left-to-right.
766766
//
767767
PIXEL_ORDER_RIGHT_LEFT_TOP_BOTTOM = 3;
768768

769-
// Pixels are ordered left-to-right, bottom-to-top
770-
//
769+
// Pixels are ordered left-to-right, bottom-to-top.
770+
// Pixel data is mirrored along the horizontal axis.
771+
// The image is mirrored top-to-bottom.
772+
//
771773
PIXEL_ORDER_LEFT_RIGHT_BOTTOM_TOP = 4;
772774
}
773775

0 commit comments

Comments
 (0)