Interface: OrbitOptions

Defined in: src/placement/Orbit.ts:19

Properties

clearance?

optional clearance: number

Defined in: src/placement/Orbit.ts:39

Minimum gap between captured object bounds in meters. Defaults to 0.

---

direction?

optional direction: OrbitDirection

Defined in: src/placement/Orbit.ts:37

Direction viewed from the positive orbital normal.

---

eccentricity?

optional eccentricity: number

Defined in: src/placement/Orbit.ts:31

Ellipse eccentricity in [0, 1). Defaults to 0.2 for ellipses.

---

frame?

optional frame: OrbitFrame

Defined in: src/placement/Orbit.ts:29

Reference frame for the orbital plane. Defaults to world.

---

inclination?

optional inclination: number

Defined in: src/placement/Orbit.ts:33

Initial orbital-plane tilt in radians. Defaults to 0.

---

path?

optional path: OrbitPath

Defined in: src/placement/Orbit.ts:27

Circular or Kepler-style elliptical motion. Defaults to circular.

---

period?

optional period: number

Defined in: src/placement/Orbit.ts:25

Seconds per orbit. Defaults to 20.

---

precessionPeriod?

optional precessionPeriod: number

Defined in: src/placement/Orbit.ts:35

Seconds per full rotation of the orbital plane.

---

radius?

optional radius: number

Defined in: src/placement/Orbit.ts:23

Semi-major radius in meters. Defaults to 0.5.

---

target

target: Object3D

Defined in: src/placement/Orbit.ts:21

Object at the focus of the orbit.