Python API reference#
This reference is generated from the installed library package and its public docstrings.
- class isaacsim.core.experimental.objects.Camera(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
CameraDeprecated camera wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Capsule(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
CapsuleDeprecated capsule wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Cone(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
ConeDeprecated cone wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Cube(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
CubeDeprecated cube wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Cylinder(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
CylinderDeprecated cylinder wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.CylinderLight(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
CylinderLightDeprecated cylinder light wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.DiskLight(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
DiskLightDeprecated disk light wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.DistantLight(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
DistantLightDeprecated distant light wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.DomeLight(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
DomeLightDeprecated dome light wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.GroundPlane(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
GroundPlaneDeprecated ground plane wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Light(
- *args,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
LightDeprecated light base wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Mesh(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
MeshDeprecated mesh wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Plane(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
PlaneDeprecated plane wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.RectLight(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
RectLightDeprecated rect light wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Shape(
- *args,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
ShapeDeprecated shape base wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Sphere(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
SphereDeprecated sphere wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(*, indices: Any = None) Any
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(*, indices: Any = None) Any
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.SphereLight(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- **kwargs: Any,
Bases:
SphereLightDeprecated sphere light wrapper whose pose methods order quaternions
wxyz.Wrap the prims and place them.
- Parameters:
paths – Prim path or paths to wrap.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
**kwargs – Arguments accepted by the wrapped class.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
- get_local_poses(
- *,
- indices: Any = None,
Get the local-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The translations (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- get_world_poses(
- *,
- indices: Any = None,
Get the world-frame poses.
- Parameters:
indices – Indices of the prims to process. If
None, all wrapped prims are processed.- Returns:
The positions (shape
(N, 3)) and the orientations (shape(N, 4), quaternionwxyz).
- set_local_poses(
- translations: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the local-frame poses.
- Parameters:
translations – Translations in the local frame (shape
(N, 3)).orientations – Orientations in the local frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- set_world_poses(
- positions: Any = None,
- orientations: Any = None,
- *,
- indices: Any = None,
Set the world-frame poses.
- Parameters:
positions – Positions in the world frame (shape
(N, 3)).orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).indices – Indices of the prims to process. If
None, all wrapped prims are processed.
- class isaacsim.core.experimental.objects.Stage(self, backend: str, stage_id: int | None = None)
Bases:
objectWrap 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
Nonefor 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.