Skip to content

Commit 7a6f3b0

Browse files
committed
Document isaaclab.utils.warp.fabric kernels
The submodule was not surfaced anywhere in the Sphinx tree, so :func: cross-references to its kernels (added in the changelog fragment for this branch and used by FabricFrameView throughout) did not resolve. Add a Warp Fabric kernels subsection to isaaclab.utils.rst that automodule's the submodule, and add __all__ to fabric.py so the generated page lists only the eight public kernels - the type aliases (FabricArrayMat44d, ArrayUInt32, ...) and the re-imported `wp` / `TYPE_CHECKING` / `Any` symbols stay out of the rendered docs. The page covers both the pre-existing kernels (compose/decompose_fabric_transformation_matrix_*_warp_arrays, set_view_to_fabric_array, arange_k) and the four kernels added on this branch.
1 parent 8a1b5db commit 7a6f3b0

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

docs/source/api/lab/isaaclab.utils.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,3 +188,16 @@ Warp operations
188188
:members:
189189
:imported-members:
190190
:show-inheritance:
191+
192+
Warp Fabric kernels
193+
^^^^^^^^^^^^^^^^^^^
194+
195+
Warp kernels for reading and writing Fabric ``Matrix4d`` attributes
196+
(``omni:fabric:worldMatrix`` / ``omni:fabric:localMatrix``) via
197+
:class:`wp.fabricarray` and :class:`wp.indexedfabricarray`. Used by
198+
:class:`~isaaclab_physx.sim.views.FabricFrameView` to keep child world and
199+
local matrices consistent without round-tripping through USD.
200+
201+
.. automodule:: isaaclab.utils.warp.fabric
202+
:members:
203+
:show-inheritance:

source/isaaclab/isaaclab/utils/warp/fabric.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@
1515

1616
import warp as wp
1717

18+
__all__ = [
19+
"arange_k",
20+
"compose_fabric_transformation_matrix_from_warp_arrays",
21+
"compose_indexed_fabric_transforms",
22+
"decompose_fabric_transformation_matrix_to_warp_arrays",
23+
"decompose_indexed_fabric_transforms",
24+
"set_view_to_fabric_array",
25+
"update_indexed_local_matrix_from_world",
26+
"update_indexed_world_matrix_from_local",
27+
]
28+
1829
if TYPE_CHECKING:
1930
FabricArrayUInt32 = Any
2031
FabricArrayMat44d = Any

0 commit comments

Comments
 (0)