Skip to content

Commit 0ab3731

Browse files
3d bbox doc t2 (#424)
* Updated documentation for 3dbbox about skinnedmeshrenderers * Updated text
1 parent 4d04ae1 commit 0ab3731

File tree

4 files changed

+12
-1
lines changed

4 files changed

+12
-1
lines changed

com.unity.perception/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Changed the JSON serialization key of Normal Sampler's standard deviation proper
3535

3636
Fixed an indexing issue with the IdLabelConfig editor. When a new label was added to an empty Id Label Config with Auto Assign IDs enabled, the starting id (0 or 1) was ignored and the new label would always have an id of 0.
3737

38+
Updated documentation to reflect that the 3D Bounding Box Labeler does not support Skinned Mesh Renderers.
39+
3840
## [0.8.0-preview.4] - 2021-07-05
3941

4042
### Upgrade Notes

com.unity.perception/Documentation~/FAQ/FAQ.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,13 @@ This is due to a common graphics problem called *z-fighting*. This occurs when t
6868
---
6969
</details>
7070

71+
<details>
72+
<summary><strong>Q: Why aren't my character models labeled by the 3D Bounding Box Labeler?</strong></summary><br>
73+
74+
Most human character models use Skinned Mesh Renderers. Unfortunately, at this time, GameObjects using this type of renderer are not supported by the 3D Bounding Box Labeler.
75+
76+
---
77+
</details>
7178

7279
## <a name="randomization">Randomization</a>
7380

com.unity.perception/Documentation~/PerceptionCamera.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ The BoundingBox2DLabeler produces 2D bounding boxes for each visible object with
6666

6767
### Bounding Box 3D Labeler
6868

69-
The Bounding Box 3D Ground Truth Labeler produces 3D ground truth bounding boxes for each labeled game object in the scene. Unlike the 2D bounding boxes, 3D bounding boxes are calculated from the labeled meshes in the scene and all objects (independent of their occlusion state) are recorded.
69+
The Bounding Box 3D Ground Truth Labeler produces 3D ground truth bounding boxes for each labeled GameObject in the Scene. Unlike the 2D bounding boxes, 3D bounding boxes are calculated from the labeled meshes in the scene and all objects (independent of their occlusion state) are recorded.
70+
***Note:*** The Bounding Box 3D Labeler does not support GameObjects with Skinned Mesh Renderers, they will be ignored
7071

7172
### Object Count Labeler
7273

com.unity.perception/Runtime/GroundTruth/Labelers/BoundingBox3DLabeler.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ namespace UnityEngine.Perception.GroundTruth
1212
/// <summary>
1313
/// Produces 3d bounding box ground truth for all visible and <see cref="Labeling"/> objects each frame.
1414
/// </summary>
15+
/// <remarks>The BoundingBox3DLabeler does not support <see cref="SkinnedMeshRenderer"/> objects, they will be ignored.</remarks>
1516
public class BoundingBox3DLabeler : CameraLabeler
1617
{
1718
///<inheritdoc/>

0 commit comments

Comments
 (0)