Skip to content

feat(controller): add dead zone threshold for left and right joysticks #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(controller): add dead zone threshold for left and right joysticks #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec36964
feat: add props to invert camera on X and Y axes
Ki2lian Nov 27, 2024
0d426e2
Merge pull request #1 from Ki2lian/feature/invert-camera-axis
Ki2lian Nov 27, 2024
d334c29
feat: add deadzone threshold for joysticks
Ki2lian Nov 27, 2024
880ec2d
Merge branch 'main' into feature/joystick-deadzone-threshold
Ki2lian Nov 27, 2024
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
26 changes: 22 additions & 4 deletions src/Ecctrl.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ const Ecctrl: ForwardRefRenderFunction<CustomEcctrlRigidBody, EcctrlProps> = ({
camTargetPos = { x: 0, y: 0, z: 0 },
camMoveSpeed = 1,
camZoomSpeed = 1,
camInvertX = false,
camInvertY = false,
leftJoystickDeadZoneThreshold = 0,
rightJoystickDeadZoneThreshold = 0,
camCollision = true,
camCollisionOffset = 0.7,
camCollisionSpeedMult = 4,
Expand Down Expand Up @@ -511,10 +515,16 @@ const Ecctrl: ForwardRefRenderFunction<CustomEcctrlRigidBody, EcctrlProps> = ({
}
}

const applyDeadZone = (value: number, threshold: number) => {
return Math.abs(value) > threshold ? value : 0;
}

const handleSticks = (axes: readonly number[]) => {
const adjustedLeftStickX = applyDeadZone(axes[0], leftJoystickDeadZoneThreshold);
const adjustedLeftStickY = applyDeadZone(axes[1], leftJoystickDeadZoneThreshold);
// Gamepad first joystick trigger the EcctrlJoystick event to move the character
if (Math.abs(axes[0]) > 0 || Math.abs(axes[1]) > 0) {
gamepadJoystickVec2.set(axes[0], -axes[1])
if (Math.abs(adjustedLeftStickX) > 0 || Math.abs(adjustedLeftStickY) > 0) {
gamepadJoystickVec2.set(adjustedLeftStickX, -adjustedLeftStickY)
gamepadJoystickDis = Math.min(Math.sqrt(Math.pow(gamepadJoystickVec2.x, 2) + Math.pow(gamepadJoystickVec2.y, 2)), 1)
gamepadJoystickAng = gamepadJoystickVec2.angle()
const runState = gamepadJoystickDis > 0.7
Expand All @@ -524,9 +534,11 @@ const Ecctrl: ForwardRefRenderFunction<CustomEcctrlRigidBody, EcctrlProps> = ({
gamepadJoystickAng = 0
resetJoystick()
}
const adjustedRightStickX = applyDeadZone(axes[2], rightJoystickDeadZoneThreshold);
const adjustedRightStickY = applyDeadZone(axes[3], rightJoystickDeadZoneThreshold);
// Gamepad second joystick trigger the useFollowCam event to move the camera
if (Math.abs(axes[2]) > 0 || Math.abs(axes[3]) > 0) {
joystickCamMove(axes[2], axes[3])
if (Math.abs(adjustedRightStickX) > 0 || Math.abs(adjustedRightStickY) > 0) {
joystickCamMove(adjustedRightStickX, adjustedRightStickY);
}
}

Expand Down Expand Up @@ -569,6 +581,8 @@ const Ecctrl: ForwardRefRenderFunction<CustomEcctrlRigidBody, EcctrlProps> = ({
camCollisionOffset,
camCollisionSpeedMult,
camListenerTarget,
camInvertX,
camInvertY
};

/**
Expand Down Expand Up @@ -1566,6 +1580,10 @@ export interface EcctrlProps extends RigidBodyProps {
camTargetPos?: { x: number, y: number, z: number };
camMoveSpeed?: number;
camZoomSpeed?: number;
camInvertX?: boolean,
camInvertY?: boolean,
leftJoystickDeadZoneThreshold?: number;
rightJoystickDeadZoneThreshold?: number;
camCollision?: boolean;
camCollisionOffset?: number;
camCollisionSpeedMult?: number;
Expand Down
24 changes: 18 additions & 6 deletions src/hooks/useFollowCam.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ export const useFollowCam = function ({
camInitDir = { x: 0, y: 0 }, // in rad
camMoveSpeed = 1,
camZoomSpeed = 1,
camInvertX = false,
camInvertY = false,
camCollisionOffset = 0.7, // percentage
camCollisionSpeedMult = 4,
camListenerTarget = "domElement",
Expand All @@ -24,6 +26,14 @@ export const useFollowCam = function ({
const { scene, camera, gl } = useThree();
// const { rapier, world } = useRapier();

const camInvertXRef = useRef(camInvertX ? -1 : 1);
const camInvertYRef = useRef(camInvertY ? -1 : 1);

useEffect(() => {
camInvertXRef.current = camInvertX ? -1 : 1;
camInvertYRef.current = camInvertY ? -1 : 1;
}, [camInvertX, camInvertY]);

let isMouseDown = false;
let previousTouch1: Touch = null;
let previousTouch2: Touch = null;
Expand Down Expand Up @@ -64,8 +74,8 @@ export const useFollowCam = function ({
// Mouse move event
const onDocumentMouseMove = (e: MouseEvent) => {
if (document.pointerLockElement || isMouseDown) {
pivot.rotation.y -= e.movementX * 0.002 * camMoveSpeed;
const vy = followCam.rotation.x + e.movementY * 0.002 * camMoveSpeed;
pivot.rotation.y -= e.movementX * 0.002 * camMoveSpeed * camInvertXRef.current;
const vy = followCam.rotation.x + (e.movementY * camInvertYRef.current) * 0.002 * camMoveSpeed;

cameraDistance = followCam.position.length();

Expand Down Expand Up @@ -114,8 +124,8 @@ export const useFollowCam = function ({
const touch1MovementX = touch1.pageX - previousTouch1.pageX;
const touch1MovementY = touch1.pageY - previousTouch1.pageY;

pivot.rotation.y -= touch1MovementX * 0.005 * camMoveSpeed;
const vy = followCam.rotation.x + touch1MovementY * 0.005 * camMoveSpeed;
pivot.rotation.y -= touch1MovementX * 0.005 * camMoveSpeed * camInvertXRef.current;
const vy = followCam.rotation.x + (touch1MovementY * camInvertYRef.current) * 0.005 * camMoveSpeed;

cameraDistance = followCam.position.length();

Expand Down Expand Up @@ -155,8 +165,8 @@ export const useFollowCam = function ({
* Gamepad second joystick event
*/
const joystickCamMove = (movementX: number, movementY: number) => {
pivot.rotation.y -= movementX * 0.005 * camMoveSpeed * 5;
const vy = followCam.rotation.x + movementY * 0.005 * camMoveSpeed * 5;
pivot.rotation.y -= movementX * 0.005 * camMoveSpeed * 5 * camInvertXRef.current;
const vy = followCam.rotation.x + (movementY * camInvertYRef.current) * 0.005 * camMoveSpeed * 5;

cameraDistance = followCam.position.length();

Expand Down Expand Up @@ -327,6 +337,8 @@ export type UseFollowCamProps = {
camInitDir?: { x: number, y: number };
camMoveSpeed?: number;
camZoomSpeed?: number;
camInvertX?: boolean,
camInvertY?: boolean,
camCollisionOffset?: number;
camCollisionSpeedMult?: number;
camListenerTarget?: camListenerTargetType;
Expand Down