1- isaaclab.sim.schemas
1+ isaaclab.sim.schemas
22====================
33
44.. automodule :: isaaclab.sim.schemas
55
6- .. rubric :: Classes
6+ .. rubric :: Solver-common base classes
7+
8+ These base classes carry the universal-physics fields that every backend honors.
9+ They live in core ``isaaclab `` and have no backend dependency. For backend-specific
10+ knobs, use the matching subclass in :mod: `isaaclab_physx.sim.schemas ` or
11+ :mod: `isaaclab_newton.sim.schemas `. See :doc: `/source/overview/core-concepts/schema_cfgs `
12+ for the full design.
713
814 .. autosummary ::
915
10- ArticulationRootPropertiesCfg
11- RigidBodyPropertiesCfg
12- CollisionPropertiesCfg
16+ ArticulationRootBaseCfg
17+ RigidBodyBaseCfg
18+ CollisionBaseCfg
19+ JointDriveBaseCfg
20+ MeshCollisionBaseCfg
1321 MassPropertiesCfg
14- JointDrivePropertiesCfg
15- FixedTendonPropertiesCfg
22+
23+ .. rubric :: Mesh collision approximations (USD-only, no PhysX schema)
24+
25+ .. autosummary ::
26+
27+ BoundingCubePropertiesCfg
28+ BoundingSpherePropertiesCfg
1629
1730 .. rubric :: Functions
1831
2841 define_mass_properties
2942 modify_mass_properties
3043 modify_joint_drive_properties
44+ define_mesh_collision_properties
45+ modify_mesh_collision_properties
3146 modify_fixed_tendon_properties
47+ modify_spatial_tendon_properties
48+
49+ .. currentmodule :: isaaclab.sim.schemas
3250
3351Articulation Root
3452-----------------
3553
36- .. autoclass :: ArticulationRootPropertiesCfg
54+ .. autoclass :: ArticulationRootBaseCfg
3755 :members:
3856 :exclude-members: __init__
3957
4058.. autofunction :: define_articulation_root_properties
4159.. autofunction :: modify_articulation_root_properties
4260
61+ For PhysX-specific articulation properties (self-collisions, TGS solver iterations,
62+ sleep/stabilization thresholds), see
63+ :class: `~isaaclab_physx.sim.schemas.PhysxArticulationRootPropertiesCfg `. For
64+ Newton-native self-collisions, see
65+ :class: `~isaaclab_newton.sim.schemas.NewtonArticulationRootPropertiesCfg `.
66+
4367Rigid Body
4468----------
4569
46- .. autoclass :: RigidBodyPropertiesCfg
70+ .. autoclass :: RigidBodyBaseCfg
4771 :members:
4872 :exclude-members: __init__
4973
5074.. autofunction :: define_rigid_body_properties
5175.. autofunction :: modify_rigid_body_properties
5276.. autofunction :: activate_contact_sensors
5377
78+ For PhysX-specific rigid body properties (damping, max velocities, solver iterations,
79+ sleep/stabilization), see :class: `~isaaclab_physx.sim.schemas.PhysxRigidBodyPropertiesCfg `.
80+ For MuJoCo-specific gravity compensation, see
81+ :class: `~isaaclab_newton.sim.schemas.MujocoRigidBodyPropertiesCfg `.
82+
5483Collision
5584---------
5685
57- .. autoclass :: CollisionPropertiesCfg
86+ .. autoclass :: CollisionBaseCfg
5887 :members:
5988 :exclude-members: __init__
6089
6190.. autofunction :: define_collision_properties
6291.. autofunction :: modify_collision_properties
6392
93+ For PhysX torsional patch friction, see
94+ :class: `~isaaclab_physx.sim.schemas.PhysxCollisionPropertiesCfg `. For Newton-native
95+ contact margin/gap, see
96+ :class: `~isaaclab_newton.sim.schemas.NewtonCollisionPropertiesCfg `.
97+
6498Mass
6599----
66100
@@ -74,20 +108,52 @@ Mass
74108Joint Drive
75109-----------
76110
77- .. autoclass :: JointDrivePropertiesCfg
111+ .. autoclass :: JointDriveBaseCfg
78112 :members:
79113 :exclude-members: __init__
80114
81115.. autofunction :: modify_joint_drive_properties
82116
83- Fixed Tendon
84- ------------
117+ For PhysX-specific drive properties, see
118+ :class: `~isaaclab_physx.sim.schemas.PhysxJointDrivePropertiesCfg `. For MuJoCo
119+ actuator gravity compensation, see
120+ :class: `~isaaclab_newton.sim.schemas.MujocoJointDrivePropertiesCfg `.
121+
122+ Mesh Collision
123+ --------------
85124
86- .. autoclass :: FixedTendonPropertiesCfg
125+ .. autoclass :: MeshCollisionBaseCfg
87126 :members:
88127 :exclude-members: __init__
89128
129+ .. autoclass :: BoundingCubePropertiesCfg
130+ :members:
131+ :show-inheritance:
132+ :exclude-members: __init__
133+
134+ .. autoclass :: BoundingSpherePropertiesCfg
135+ :members:
136+ :show-inheritance:
137+ :exclude-members: __init__
138+
139+ .. autofunction :: define_mesh_collision_properties
140+ .. autofunction :: modify_mesh_collision_properties
141+
142+ For PhysX cooking schemas (convex hull / decomposition / triangle mesh / SDF),
143+ see the ``Physx*PropertiesCfg `` family in :mod: `isaaclab_physx.sim.schemas `.
144+ For Newton hull-vertex limit, see
145+ :class: `~isaaclab_newton.sim.schemas.NewtonMeshCollisionPropertiesCfg `.
146+
147+ Tendon
148+ ------
149+
90150.. autofunction :: modify_fixed_tendon_properties
151+ .. autofunction :: modify_spatial_tendon_properties
152+
153+ Tendon cfg classes are PhysX-only and live in
154+ :mod: `isaaclab_physx.sim.schemas `
155+ (:class: `~isaaclab_physx.sim.schemas.PhysxFixedTendonPropertiesCfg `,
156+ :class: `~isaaclab_physx.sim.schemas.PhysxSpatialTendonPropertiesCfg `).
91157
92158Deformable Body
93159---------------
0 commit comments