Skip to content

Commit ce06730

Browse files
committed
docs: use param-type span for Configuration Parameters types
1 parent 75602d2 commit ce06730

1 file changed

Lines changed: 33 additions & 33 deletions

File tree

InterDataEngine-docs/concepts/objects.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,17 @@ objects:
6565
6666
### Configuration Parameters
6767
68-
- **name** (*str*): Unique identifier for this object instance.
69-
- **path** (*str*): Path to the USD file containing the object mesh.
70-
- **target_class** (*str*): Must be `RigidObject` for rigid bodies.
71-
- **dataset** (*str*): Dataset source identifier.
72-
- **category** (*str*): Object category name.
73-
- **prim_path_child** (*str*): Name of the child prim that contains the mesh.
74-
- **translation** (*list*): Initial position [x, y, z] in world coordinates.
75-
- **euler** (*list*): Initial rotation in degrees [roll, pitch, yaw].
76-
- **scale** (*list*): Scale factors for each axis.
77-
- **apply_randomization** (*bool*): Whether to apply domain randomization.
78-
- **orientation_mode** (*str*): Orientation mode for randomization.
68+
- **name** (<span class="param-type">str</span>): Unique identifier for this object instance.
69+
- **path** (<span class="param-type">str</span>): Path to the USD file containing the object mesh.
70+
- **target_class** (<span class="param-type">str</span>): Must be `RigidObject` for rigid bodies.
71+
- **dataset** (<span class="param-type">str</span>): Dataset source identifier.
72+
- **category** (<span class="param-type">str</span>): Object category name.
73+
- **prim_path_child** (<span class="param-type">str</span>): Name of the child prim that contains the mesh.
74+
- **translation** (<span class="param-type">list</span>): Initial position [x, y, z] in world coordinates.
75+
- **euler** (<span class="param-type">list</span>): Initial rotation in degrees [roll, pitch, yaw].
76+
- **scale** (<span class="param-type">list</span>): Scale factors for each axis.
77+
- **apply_randomization** (<span class="param-type">bool</span>): Whether to apply domain randomization.
78+
- **orientation_mode** (<span class="param-type">str</span>): Orientation mode for randomization.
7979

8080

8181
## GeometryObject
@@ -119,11 +119,11 @@ objects:
119119

120120
### Configuration Parameters
121121

122-
- **name** (*str*): Unique identifier for this object.
123-
- **path** (*str*): Path to the USD file.
124-
- **target_class** (*str*): Must be `GeometryObject` for static geometry.
125-
- **translation** (*list*): Position in world coordinates.
126-
- **scale** (*list*): Scale factors for each axis.
122+
- **name** (<span class="param-type">str</span>): Unique identifier for this object.
123+
- **path** (<span class="param-type">str</span>): Path to the USD file.
124+
- **target_class** (<span class="param-type">str</span>): Must be `GeometryObject` for static geometry.
125+
- **translation** (<span class="param-type">list</span>): Position in world coordinates.
126+
- **scale** (<span class="param-type">list</span>): Scale factors for each axis.
127127

128128

129129
## PlaneObject
@@ -211,15 +211,15 @@ objects:
211211

212212
### Configuration Parameters
213213

214-
- **name** (*str*): Unique identifier for the plane.
215-
- **target_class** (*str*): Must be `PlaneObject`.
216-
- **size** (*list*): Plane dimensions [width, height].
217-
- **translation** (*list*): Position [x, y, z].
218-
- **euler** (*list*): Rotation angles [roll, pitch, yaw] in degrees.
219-
- **texture.texture_lib** (*str*): Name of texture library folder.
220-
- **texture.apply_randomization** (*bool*): Whether to randomize texture selection.
221-
- **texture.texture_id** (*int*): Specific texture ID (used when randomization is False).
222-
- **texture.texture_scale** (*list*): Scale factors for texture UV mapping.
214+
- **name** (<span class="param-type">str</span>): Unique identifier for the plane.
215+
- **target_class** (<span class="param-type">str</span>): Must be `PlaneObject`.
216+
- **size** (<span class="param-type">list</span>): Plane dimensions [width, height].
217+
- **translation** (<span class="param-type">list</span>): Position [x, y, z].
218+
- **euler** (<span class="param-type">list</span>): Rotation angles [roll, pitch, yaw] in degrees.
219+
- **texture.texture_lib** (<span class="param-type">str</span>): Name of texture library folder.
220+
- **texture.apply_randomization** (<span class="param-type">bool</span>): Whether to randomize texture selection.
221+
- **texture.texture_id** (<span class="param-type">int</span>): Specific texture ID (used when randomization is False).
222+
- **texture.texture_scale** (<span class="param-type">list</span>): Scale factors for texture UV mapping.
223223

224224

225225
## ArticulatedObject
@@ -299,11 +299,11 @@ objects:
299299

300300
### Configuration Parameters
301301

302-
- **name** (*str*): Unique identifier for the articulated object.
303-
- **target_class** (*str*): Must be `ArticulatedObject`.
304-
- **info_name** (*str*): Name of the skill folder containing `info.json`.
305-
- **euler** (*list*): Initial rotation [roll, pitch, yaw] in degrees.
306-
- **joint_position_range** (*list*): Random range for initial joint position [min, max].
307-
- **apply_randomization** (*bool*): Whether to apply domain randomization.
308-
- **path** (*str*): Path to the USD file (relative to asset_root).
309-
- **category** (*str*): Object category identifier.
302+
- **name** (<span class="param-type">str</span>): Unique identifier for the articulated object.
303+
- **target_class** (<span class="param-type">str</span>): Must be `ArticulatedObject`.
304+
- **info_name** (<span class="param-type">str</span>): Name of the skill folder containing `info.json`.
305+
- **euler** (<span class="param-type">list</span>): Initial rotation [roll, pitch, yaw] in degrees.
306+
- **joint_position_range** (<span class="param-type">list</span>): Random range for initial joint position [min, max].
307+
- **apply_randomization** (<span class="param-type">bool</span>): Whether to apply domain randomization.
308+
- **path** (<span class="param-type">str</span>): Path to the USD file (relative to asset_root).
309+
- **category** (<span class="param-type">str</span>): Object category identifier.

0 commit comments

Comments
 (0)