effect-motion
API Referenceeffect-motionNamespacesCameraVariables

orbitTo

const orbitTo: (azimuth, duration, timing?) => (cam) => CamEffect & (cam, azimuth, duration, timing?) => CamEffect;

Variable: orbitTo

const orbitTo: (azimuth, duration, timing?) => (cam) => CamEffect & (cam, azimuth, duration, timing?) => CamEffect;

Defined in: packages/motion/src/Camera.ts:391

Swing the camera around its point of interest, like a turntable.

Remarks

The camera travels an arc at a fixed radius and height while continuing to face the subject — the standard "orbit the product" move. Only the position is animated; the aim follows from the point of interest, so there is no orientation math to get wrong.

azimuth is an ABSOLUTE angle in radians about the world-Y axis through the point of interest, where 0 is directly in front (+z of it). A full turn is Math.PI * 2; the sign chooses direction.

Requires a point of interest — call lookAt first, or this fails loudly telling you so.

Param

azimuth

Target angle in radians; 0 is directly in front.

Param

duration

How long, in scene time.

Param

timing

An easing name or function.

Default Value

timing — "linear"

Returns

The camera, so animators chain.

See

orbit to start from an explicit angle.

Example

A quarter turn around a subject.

yield* camera.pipe(
	Camera.lookAt(subject),
	Camera.orbitTo(Math.PI / 2, "2 seconds", "easeInOutCubic"),
);

On this page