Python guide and API reference#

Summary#

stage

Stage

Wrap a USD stage and provide lifecycle and scene-level operations.

prim

Prim

Wrap one or more USD prims on the active stage.

xform

Xform

Wrap one or more transformable USD prims.

camera

Camera

Wrap or create one or more USD Camera prims.

mesh

Mesh

Wrap or create one or more USD Mesh prims.

shapes

Capsule

Wrap or create one or more USD Capsule prims.

Cone

Wrap or create one or more USD Cone prims.

Cube

Wrap or create one or more USD Cube prims.

Cylinder

Wrap or create one or more USD Cylinder prims.

Plane

Wrap or create one or more USD Plane prims.

Shape

Base wrapper for batched geometric-shape prims.

Sphere

Wrap or create one or more USD Sphere prims.

lights

CylinderLight

Wrap or create one or more USD CylinderLight prims.

DiskLight

Wrap or create one or more USD DiskLight prims.

DistantLight

Wrap or create one or more USD DistantLight prims.

DomeLight

Wrap or create one or more USD DomeLight prims.

Light

Base wrapper for batched USD light prims.

RectLight

Wrap or create one or more USD RectLight prims.

SphereLight

Wrap or create one or more USD SphereLight prims.

physics scenes

NewtonMjcScene

Wrap or create one or more USD PhysicsScene prims configured for Newton.

PhysicsScene

Wrap or create one or more solver-agnostic USD PhysicsScene prims.

PhysxGpuCfg

Store optional batched GPU buffer sizes for PhysX scenes.

PhysxScene

Wrap or create one or more USD PhysicsScene prims configured for PhysX.

Implementations#

Stage#

class isaacsim.foundation.objects.Stage(self, backend: str, stage_id: int | None = None)#

Bases: object

Wrap a USD stage and provide lifecycle and scene-level operations.

Parameters:
  • backend – The stage backend, either "openusd" or "ovstage".

  • stage_id – The identifier of an existing stage, or None for an invalid stage.

add_reference#

Add a USD reference at a prim path.

close_stage#

Close the stage and release its resources.

create_stage#

Create a stage, optionally from a template, and return this wrapper.

define_prim#

Define a prim and return its stage path.

export_stage_to_string#

Serialize the stage root layer to a USDA string.

generate_string_representation#

Generate a tree or flat-list representation of the stage hierarchy.

get_backend#

Get the stage backend name.

get_stage_id#

Get the numeric stage identifier.

get_stage_ptr#

Get the address of the underlying stage, or zero if the stage is invalid.

get_time_code#

Get the start, end, and per-second stage time-code values.

get_units#

Get the meters-per-unit and kilograms-per-unit scales.

get_up_axis#

Get the stage up-axis token.

import_stage_from_string#

Populate the stage from a USDA string and return this wrapper.

is_valid#

Check whether the stage is open and accessible.

move_prim#

Move a prim and return its success state and final path.

open_stage#

Open a USD file and return this wrapper for method chaining.

remove_prim#

Remove a prim and all of its descendants.

save_stage#

Save the stage to a USD file.

set_time_code#

Set any provided stage time-code values.

set_units#

Set one or both stage unit scales.

set_up_axis#

Set the stage up-axis token.

Prim#

class isaacsim.foundation.objects.Prim(
self,
paths: str | collections.abc.Sequence[str],
*,
resolve_paths: bool = True,
)#

Bases: object

Wrap one or more USD prims on the active stage.

Parameters:
  • paths – A prim path or list of paths, optionally containing regular expressions.

  • resolve_paths – Whether to resolve and validate paths during construction.

apply_api#

Apply an API schema to the selected prims.

get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_variant_selection#

Set variant selections on the selected prims.

Xform#

class isaacsim.foundation.objects.Xform(
self,
paths: str | collections.abc.Sequence[str],
*,
resolve_paths: bool = True,
reset_xform_op_properties: bool = True,
)#

Bases: Prim

Wrap one or more transformable USD prims.

Parameters:
  • paths – A prim path or list of paths, optionally containing regular expressions.

  • resolve_paths – Whether to resolve and validate paths during construction.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

Camera#

class isaacsim.foundation.objects.Camera(
self,
paths: str | collections.abc.Sequence[str],
*,
reset_xform_op_properties: bool = True,
)#

Bases: Xform

Wrap or create one or more USD Camera prims.

Parameters:
  • paths – A prim path or list of paths.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
enforce_square_pixels#

Adjust apertures so the requested output resolutions use square pixels.

get_aperture_offsets#

Get horizontal and vertical aperture offsets for the selected cameras.

get_apertures#

Get horizontal and vertical apertures for the selected cameras.

get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_clipping_ranges#

Get near and far clipping distances for the selected cameras.

get_focal_lengths#

Get focal lengths for the selected cameras.

get_focus_distances#

Get focus distances for the selected cameras.

get_fstops#

Get f-stop values for the selected cameras.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_projections#

Get projection-type tokens for the selected cameras.

get_shutter_times#

Get shutter-open and shutter-close times for the selected cameras.

get_stage#

Get the active stage wrapper.

get_stereo_roles#

Get stereo-role tokens for the selected cameras.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_aperture_offsets#

Set horizontal and/or vertical aperture offsets on the selected cameras.

set_apertures#

Set horizontal and/or vertical apertures on the selected cameras.

set_attribute_values#

Set an attribute value on each selected prim.

set_clipping_ranges#

Set near and/or far clipping distances on the selected cameras.

set_focal_lengths#

Set focal lengths on the selected cameras.

set_focus_distances#

Set focus distances on the selected cameras.

set_fstops#

Set f-stop values on the selected cameras.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_projections#

Set projection-type tokens on the selected cameras.

set_shutter_times#

Set shutter-open and/or shutter-close times on the selected cameras.

set_stereo_roles#

Set stereo-role tokens on the selected cameras.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

Mesh#

class isaacsim.foundation.objects.Mesh(
self,
paths: str | collections.abc.Sequence[str],
*,
primitives: str | collections.abc.Sequence[str] | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Xform

Wrap or create one or more USD Mesh prims.

Parameters:
  • paths – A prim path or list of paths.

  • primitives – Optional mesh primitive names used to initialize new prims.

  • colors – Optional display colors for the meshes.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_corner_specs#

Get corner indices and sharpness values for the selected meshes.

get_crease_specs#

Get crease indices, lengths, and sharpness values for the selected meshes.

get_display_colors#

Get display colors for the selected meshes.

get_face_specs#

Get face topology, interpolation, and hole data for the selected meshes.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_normals#

Get normal vectors for the selected meshes.

get_parent#

Get the parent paths of the selected prims.

get_points#

Get vertex positions for the selected meshes.

get_stage#

Get the active stage wrapper.

get_subdivision_specs#

Get subdivision schemes, boundary modes, and triangle rules for the selected meshes.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property num_faces#

The number of faces in each wrapped mesh.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_corner_specs#

Set corner indices and sharpness values on the selected meshes.

set_crease_specs#

Set crease indices, lengths, and sharpness values on the selected meshes.

set_display_colors#

Set display colors on the selected meshes.

set_face_specs#

Set face topology, interpolation, and hole data on the selected meshes.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_normals#

Set normal vectors on the selected meshes.

set_points#

Set vertex positions on the selected meshes.

set_subdivision_specs#

Set subdivision schemes, boundary modes, and triangle rules on the selected meshes.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped meshes.

Shapes#

class isaacsim.foundation.objects.Capsule(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
heights: warp.array | None = None,
axes: str | collections.abc.Sequence[str] | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Shape

Wrap or create one or more USD Capsule prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the capsules.

  • heights – Optional heights for the capsules.

  • axes – Optional capsule-axis tokens.

  • colors – Optional display colors for the capsules.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_axes#

Get axis tokens for the selected capsules.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_heights#

Get heights for the selected capsules.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected capsules.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_axes#

Set axis tokens on the selected capsules.

set_display_colors#

Set display colors on the selected shapes.

set_heights#

Set heights on the selected capsules.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_radii#

Set radii on the selected capsules.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

class isaacsim.foundation.objects.Cone(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
heights: warp.array | None = None,
axes: str | collections.abc.Sequence[str] | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Shape

Wrap or create one or more USD Cone prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the cones.

  • heights – Optional heights for the cones.

  • axes – Optional cone-axis tokens.

  • colors – Optional display colors for the cones.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_axes#

Get axis tokens for the selected cones.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_heights#

Get heights for the selected cones.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected cones.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_axes#

Set axis tokens on the selected cones.

set_display_colors#

Set display colors on the selected shapes.

set_heights#

Set heights on the selected cones.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_radii#

Set radii on the selected cones.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

class isaacsim.foundation.objects.Cube(
self,
paths: str | collections.abc.Sequence[str],
*,
sizes: warp.array | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Shape

Wrap or create one or more USD Cube prims.

Parameters:
  • paths – A prim path or list of paths.

  • sizes – Optional edge lengths for the cubes.

  • colors – Optional display colors for the cubes.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_sizes#

Get edge lengths for the selected cubes.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_display_colors#

Set display colors on the selected shapes.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_sizes#

Set edge lengths on the selected cubes.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

class isaacsim.foundation.objects.Cylinder(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
heights: warp.array | None = None,
axes: str | collections.abc.Sequence[str] | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Shape

Wrap or create one or more USD Cylinder prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the cylinders.

  • heights – Optional heights for the cylinders.

  • axes – Optional cylinder-axis tokens.

  • colors – Optional display colors for the cylinders.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_axes#

Get axis tokens for the selected cylinders.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_heights#

Get heights for the selected cylinders.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected cylinders.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_axes#

Set axis tokens on the selected cylinders.

set_display_colors#

Set display colors on the selected shapes.

set_heights#

Set heights on the selected cylinders.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_radii#

Set radii on the selected cylinders.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

class isaacsim.foundation.objects.Plane(
self,
paths: str | collections.abc.Sequence[str],
*,
widths: warp.array | None = None,
lengths: warp.array | None = None,
axes: str | collections.abc.Sequence[str] | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Shape

Wrap or create one or more USD Plane prims.

Parameters:
  • paths – A prim path or list of paths.

  • widths – Optional widths for the planes.

  • lengths – Optional lengths for the planes.

  • axes – Optional plane-normal axis tokens.

  • colors – Optional display colors for the planes.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_axes#

Get normal-axis tokens for the selected planes.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_lengths#

Get lengths for the selected planes.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_widths#

Get widths for the selected planes.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_axes#

Set normal-axis tokens on the selected planes.

set_display_colors#

Set display colors on the selected shapes.

set_lengths#

Set lengths on the selected planes.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_widths#

Set widths on the selected planes.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

class isaacsim.foundation.objects.Shape#

Bases: Xform

Base wrapper for batched geometric-shape prims.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_display_colors#

Set display colors on the selected shapes.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

class isaacsim.foundation.objects.Sphere(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
colors: str | collections.abc.Sequence[str] | warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Shape

Wrap or create one or more USD Sphere prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the spheres.

  • colors – Optional display colors for the spheres.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_display_colors#

Get display colors for the selected shapes.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected spheres.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_display_colors#

Set display colors on the selected shapes.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_radii#

Set radii on the selected spheres.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

update_extents#

Recompute the authored extents of all wrapped shapes.

Lights#

class isaacsim.foundation.objects.CylinderLight(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
lengths: warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Light

Wrap or create one or more USD CylinderLight prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the lights.

  • lengths – Optional lengths for the lights.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_enabled_treat_as_lines#

Get line-light treatment states for the selected cylinder lights.

get_exposures#

Get exposure values for the selected lights.

get_intensities#

Get intensities for the selected lights.

get_lengths#

Get lengths for the selected cylinder lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected cylinder lights.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_enabled_treat_as_lines#

Enable or disable line-light treatment on the selected cylinder lights.

set_exposures#

Set exposure values on the selected lights.

set_intensities#

Set intensities on the selected lights.

set_lengths#

Set lengths on the selected cylinder lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_radii#

Set radii on the selected cylinder lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

class isaacsim.foundation.objects.DiskLight(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Light

Wrap or create one or more USD DiskLight prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the lights.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_exposures#

Get exposure values for the selected lights.

get_intensities#

Get intensities for the selected lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected disk lights.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_exposures#

Set exposure values on the selected lights.

set_intensities#

Set intensities on the selected lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_radii#

Set radii on the selected disk lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

class isaacsim.foundation.objects.DistantLight(
self,
paths: str | collections.abc.Sequence[str],
*,
angles: warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Light

Wrap or create one or more USD DistantLight prims.

Parameters:
  • paths – A prim path or list of paths.

  • angles – Optional angular sizes for the lights.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_angles#

Get angular sizes for the selected distant lights.

get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_exposures#

Get exposure values for the selected lights.

get_intensities#

Get intensities for the selected lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_angles#

Set angular sizes on the selected distant lights.

set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_exposures#

Set exposure values on the selected lights.

set_intensities#

Set intensities on the selected lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

class isaacsim.foundation.objects.DomeLight(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
texture_files: str | collections.abc.Sequence[str] | None = None,
texture_formats: str | collections.abc.Sequence[str] | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Light

Wrap or create one or more USD DomeLight prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional guide radii for the lights.

  • texture_files – Optional environment-texture asset paths.

  • texture_formats – Optional texture-coordinate format tokens.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_exposures#

Get exposure values for the selected lights.

get_guide_radii#

Get guide radii for the selected dome lights.

get_intensities#

Get intensities for the selected lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_texture_files#

Get environment-texture asset paths for the selected dome lights.

get_texture_formats#

Get texture-coordinate formats for the selected dome lights.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_exposures#

Set exposure values on the selected lights.

set_guide_radii#

Set guide radii on the selected dome lights.

set_intensities#

Set intensities on the selected lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_texture_files#

Set environment-texture asset paths on the selected dome lights.

set_texture_formats#

Set texture-coordinate formats on the selected dome lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

class isaacsim.foundation.objects.Light#

Bases: Xform

Base wrapper for batched USD light prims.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_exposures#

Get exposure values for the selected lights.

get_intensities#

Get intensities for the selected lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_exposures#

Set exposure values on the selected lights.

set_intensities#

Set intensities on the selected lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

class isaacsim.foundation.objects.RectLight(
self,
paths: str | collections.abc.Sequence[str],
*,
widths: warp.array | None = None,
heights: warp.array | None = None,
texture_files: str | collections.abc.Sequence[str] | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Light

Wrap or create one or more USD RectLight prims.

Parameters:
  • paths – A prim path or list of paths.

  • widths – Optional widths for the lights.

  • heights – Optional heights for the lights.

  • texture_files – Optional emission-texture asset paths.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_exposures#

Get exposure values for the selected lights.

get_heights#

Get heights for the selected rectangular lights.

get_intensities#

Get intensities for the selected lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_stage#

Get the active stage wrapper.

get_texture_files#

Get emission-texture asset paths for the selected lights.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_widths#

Get widths for the selected rectangular lights.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_exposures#

Set exposure values on the selected lights.

set_heights#

Set heights on the selected rectangular lights.

set_intensities#

Set intensities on the selected lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_texture_files#

Set emission-texture asset paths on the selected lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_widths#

Set widths on the selected rectangular lights.

set_world_poses#

Set world positions and/or orientations.

class isaacsim.foundation.objects.SphereLight(
self,
paths: str | collections.abc.Sequence[str],
*,
radii: warp.array | None = None,
reset_xform_op_properties: bool = True,
)#

Bases: Light

Wrap or create one or more USD SphereLight prims.

Parameters:
  • paths – A prim path or list of paths.

  • radii – Optional radii for the lights.

  • reset_xform_op_properties – Whether to normalize each prim’s transform operation stack.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_color_temperatures#

Get color temperatures for the selected lights.

get_colors#

Get emitted colors for the selected lights.

get_enabled_color_temperatures#

Get color-temperature enable states for the selected lights.

get_enabled_normalizations#

Get intensity-normalization states for the selected lights.

get_enabled_treat_as_points#

Get point-light treatment states for the selected sphere lights.

get_exposures#

Get exposure values for the selected lights.

get_intensities#

Get intensities for the selected lights.

get_local_poses#

Get local translations and orientations for the selected prims.

get_local_scales#

Get local scales for the selected prims.

get_multipliers#

Get diffuse and specular multipliers for the selected lights.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_radii#

Get radii for the selected sphere lights.

get_stage#

Get the active stage wrapper.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_visibilities#

Get visibility flags for the selected prims.

get_world_poses#

Get world positions and orientations for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

reset_xform_op_properties#

Normalize the wrapped prims’ transform operation stacks.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_color_temperatures#

Set color temperatures on the selected lights.

set_colors#

Set emitted colors on the selected lights.

set_enabled_color_temperatures#

Enable or disable color-temperature control on the selected lights.

set_enabled_normalizations#

Enable or disable intensity normalization on the selected lights.

set_enabled_treat_as_points#

Enable or disable point-light treatment on the selected sphere lights.

set_exposures#

Set exposure values on the selected lights.

set_intensities#

Set intensities on the selected lights.

set_local_poses#

Set local translations and/or orientations.

set_local_scales#

Set local scales on the selected prims.

set_multipliers#

Set diffuse and/or specular multipliers on the selected lights.

set_radii#

Set radii on the selected sphere lights.

set_variant_selection#

Set variant selections on the selected prims.

set_visibilities#

Set visibility flags on the selected prims.

set_world_poses#

Set world positions and/or orientations.

Physics scenes#

class isaacsim.foundation.objects.PhysicsScene(self, paths: str | collections.abc.Sequence[str])#

Bases: Prim

Wrap or create one or more solver-agnostic USD PhysicsScene prims.

Parameters:

paths – A prim path or list of paths, optionally containing regular expressions.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_dts#

Get simulation delta times for the selected physics scenes.

get_enabled_gravities#

Get gravity-enable states for the selected physics scenes.

get_gravities#

Get gravity vectors for the selected physics scenes.

get_max_solver_iterations#

Get maximum solver iterations for the selected physics scenes.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_physics_scene_paths = <nanobind.nb_func object>#
get_stage#

Get the active stage wrapper.

get_time_steps_per_seconds#

Get simulation step frequencies for the selected physics scenes.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_dts#

Set simulation delta times on the selected physics scenes.

set_enabled_gravities#

Enable or disable gravity on the selected physics scenes.

set_gravities#

Set gravity vectors on the selected physics scenes.

set_max_solver_iterations#

Set maximum solver iterations on the selected physics scenes.

set_time_steps_per_seconds#

Set simulation step frequencies on the selected physics scenes.

set_variant_selection#

Set variant selections on the selected prims.

class isaacsim.foundation.objects.PhysxScene(self, paths: str | collections.abc.Sequence[str])#

Bases: PhysicsScene

Wrap or create one or more USD PhysicsScene prims configured for PhysX.

Parameters:

paths – A prim path or list of paths, optionally containing regular expressions.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_broadphase_types#

Get broadphase-type tokens for the selected scenes.

get_children#

Get the child paths of the selected prims.

get_dts#

Get PhysX delta times for the selected scenes.

get_enabled_ccds#

Get continuous-collision-detection states for the selected scenes.

get_enabled_gpu_dynamics#

Get GPU-dynamics states for the selected scenes.

get_enabled_gravities#

Get gravity-enable states for the selected physics scenes.

get_enabled_stabilizations#

Get solver-stabilization states for the selected scenes.

get_gpu_configuration#

Get all GPU buffer-size fields for the selected scenes.

get_gravities#

Get gravity vectors for the selected physics scenes.

get_max_solver_iterations#

Get maximum solver iterations for the selected physics scenes.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_physics_scene_paths = <nanobind.nb_func object>#
get_solver_types#

Get PhysX solver-type tokens for the selected scenes.

get_stage#

Get the active stage wrapper.

get_time_steps_per_seconds#

Get PhysX step frequencies for the selected scenes.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_broadphase_types#

Set broadphase-type tokens on the selected scenes.

set_dts#

Set PhysX delta times on the selected scenes.

set_enabled_ccds#

Enable or disable continuous collision detection on the selected scenes.

set_enabled_gpu_dynamics#

Enable or disable GPU dynamics on the selected scenes.

set_enabled_gravities#

Enable or disable gravity on the selected physics scenes.

set_enabled_stabilizations#

Enable or disable solver stabilization on the selected scenes.

set_gpu_configuration#

Set provided GPU buffer-size fields on the selected scenes.

set_gravities#

Set gravity vectors on the selected physics scenes.

set_max_solver_iterations#

Set maximum solver iterations on the selected physics scenes.

set_solver_types#

Set PhysX solver-type tokens on the selected scenes.

set_time_steps_per_seconds#

Set PhysX step frequencies on the selected scenes.

set_variant_selection#

Set variant selections on the selected prims.

class isaacsim.foundation.objects.PhysxGpuCfg(
self,
*,
gpu_collision_stack_size: warp.array | None = None,
gpu_found_lost_aggregate_pairs_capacity: warp.array | None = None,
gpu_found_lost_pairs_capacity: warp.array | None = None,
gpu_heap_capacity: warp.array | None = None,
gpu_max_deformable_surface_contacts: warp.array | None = None,
gpu_max_deformable_volume_contacts: warp.array | None = None,
gpu_max_num_partitions: warp.array | None = None,
gpu_max_particle_contacts: warp.array | None = None,
gpu_max_rigid_contact_count: warp.array | None = None,
gpu_max_rigid_patch_count: warp.array | None = None,
gpu_temp_buffer_capacity: warp.array | None = None,
gpu_total_aggregate_pairs_capacity: warp.array | None = None,
)#

Bases: object

Store optional batched GPU buffer sizes for PhysX scenes.

Each provided field is written by PhysxScene.set_gpu_configuration; omitted fields remain unchanged.

Parameters:
  • gpu_collision_stack_size – Optional collision-stack sizes in bytes.

  • gpu_found_lost_aggregate_pairs_capacity – Optional found/lost aggregate-pair capacities.

  • gpu_found_lost_pairs_capacity – Optional found/lost pair capacities.

  • gpu_heap_capacity – Optional heap sizes in bytes.

  • gpu_max_deformable_surface_contacts – Optional deformable-surface contact limits.

  • gpu_max_deformable_volume_contacts – Optional deformable-volume contact limits.

  • gpu_max_num_partitions – Optional solver-partition limits.

  • gpu_max_particle_contacts – Optional particle-contact limits.

  • gpu_max_rigid_contact_count – Optional rigid-body contact limits.

  • gpu_max_rigid_patch_count – Optional rigid-body contact-patch limits.

  • gpu_temp_buffer_capacity – Optional temporary-buffer sizes in bytes.

  • gpu_total_aggregate_pairs_capacity – Optional total aggregate-pair capacities.

property gpu_collision_stack_size#

The GPU collision-stack size in bytes.

property gpu_found_lost_aggregate_pairs_capacity#

The GPU found/lost aggregate-pair capacity.

property gpu_found_lost_pairs_capacity#

The GPU found/lost pair capacity.

property gpu_heap_capacity#

The GPU heap size in bytes.

property gpu_max_deformable_surface_contacts#

The maximum number of GPU deformable-surface contacts.

property gpu_max_deformable_volume_contacts#

The maximum number of GPU deformable-volume contacts.

property gpu_max_num_partitions#

The maximum number of GPU solver partitions.

property gpu_max_particle_contacts#

The maximum number of GPU particle contacts.

property gpu_max_rigid_contact_count#

The maximum number of GPU rigid-body contacts.

property gpu_max_rigid_patch_count#

The maximum number of GPU rigid-body contact patches.

property gpu_temp_buffer_capacity#

The GPU temporary-buffer size in bytes.

property gpu_total_aggregate_pairs_capacity#

The total GPU aggregate-pair capacity.

class isaacsim.foundation.objects.NewtonMjcScene(self, paths: str | collections.abc.Sequence[str])#

Bases: PhysicsScene

Wrap or create one or more USD PhysicsScene prims configured for Newton.

Parameters:

paths – A prim path or list of paths, optionally containing regular expressions.

apply_api#

Apply an API schema to the selected prims.

are_of_type = <nanobind.nb_func object>#
get_applied_schemas#

Get the applied schema names of the selected prims.

get_attribute_values#

Get an attribute value from each selected prim.

get_children#

Get the child paths of the selected prims.

get_cones#

Get Newton friction-cone tokens for the selected scenes.

get_densities#

Get medium densities for the selected scenes.

get_dts#

Get Newton delta times for the selected scenes.

get_enabled_gravities#

Get gravity-enable states for the selected physics scenes.

get_gravities#

Get gravity vectors for the selected physics scenes.

get_impedance_ratios#

Get Newton impedance ratios for the selected scenes.

get_integrators#

Get Newton integrator tokens for the selected scenes.

get_iterations#

Get Newton solver iteration counts for the selected scenes.

get_jacobians#

Get Newton Jacobian-type tokens for the selected scenes.

get_max_solver_iterations#

Get maximum solver iterations for the selected physics scenes.

get_name#

Get the names of the selected prims.

get_parent#

Get the parent paths of the selected prims.

get_physics_scene_paths = <nanobind.nb_func object>#
get_solvers#

Get Newton solver tokens for the selected scenes.

get_stage#

Get the active stage wrapper.

get_time_steps_per_seconds#

Get Newton step frequencies for the selected scenes.

get_tolerances#

Get Newton solver tolerances for the selected scenes.

get_type_name#

Get the USD type names of the selected prims.

get_variant_selection#

Get the current variant selections of the selected prims.

get_variant_sets#

Get the available variants grouped by variant set for the selected prims.

get_viscosities#

Get medium viscosities for the selected scenes.

get_winds#

Get wind velocity vectors for the selected scenes.

has_api#

Check whether the selected prims have an applied API schema.

is_a#

Check whether the selected prims conform to a typed schema.

property paths#

The resolved paths wrapped by this object.

remove_api#

Remove an applied API schema from the selected prims.

resolve_paths = <nanobind.nb_func object>#
set_attribute_values#

Set an attribute value on each selected prim.

set_cones#

Set Newton friction-cone tokens on the selected scenes.

set_densities#

Set medium densities on the selected scenes.

set_dts#

Set Newton delta times on the selected scenes.

set_enabled_gravities#

Enable or disable gravity on the selected physics scenes.

set_gravities#

Set gravity vectors on the selected physics scenes.

set_impedance_ratios#

Set Newton impedance ratios on the selected scenes.

set_integrators#

Set Newton integrator tokens on the selected scenes.

set_iterations#

Set Newton solver iteration counts on the selected scenes.

set_jacobians#

Set Newton Jacobian-type tokens on the selected scenes.

set_max_solver_iterations#

Set maximum solver iterations on the selected physics scenes.

set_solvers#

Set Newton solver tokens on the selected scenes.

set_time_steps_per_seconds#

Set Newton step frequencies on the selected scenes.

set_tolerances#

Set Newton solver tolerances on the selected scenes.

set_variant_selection#

Set variant selections on the selected prims.

set_viscosities#

Set medium viscosities on the selected scenes.

set_winds#

Set wind velocity vectors on the selected scenes.