Skip to content

Commit 826caef

Browse files
Update the guidance
1 parent 5f3c42a commit 826caef

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

pxr/usd/usdGeom/pointInstancer.h

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,15 @@ class SdfAssetPath;
232232
/// such that they will automatically be skipped by basic UsdPrim::GetChildren()
233233
/// or UsdPrimRange traversals. Usd prims each have a
234234
/// \ref Usd_PrimSpecifiers "specifier" of "def", "over", or "class". The
235-
/// default traversals skip over prims that are "pure overs" or classes. So
235+
/// default traversals skip over prims that are "pure overs". So
236236
/// to protect prototypes from all generic traversals and processing, place
237-
/// them under a prim that is just an "over". For example,
237+
/// them under a prim that is an "class" or "over". "class" is recommended
238+
/// , while "over" should be used when backwards compatibility with older
239+
/// versions of USD is needed. For example,
238240
/// \code
239241
/// 01 def PointInstancer "Crowd_Mid"
240242
/// 02 {
241-
/// 03 rel prototypes = [ </Crowd_Mid/Prototypes/MaleThin_Business>, </Crowd_Mid/Prototypes/MaleThin_Casual> ]
243+
/// 03 rel prototypes = [ </Crowd_Mid/Prototypes/MaleThin_Business>, </Crowd_Mid/OtherPrototypes/MaleThin_Casual> ]
242244
/// 04
243245
/// 05 over "Prototypes"
244246
/// 06 {
@@ -250,11 +252,14 @@ class SdfAssetPath;
250252
/// 12 }
251253
/// 13 )
252254
/// 14 { ... }
253-
/// 15
254-
/// 16 def "MaleThin_Casual"
255-
/// 17 ...
256-
/// 18 }
257-
/// 19 }
255+
/// 15 }
256+
/// 16
257+
/// 17 class "OtherPrototypes"
258+
/// 18 {
259+
/// 19 def "MaleThin_Casual"
260+
/// 20 ...
261+
/// 21 }
262+
/// 22 }
258263
/// \endcode
259264
///
260265
///

0 commit comments

Comments
 (0)