Python API reference#

This reference is generated from the installed library package and its public docstrings.

IsaacVirtualGantry USD schema.

Codeless schema for the virtual gantry: an Xform-derived typed prim whose world transform is the anchor of a one-sided spring-damper rope. Kept out of isaacsim.robot.schema so that schema stays limited to describing robots.

The owning extension loads at order = -100 (the schema tier) so the prim type is registered before anything that depends on it starts. USD builds its concrete prim-type catalog once, at startup: a schema plugin registered later gets a TfType but no prim definition, and the type then fails IsA(Xformable) with no error reported.

class isaacsim.robot_setup.virtual_gantry_schema.Attributes(
value,
names=<not given>,
*values,
module=None,
qualname=None,
type=None,
start=1,
boundary=None,
)#

Bases: Enum

isaac:gantry:* attributes of an IsaacVirtualGantry prim.

GANTRY_BODY_OFFSET = ('isaac:gantry:bodyOffset', 'Body Offset', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry body-local attach offset attribute with float3 value type.

GANTRY_DAMPING = ('isaac:gantry:damping', 'Damping', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry damping (kd) attribute with float value type.

GANTRY_EMA_ALPHA = ('isaac:gantry:emaAlpha', 'EMA Alpha', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry EMA smoothing factor attribute with float value type.

GANTRY_ENABLED = ('isaac:gantry:enabled', 'Enabled', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry enabled attribute with boolean value type.

GANTRY_MIN_ROPE_LENGTH = ('isaac:gantry:minRopeLength', 'Min Rope Length', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry minimum rope length attribute with float value type.

GANTRY_ROPE_LENGTH = ('isaac:gantry:ropeLength', 'Rope Length', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry slack rope length attribute with float value type.

GANTRY_STATUS = ('isaac:gantry:status', 'Status', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry runtime status attribute with token value type.

GANTRY_STIFFNESS = ('isaac:gantry:stiffness', 'Stiffness', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry spring stiffness (kp) attribute with float value type.

GANTRY_VISUALIZE = ('isaac:gantry:visualize', 'Visualize', <pxr.Sdf.ValueTypeName object>)#

Virtual gantry visualize attribute with boolean value type.

property display_name: str#

The attribute’s display name.

property name: str#

The attribute’s USD name.

property type: Any#

The attribute’s USD value type.

class isaacsim.robot_setup.virtual_gantry_schema.Classes(
value,
names=<not given>,
*values,
module=None,
qualname=None,
type=None,
start=1,
boundary=None,
)#

Bases: Enum

Schema classes provided by this extension.

VIRTUAL_GANTRY = 'IsaacVirtualGantry'#

Token for the IsaacVirtualGantry schema class.

class isaacsim.robot_setup.virtual_gantry_schema.Relations(
value,
names=<not given>,
*values,
module=None,
qualname=None,
type=None,
start=1,
boundary=None,
)#

Bases: Enum

Relationships of an IsaacVirtualGantry prim.

GANTRY_ARTICULATION = ('isaac:gantry:articulation', 'Articulation')#

Relationship token for the articulation-root prim a virtual gantry suspends.

GANTRY_ATTACH_BODY = ('isaac:gantry:attachBody', 'Attach Body')#

Relationship token for the articulation link a virtual gantry pulls on.

property display_name: str#

The relationship’s display name.

property name: str#

The relationship’s USD name.

isaacsim.robot_setup.virtual_gantry_schema.CreateVirtualGantry(
stage: Stage,
prim_path: str,
) → Prim#

Create a Virtual Gantry prim with its attributes and relationships.

The prim is Xform-derived: its world transform is the rope anchor.

Parameters:
  • stage – The USD stage to create the prim in.

  • prim_path – The path where to create the prim.

Returns:

The created Virtual Gantry prim.

Example:

gantry_prim = CreateVirtualGantry(stage, "/World/VirtualGantry")
isaacsim.robot_setup.virtual_gantry_schema.get_allowed_tokens(
attribute: Attributes,
) → tuple#

Return the allowedTokens list for a schema attribute.

Reads the list from the bundled VirtualGantrySchema.usda so the Python-side tuple stays in sync with the authored schema.

Parameters:

attribute – The attribute to query (only Token-typed attributes define allowed tokens).

Returns:

Tuple of allowed token strings, or an empty tuple when the attribute has no allowedTokens metadata.