Skip to content

Commit 638d408

Browse files
authored
Apply suggestions from CCB code review
Signed-off-by: Pierre R. Mai <[email protected]>
1 parent 0cf4e9f commit 638d408

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

osi_object.proto

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,7 +1107,12 @@ message MovingObject
11071107
// the pedestrian model used. For example, some simulators will not include
11081108
// detailed data about the hands of a pedestrian.
11091109
//
1110-
repeated Bone skeleton_data = 2;
1110+
// \note A bone of each type can be provided, or left out, depending
1111+
// on the desired level of detail, or available data. However, if a
1112+
// bone is defined, all bones in the chain from that bone back to
1113+
// the root point must be provided to create a complete chain.
1114+
//
1115+
repeated Bone skeleton_bone = 2;
11111116

11121117
//
11131118
// \brief Bones in the skeleton of the pedestrian.
@@ -1152,14 +1157,15 @@ message MovingObject
11521157
//
11531158
optional Orientation3d orientation = 3;
11541159

1155-
// Orientation of the bone.
1160+
// Length of the bone.
11561161
//
1157-
// Reference System is the root, defined by bbcenter_to_root
1158-
// (\c PedestrianAttributes::bbcenter_to_root).
1162+
// Measured along its major axis.
1163+
//
1164+
// Unit: m
11591165
//
11601166
optional float length = 4;
11611167

1162-
// Determines a bone is explicitly missing from the pedestrian model.
1168+
// Determines whether a bone is explicitly missing from the pedestrian model.
11631169
//
11641170
// In case a pedestrian has missing limbs this can be explicitly communicated
11651171
// by setting this boolean to TRUE.
@@ -1168,11 +1174,6 @@ message MovingObject
11681174

11691175
// The type of the bone.
11701176
//
1171-
// \note Bone of each type can be assigned, or left empty depending
1172-
// on the desired level of detail, or present data. However, if a
1173-
// bone is defined, all bones in the chain from that bone back to
1174-
// the root point must be defined to create a complete chain.
1175-
//
11761177
// \image html OSI_PedestrianModelHierarchy.jpg
11771178
//
11781179
enum Type
@@ -1186,75 +1187,75 @@ message MovingObject
11861187
//
11871188
TYPE_HIP = 1;
11881189

1189-
// Bone defines the lower part of the spine.
1190+
// Bone defining the lower part of the spine.
11901191
//
11911192
TYPE_LOWER_SPINE = 2;
11921193

1193-
// Bone defines the upper part of the spine.
1194+
// Bone defining the upper part of the spine.
11941195
//
11951196
TYPE_UPPER_SPINE = 3;
11961197

1197-
// Bone defines the neck.
1198+
// Bone defining the neck.
11981199
//
11991200
TYPE_NECK = 4;
12001201

1201-
// Bone defines the head.
1202+
// Bone defining the head.
12021203
//
12031204
TYPE_HEAD = 5;
12041205

1205-
// Bone defines the left shoulder.
1206+
// Bone defining the left shoulder.
12061207
//
12071208
TYPE_SHOULDER_L = 6;
12081209

1209-
// Bone defines the right shoulder.
1210+
// Bone defining the right shoulder.
12101211
//
12111212
TYPE_SHOULDER_R = 7;
12121213

1213-
// Bone defines the left upper arm.
1214+
// Bone defining the left upper arm.
12141215
//
12151216
TYPE_UPPER_ARM_L = 8;
12161217

1217-
// Bone defines the right upper arm.
1218+
// Bone defining the right upper arm.
12181219
//
12191220
TYPE_UPPER_ARM_R = 9;
12201221

1221-
// Bone defines the left forearm.
1222+
// Bone defining the left forearm.
12221223
//
12231224
TYPE_LOWER_ARM_L = 10;
12241225

1225-
// Bone defines the right forearm.
1226+
// Bone defining the right forearm.
12261227
//
12271228
TYPE_LOWER_ARM_R = 11;
12281229

1229-
// Bone defines the left hand.
1230+
// Bone defining the left hand.
12301231
//
12311232
TYPE_FULL_HAND_L = 12;
12321233

1233-
// Bone defines the right hand.
1234+
// Bone defining the right hand.
12341235
//
12351236
TYPE_FULL_HAND_R = 13;
12361237

1237-
// Bone defines the left thigh.
1238+
// Bone defining the left thigh.
12381239
//
12391240
TYPE_UPPER_LEG_L = 14;
12401241

1241-
// Bone defines the right thigh.
1242+
// Bone defining the right thigh.
12421243
//
12431244
TYPE_UPPER_LEG_R = 15;
12441245

1245-
// Bone defines the left shin.
1246+
// Bone defining the left shin.
12461247
//
12471248
TYPE_LOWER_LEG_L = 16;
12481249

1249-
// Bone defines the right shin.
1250+
// Bone defining the right shin.
12501251
//
12511252
TYPE_LOWER_LEG_R = 17;
12521253

1253-
// Bone defines the left foot.
1254+
// Bone defining the left foot.
12541255
//
12551256
TYPE_FULL_FOOT_L = 18;
12561257

1257-
// Bone defines the right foot.
1258+
// Bone defining the right foot.
12581259
//
12591260
TYPE_FULL_FOOT_R = 19;
12601261
}

0 commit comments

Comments
 (0)