<!--
{
  "documentType" : "article",
  "framework" : "USD",
  "identifier" : "/documentation/USD/orbitaction",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "OrbitAction"
}
-->

# OrbitAction

An action that orbits a set of prims around another.

## Discussion

This action sends the list of prims defined by [affectedObjects](/documentation/USD/affectedobjects) into orbit at a fixed distance around its [center](/documentation/USD/center) prim, on a plane perpendicular to the axis of rotation. The runtime caculates the fixed distance as a straight line between the respective origins of the [affectedObjects](/documentation/USD/affectedobjects) and the [center](/documentation/USD/center).

### Declaration

```other
class Preliminary_Action "OrbitAction"
```

## Topics

### Properties

[info:id](/documentation/USD/info-id)

The action’s unique identifier.

[affectedObjects](/documentation/USD/affectedobjects)

A list of prims that respond to the notification.

[center](/documentation/USD/center)

A prim around which the affected objects orbit.

[duration](/documentation/USD/duration)

The amount of time that the objects face the camera.

[revolutions](/documentation/USD/revolutions)

The number of rotations to complete.

[axis](/documentation/USD/axis)

A vector that describes the axis of rotation.

[alignToPath](/documentation/USD/aligntopath)

An option that controls the prim’s orientation as it revolves.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)