File size: 4,772 Bytes
d6b3397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | isaaclab.sim.schemas
====================
.. automodule:: isaaclab.sim.schemas
.. rubric:: Solver-common base classes
These base classes carry the universal-physics fields that every backend honors.
They live in core ``isaaclab`` and have no backend dependency. For backend-specific
knobs, use the matching subclass in :mod:`isaaclab_physx.sim.schemas` or
:mod:`isaaclab_newton.sim.schemas`. See :doc:`/source/overview/core-concepts/schema_cfgs`
for the full design.
.. autosummary::
ArticulationRootBaseCfg
RigidBodyBaseCfg
CollisionBaseCfg
JointDriveBaseCfg
MeshCollisionBaseCfg
MassPropertiesCfg
JointDrivePropertiesCfg
FixedTendonPropertiesCfg
DeformableBodyPropertiesBaseCfg
.. rubric:: Mesh collision approximations (USD-only, no PhysX schema)
.. autosummary::
BoundingCubePropertiesCfg
BoundingSpherePropertiesCfg
.. rubric:: Functions
.. autosummary::
define_articulation_root_properties
modify_articulation_root_properties
define_rigid_body_properties
modify_rigid_body_properties
activate_contact_sensors
define_collision_properties
modify_collision_properties
define_mass_properties
modify_mass_properties
modify_joint_drive_properties
define_mesh_collision_properties
modify_mesh_collision_properties
modify_fixed_tendon_properties
define_deformable_body_properties
modify_deformable_body_properties
Articulation Root
-----------------
.. autoclass:: ArticulationRootBaseCfg
:members:
:exclude-members: __init__
.. autofunction:: define_articulation_root_properties
.. autofunction:: modify_articulation_root_properties
For PhysX-specific articulation properties (self-collisions, TGS solver iterations,
sleep/stabilization thresholds), see
:class:`~isaaclab_physx.sim.schemas.PhysxArticulationRootPropertiesCfg`. For
Newton-native self-collisions, see
:class:`~isaaclab_newton.sim.schemas.NewtonArticulationRootPropertiesCfg`.
Rigid Body
----------
.. autoclass:: RigidBodyBaseCfg
:members:
:exclude-members: __init__
.. autofunction:: define_rigid_body_properties
.. autofunction:: modify_rigid_body_properties
.. autofunction:: activate_contact_sensors
For PhysX-specific rigid body properties (damping, max velocities, solver iterations,
sleep/stabilization), see :class:`~isaaclab_physx.sim.schemas.PhysxRigidBodyPropertiesCfg`.
For MuJoCo-specific gravity compensation, see
:class:`~isaaclab_newton.sim.schemas.MujocoRigidBodyPropertiesCfg`.
Collision
---------
.. autoclass:: CollisionBaseCfg
:members:
:exclude-members: __init__
.. autofunction:: define_collision_properties
.. autofunction:: modify_collision_properties
For PhysX torsional patch friction, see
:class:`~isaaclab_physx.sim.schemas.PhysxCollisionPropertiesCfg`. For Newton-native
contact margin/gap, see
:class:`~isaaclab_newton.sim.schemas.NewtonCollisionPropertiesCfg`.
Mass
----
.. autoclass:: MassPropertiesCfg
:members:
:exclude-members: __init__
.. autofunction:: define_mass_properties
.. autofunction:: modify_mass_properties
Joint Drive
-----------
.. autoclass:: JointDriveBaseCfg
:members:
:exclude-members: __init__
.. autofunction:: modify_joint_drive_properties
For PhysX-specific drive properties, see
:class:`~isaaclab_physx.sim.schemas.PhysxJointDrivePropertiesCfg`. For MuJoCo
actuator gravity compensation, see
:class:`~isaaclab_newton.sim.schemas.MujocoJointDrivePropertiesCfg`.
Mesh Collision
--------------
.. autoclass:: MeshCollisionBaseCfg
:members:
:exclude-members: __init__
.. autoclass:: BoundingCubePropertiesCfg
:members:
:show-inheritance:
:exclude-members: __init__
.. autoclass:: BoundingSpherePropertiesCfg
:members:
:show-inheritance:
:exclude-members: __init__
.. autofunction:: define_mesh_collision_properties
.. autofunction:: modify_mesh_collision_properties
For PhysX cooking schemas (convex hull / decomposition / triangle mesh / SDF),
see the ``Physx*PropertiesCfg`` family in :mod:`isaaclab_physx.sim.schemas`.
For Newton hull-vertex limit, see
:class:`~isaaclab_newton.sim.schemas.NewtonMeshCollisionPropertiesCfg`.
Tendon
------
.. autofunction:: modify_fixed_tendon_properties
.. autofunction:: modify_spatial_tendon_properties
Tendon cfg classes are PhysX-only and live in
:mod:`isaaclab_physx.sim.schemas`
(:class:`~isaaclab_physx.sim.schemas.PhysxFixedTendonPropertiesCfg`,
:class:`~isaaclab_physx.sim.schemas.PhysxSpatialTendonPropertiesCfg`).
Deformable Body
---------------
.. autoclass:: DeformableBodyPropertiesBaseCfg
:members:
:show-inheritance:
:exclude-members: __init__
.. autofunction:: define_deformable_body_properties
.. autofunction:: modify_deformable_body_properties
|