Python Bindings API

pybind11 carb.physx.camera bindings

class omni.physxcamera.bindings._physxCamera.IPhysxCamera
add_drone_camera(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera, subjectPath: str, cameraPath: str) → bool

Create a drone camera that follows the subject specified by the USD path.

Parameters

  • subjectPath – Camera USD path.

  • cameraPath – USD path for camera to add.

Returns

True if successful, else False (for example, cameraPath pointing to existing prim).

Return type

bool

add_follow_look_camera(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera, subjectPath: str, cameraPath: str) → bool

Create a chase camera that follows the subject specified by the USD path.

Parameters

  • subjectPath – Camera USD path.

  • cameraPath – USD path for camera to add.

Returns

True if successful, else False (for example, cameraPath pointing to existing prim).

Return type

bool

add_follow_velocity_camera(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera, subjectPath: str, cameraPath: str) → bool

Create a chase camera that follows the subject velocity vector specified by the USD path.

Parameters

  • subjectPath – Camera USD path.

  • cameraPath – USD path for camera to add.

Returns

True if successful, else False (for example, cameraPath pointing to existing prim).

Return type

bool

attach_stage(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera, id: int, unregisterFromStageUpdate: bool) → bool

Attach to a USD stage explicitly. This will traverse the prims of the stage and create controllers as needed. This method should only be used if the controllers are going to be updated explicitly (see update()) instead of being tirggered by the default stage update loop.

Note

The currently attached stage will be detached.

Parameters

  • id – USD stageId (can be retrieved from a stage - UsdUtils.StageCache.Get().GetId(stage).ToLongInt())

  • unregisterFromStageUpdate – If true, the extension will not listen to stage update events any longer.

Returns

True if stage was successfully attached.

detach_stage(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera, registerToStageUpdate: bool) → None

Detach from the USD stage. This will remove all camera controller objects.

Parameters

registerToStageUpdate – If true, the detach operation will be followed by a re-attach and the extension will listen to stage update events again.

preUpdate(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera) → None

Explicit pre-update step for cameras tracking both physics and animated cameras when not using the Play feature in Kit or when manually stepping the physics simulation.

process_pending_usd_changes(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera) → None
update(self: omni.physxcamera.bindings._physxCamera.IPhysxCamera, elapsedSeconds: float) → None

Explicit update step for the animated cameras when not using the Play feature in Kit. Cameras that are tracking rigid body objects will get updated by the simulation event callback system.

Parameters

elapsedSeconds – Elapsed time in seconds.

omni.physxcamera.bindings._physxCamera.acquire_physx_camera_interface(plugin_name: str = None, library_path: str = None) → omni.physxcamera.bindings._physxCamera.IPhysxCamera
omni.physxcamera.bindings._physxCamera.release_physx_camera_interface(arg0: omni.physxcamera.bindings._physxCamera.IPhysxCamera) → None
omni.physxcamera.bindings._physxCamera.release_physx_camera_interface_scripting(arg0: omni.physxcamera.bindings._physxCamera.IPhysxCamera) → None