Python Bindings API

class omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity

This interface is the access PhysX ZeroGravity specific features

cancel_move_rotate_scale(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, path: str) → bool

Cancels any outstanding move/rotate/scale operations on the object specified

Parameters

path – Name of object to be have move/rotate/scale operations canceled

clear_all_markers(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None

Clear all zero gravity markers on a current stage

enable_local_precooking(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, enabled: bool) → None

Enable or disable the local precooking in the scene

force_all_changes_to_be_flushed(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None

Blocking version of synchronizePlacementMode that will ensure all changes are flushed before returning

force_solid_angle_camera_prims_evaluation_now(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None

Force a geo-priority evaluation of the prims most likely to be clicked by the user (in camera view). Synchronous.

get_elapsed_time(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → float
get_event_stream(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → carb.events._events.IEventStream

Event stream sending various events defined in ZeroGravityEvent enum.

Returns

Event stream sending the events.

get_solid_angle_camera_prim_path_at_pos(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, pos: int) → str

Access the pos-th SDF prim path in the evaluated buffer. First one has a higher priority.

get_solid_angle_camera_prims_num(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → int

Get the number of solid angle prims evaluated.

has_physx_actor(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, path: str) → bool

Returns true if the primitive path provided is associated with a PhysX SDK actor

Parameters

path – Path of the primitive to test

has_transform_changes(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → bool

Returns true if there have been transform changes since the last time the undo stack was captured

is_applying_properties(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → bool
is_raycast_dragging(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → bool

Returns true if raycast dragging operation is currently running.

mark_prim(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, prim_path: str, markType: str) → bool

Marks prim with physics state

mark_selection(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, markType: str, contextMenuPrimPath: str) → int

Marks currently selected prims using this markup type

move(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, path: str, delta_translation: carb._carb.Float3, start: bool, lock_rotation: bool) → bool

Attempts to move a physics object to a new relative position

Parameters

  • path – Name of object to be moved

  • delta_translation – Float3 of the delta to move X/Y/Z

  • start – Indicates first update of move operation.

  • lock_rotation – Whether rotation should be locked during move

notify_gizmo_state(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, isactive: bool) → None

Informs the placement mode of the current gizmo state, active or inactive and toggles dropping mode behavior accordingly

placement_simulate(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None
redo_capture_transform_changes(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, arg0: int) → None
rotate(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, path: str, pivot_path: str, delta_rotation: carb._carb.Float4, start: bool) → bool

Attempts to rotate a physics object by a delta as a quaternion, optionally relative to a pivot actor

Parameters

  • path – Name of object to be rotated

  • pivot_path – Path of object the rotation is relative to

  • delta_rotation – Delta rotation as a quaternion X/Y/Z/W

  • start – Indicates first update of rotate operation.

scale(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, path: str, pivot_path: str, delta_scale: carb._carb.Float3, start: bool, lock_rotation: bool) → bool

Attempts to move a physics object by scaling the distance to a pivot actor

Parameters

  • path – Name of object whose distance to the pivot object is scaled

  • pivot_path – Path of object the scaling is relative to - if equal to path, marked as kinematic

  • delta_scale – Delta scale as vector X/Y/Z

  • start – Indicates first update of scaling operation.

  • lock_rotation – Whether rotation should be locked during scale

set_dropping_on_prim(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, isDropping: bool, primPath: str) → int

Sets the dropping mode on a rigid body at the specified prim path

set_dropping_on_selected(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, isDropping: bool) → int

Sets the dropping mode on currently selected rigid bodies

set_model_mode(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, arg0: bool) → None
set_physics_authoring_mode(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, state: bool, layerName: str) → None

Sets the physics authoring mode. When enabled this runs the custom collision filtering logic to prevent objects from exploding when they are intersecting in their rest state

Parameters

  • state – Enable or disable the custom physics authoring code

  • layerName – Anonymous layer where zerog will operate with its placement mode

set_sweep_mode(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, sweepActive: bool) → None

Enables or disables sweep mode which marks nearby objects automatically

set_swept_items_dynamic(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, useDynamicMarkersForSweptItems: bool) → None

Sets whether sweep mode marks nearby objects as dynamic. If not, swept objects are marked as static.

should_show_gizmo(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, arg0: int) → bool
start_capture_transform_changes(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → int
sweep_area_visualize(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, visualizeAABB: bool) → None

Show or hide a sweep area bounding box visualization.

synchronize_placement_mode(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None

Synchronizes the current USD stage for any possible changes which need to be reflected by physics placement mode

undo_capture_transform_changes(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity, arg0: int) → None
wait_for_simulation_step_completed(self: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None

Blocks until this simulation step is completed. Call this before reading out simulation statistics (e.g. in unit tests) otherwise you’ll read garbage data still in simulation and get errors.

class omni.physxzerogravity.bindings._physXZeroGravity.ZeroGravityEventType

ZeroGravity events used by event stream.

Members:

REFRESH_GIZMO : When omni.kit.manipulator.selector needs refresh; contains nothing in the dictionary.

REFRESH_GIZMO = <ZeroGravityEventType.REFRESH_GIZMO: 0>
property name
property value
omni.physxzerogravity.bindings._physXZeroGravity.acquire_physx_zero_gravity_interface(plugin_name: str = None, library_path: str = None) → omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity
omni.physxzerogravity.bindings._physXZeroGravity.release_physx_zero_gravity_interface(arg0: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None
omni.physxzerogravity.bindings._physXZeroGravity.release_physx_zero_gravity_interface_scripting(arg0: omni.physxzerogravity.bindings._physXZeroGravity.PhysxZeroGravity) → None