Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/large-carpets-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@playcanvas/react": patch
---

Adds a deprecation warning to OrbitControls
4 changes: 3 additions & 1 deletion packages/lib/src/components/Script.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ interface ScriptProps {
[key: string]: unknown;
}

class NullScript extends PcScript {}
class NullScript extends PcScript {
static scriptName = 'null-script';
}

const componentDefinition = {
name: "Script",
Expand Down
3 changes: 3 additions & 0 deletions packages/lib/src/scripts/orbit-controls/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Entity, Vec3 } from "playcanvas";
import { Script } from "../../components/Script.tsx";
import { OrbitCamera, OrbitCameraInputMouse, OrbitCameraInputTouch } from "./orbit-camera.js";
import { warnOnce } from "../../utils/validation.ts";

type OrbitCameraProps = {
distanceMax?: number
Expand Down Expand Up @@ -29,6 +30,8 @@ export const OrbitControls = ({
mouse = { orbitSensitivity: 0.3, distanceSensitivity: 0.15 },
touch = { orbitSensitivity: 0.4, distanceSensitivity: 0.2 },
} : OrbitControls) => {

warnOnce('The `<OrbitControls/>` component is deprecated and will be removed in a future release. Use the PlayCanvas `CameraControls` script from `playcanvas` via the `<Script/>` component instead: `<Script script={CameraControls}/>`.');

const orbitCameraProps : OrbitCameraProps = { distanceMax, distanceMin, pitchAngleMax, pitchAngleMin, inertiaFactor, focusEntity, pivotPoint, frameOnStart, distance }

Expand Down
Loading