Python API reference#
This reference is generated from the installed library package and its public docstrings.
- class isaacsim.core.experimental.prims.GeomPrim(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- apply_collision_apis: bool = False,
- reset_xform_op_properties: bool = False,
- **kwargs: Any,
Bases:
ColliderBodyDeprecated collider wrapper with non-destructive construction semantics.
Quaternions are ordered
wxyzon every pose method, as the deprecated experimental wrapper documented, rather than thexyzwofisaacsim.foundation.objects.Xform.All other behavior, including
isaacsim.foundation.prims.ColliderBody.get_enabled_collisions(), is inherited fromisaacsim.foundation.prims.ColliderBody.- Parameters:
paths – Prim path or paths to wrap.
apply_collision_apis – Whether to apply collision APIs during construction.
reset_xform_op_properties – Whether to replace existing transform operations with the standard operation set.
**kwargs – Additional keyword arguments accepted by
isaacsim.foundation.prims.ColliderBody.
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.prims.Prim(
- self,
- paths: str | collections.abc.Sequence[str],
- *,
- resolve_paths: bool = True,
Bases:
objectWrap 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.
- class isaacsim.core.experimental.prims.XformPrim(
- paths: Any,
- *,
- positions: Any = None,
- translations: Any = None,
- orientations: Any = None,
- scales: Any = None,
- resolve_paths: bool = True,
- reset_xform_op_properties: bool = False,
Bases:
XformDeprecated transform wrapper with non-destructive construction semantics.
Quaternions are ordered
wxyzon every pose method, as the deprecated experimental wrapper documented, rather than thexyzwofisaacsim.foundation.objects.Xform.- Parameters:
paths – Prim path or paths to wrap.
resolve_paths – Whether to resolve path expressions.
positions – Positions in the world frame. Mutually exclusive with
translations.translations – Translations in the local frame. Mutually exclusive with
positions.orientations – Orientations in the world frame (shape
(N, 4), quaternionwxyz).scales – Scales to apply to the prims.
reset_xform_op_properties – Whether to replace existing transform operations with the standard operation set.
- Raises:
ValueError – If both
positionsandtranslationsare specified.
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.