Python guide and API reference#

Summary#

ArticulationEntity

Access articulation state for a collection of prims.

PhysicsEntity

Access named tensor data for a collection of physics prims.

RigidBodyEntity

Access rigid-body state for a collection of prims.

Implementations#

ArticulationEntity#

class isaacsim.physics.entities.ArticulationEntity(
self,
engine: str,
paths: str | collections.abc.Sequence[str],
)#

Bases: PhysicsEntity

Access articulation state for a collection of prims.

Create an articulation view for an engine and prim paths.

property dof_names#

Degree-of-freedom names in view order.

property dof_paths#

Degree-of-freedom paths in view order.

property dof_types#

Degree-of-freedom types in view order.

get_data#

Return named data for selected prims.

get_dof_armatures#

Return armatures for selected degrees of freedom.

get_dof_coriolis_and_centrifugal_compensation_forces#

Return Coriolis and centrifugal compensation forces for selected degrees of freedom.

get_dof_drive_model_properties#

Return drive-model properties for selected degrees of freedom.

get_dof_drive_types#

Return drive types for selected degrees of freedom.

get_dof_efforts#

Return efforts for selected degrees of freedom.

get_dof_friction_properties#

Return friction properties for selected degrees of freedom.

get_dof_gains#

Return stiffness and damping gains for selected drives.

get_dof_gravity_compensation_forces#

Return gravity compensation forces for selected degrees of freedom.

get_dof_indices#

Return view indices for named degrees of freedom.

get_dof_limits#

Return lower and upper limits for selected degrees of freedom.

get_dof_max_efforts#

Return maximum efforts for selected degrees of freedom.

get_dof_max_velocities#

Return maximum velocities for selected degrees of freedom.

get_dof_position_targets#

Return position targets for selected degrees of freedom.

get_dof_positions#

Return positions for selected degrees of freedom.

get_dof_projected_joint_forces#

Return projected joint forces for selected degrees of freedom.

get_dof_velocities#

Return velocities for selected degrees of freedom.

get_dof_velocity_targets#

Return velocity targets for selected degrees of freedom.

get_fixed_tendon_dampings#

Return dampings for selected fixed tendons.

get_fixed_tendon_limit_stiffnesses#

Return limit stiffnesses for selected fixed tendons.

get_fixed_tendon_limits#

Return lower and upper limits for selected fixed tendons.

get_fixed_tendon_offsets#

Return offsets for selected fixed tendons.

get_fixed_tendon_rest_lengths#

Return rest lengths for selected fixed tendons.

get_fixed_tendon_stiffnesses#

Return stiffnesses for selected fixed tendons.

get_jacobian_matrices#

Return Jacobian matrices for selected articulations.

get_joint_indices#

Return view indices for named joints.

Return center-of-mass poses for selected links.

Return whether gravity is enabled for selected links.

Return incoming joint forces for selected links.

Return view indices for named links.

Return inertias or inverse inertias for selected links.

Return masses or inverse masses for selected links.

get_mass_matrices#

Return generalized mass matrices for selected articulations.

get_multi_data#

Return named multi-dimensional data for selected prims.

get_velocities#

Return root linear and angular velocities for selected articulations.

get_world_poses#

Return root world-space positions and orientations for selected articulations.

property jacobian_matrix_shape#

Shape of one articulation Jacobian matrix.

property joint_names#

Joint names in view order.

property joint_paths#

Joint paths in view order.

property joint_types#

Joint types in view order.

Link names in view order.

Link paths in view order.

property mass_matrix_shape#

Shape of one articulation mass matrix.

property num_dofs#

Number of degrees of freedom per articulation.

property num_fixed_tendons#

Number of fixed tendons per articulation.

property num_joints#

Number of joints per articulation.

Number of links per articulation.

property num_prims#

Number of prims in the view.

property num_shapes#

Number of shapes per articulation.

set_data#

Set named data for selected prims.

set_dof_armatures#

Set armatures for selected degrees of freedom.

set_dof_drive_model_properties#

Set drive-model properties for selected degrees of freedom.

set_dof_efforts#

Set efforts for selected degrees of freedom.

set_dof_friction_properties#

Set friction properties for selected degrees of freedom.

set_dof_gains#

Set stiffness or damping gains for selected drives.

set_dof_limits#

Set lower or upper limits for selected degrees of freedom.

set_dof_max_efforts#

Set maximum efforts for selected degrees of freedom.

set_dof_max_velocities#

Set maximum velocities for selected degrees of freedom.

set_dof_position_targets#

Set position targets for selected degrees of freedom.

set_dof_positions#

Set positions for selected degrees of freedom.

set_dof_velocities#

Set velocities for selected degrees of freedom.

set_dof_velocity_targets#

Set velocity targets for selected degrees of freedom.

set_fixed_tendon_properties#

Set properties for selected fixed tendons.

Set center-of-mass positions or orientations for selected links.

Enable or disable gravity for selected links.

Set inertias for selected links.

Set masses for selected links.

set_multi_data#

Set named multi-dimensional data for selected prims.

set_velocities#

Set root linear or angular velocities for selected articulations.

set_world_poses#

Set root world-space positions or orientations for selected articulations.

switch_dof_control_mode#

Select the control mode for selected degrees of freedom.

PhysicsEntity#

class isaacsim.physics.entities.PhysicsEntity(
self,
engine: str,
entity: str,
paths: str | collections.abc.Sequence[str],
)#

Bases: object

Access named tensor data for a collection of physics prims.

Create an entity view for the requested engine, entity type, and prim paths.

get_data#

Return named data for selected prims.

get_multi_data#

Return named multi-dimensional data for selected prims.

property num_prims#

Number of prims in the view.

set_data#

Set named data for selected prims.

set_multi_data#

Set named multi-dimensional data for selected prims.

RigidBodyEntity#

class isaacsim.physics.entities.RigidBodyEntity(
self,
engine: str,
paths: str | collections.abc.Sequence[str],
)#

Bases: PhysicsEntity

Access rigid-body state for a collection of prims.

Create a rigid-body view for an engine and prim paths.

apply_forces#

Apply world-space forces to selected bodies.

apply_forces_and_torques_at_positions#

Apply forces or torques at world-space positions on selected bodies.

get_coms#

Return center-of-mass poses for selected bodies.

get_data#

Return named data for selected prims.

get_enabled_gravities#

Return whether gravity is enabled for selected bodies.

get_enabled_rigid_bodies#

Return whether selected rigid bodies are enabled.

get_inertias#

Return inertias or inverse inertias for selected bodies.

get_masses#

Return masses or inverse masses for selected bodies.

get_multi_data#

Return named multi-dimensional data for selected prims.

get_velocities#

Return linear and angular velocities for selected bodies.

get_world_poses#

Return world-space positions and orientations for selected bodies.

property num_prims#

Number of prims in the view.

property num_shapes#

Number of shapes associated with each rigid body.

set_coms#

Set center-of-mass positions or orientations for selected bodies.

set_data#

Set named data for selected prims.

set_enabled_gravities#

Enable or disable gravity for selected bodies.

set_enabled_rigid_bodies#

Enable or disable selected rigid bodies.

set_inertias#

Set inertias for selected bodies.

set_masses#

Set masses for selected bodies.

set_multi_data#

Set named multi-dimensional data for selected prims.

set_velocities#

Set linear or angular velocities for selected bodies.

set_world_poses#

Set world-space positions or orientations for selected bodies.