Merge pull request #52 from Byongho96/master

release
Byongho96 · Jan 16, 2025 · 71824cf · 71824cf
2 parents 1e6493b + f409640
commit 71824cf
Show file tree

Hide file tree

Showing 24 changed files with 672 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -166,8 +166,8 @@ Promise.all( [
   gltfLoader.loadAsync( 'collision-world.glb' ),
   gltfLoader.loadAsync( 'x-bot.glb' ),
   gltfLoader.loadAsync( 'ani-idle.glb' ),
-  gltfLoader.loadAsync( 'run_forward.glb' ),
   gltfLoader.loadAsync( 'ani-forward.glb' ),
+  gltfLoader.loadAsync( 'ani-forward-fast.glb' ),
   gltfLoader.loadAsync( 'ani-jump-up.glb' ),
   gltfLoader.loadAsync( 'ani-land.glb' ),
   gltfLoader.loadAsync( 'ani-fall.glb' )

diff --git a/public/docs/api/core/PhysicsControls.html b/public/docs/api/core/PhysicsControls.html
@@ -55,7 +55,7 @@ <h3>[property:Number landTimeThreshold]</h3>
 
 		<h3>[property:Number landTolerance]</h3>
 		<p>
-			The distance tolerance for landing detection, measured as the vertical distance from the ground surface. Default is `0.2`.
+			The distance tolerance for landing detection, measured as the vertical distance from the ground surface. Default is `0.6`.
 		</p>
 
 		<h3>[property:Number maxFallSpeed]</h3>

diff --git a/public/docs/api/first-person/FPKeyDragControls.html b/public/docs/api/first-person/FPKeyDragControls.html
@@ -33,8 +33,7 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
 
 		<h3>[page:DragMixin DragMixin]</h3>

diff --git a/public/docs/api/first-person/FPKeyPointerLockControls.html b/public/docs/api/first-person/FPKeyPointerLockControls.html
@@ -36,8 +36,7 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
 
 		<h3>[page:PointerLockMixin PointerLockMixin]</h3>

diff --git a/public/docs/api/mixins/GyroMixin.html b/public/docs/api/mixins/GyroMixin.html
@@ -0,0 +1,97 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<base href="../../" />
+		<script src="page.js"></script>
+		<link type="text/css" rel="stylesheet" href="page.css" />
+	</head>
+	<body>
+		<h1>[name]</h1>
+
+		<p class="desc">
+      A mixin that extends `FirstPersonControls` to add device orientation-based controls. This mixin uses device gyroscope data to control actions along the X, Y, and Z axes, enabling motion-based interactions.
+    </p>
+
+    <h2>Constructor</h2>
+
+		<h3>[name]( [param:FirstPersonControls base] )</h3>
+		<p>
+			[page:FirstPersonControls base] — A class that extends `FirstPersonControls`.
+		</p>
+
+    <h2>Properties</h2>
+
+    <h3>[property:Array gyroXActions]</h3>
+    <p>
+			An array of actions triggered by gyroscope movement along the X-axis. Default is `['MOVE_BACKWARD']`.
+    </p>
+
+		<h3>[property:Number gyroXOffset]</h3>
+		<p>
+			Reference value for the gyroscope's X-axis orientation. Default: `0`.
+		</p>
+
+		<h3>[property:Number gyroXMultiplier]</h3>
+		<p>
+			The multiplier for the x-axis orientation. Default: `0.1`.
+		</p>
+
+    <h3>[property:Array gyroYActions]</h3>
+    <p>
+      An array of actions triggered by gyroscope movement along the Y-axis. Default is `['MOVE_RIGHTWARD']`.
+    </p>
+
+		<h3>[property:Number gyroYOffset]</h3>
+		<p>
+			Reference value for the gyroscope's Y-axis orientation. Default: `0`.
+		</p>
+
+		<h3>[property:Number gyroYMultiplier]</h3>
+		<p>
+			The multiplier for the y-axis orientation. Default: `0.1`.
+		</p>
+
+    <h3>[property:Array gyroZActions]</h3>
+    <p>
+			An array of actions triggered by gyroscope movement along the Z-axis. Default is `[]`.
+    </p>
+
+    <h3>[property:Number gyroZOffset]</h3>
+    <p>
+      Reference value for the gyroscope's Z-axis orientation. Default: `0`.
+    </p>
+
+
+		<h3>[property:Number gyroZMultiplier]</h3>
+		<p>
+			The multiplier for the z-axis orientation. Default: `0.1`.
+		</p>
+
+    <h3>[property:Boolean needsResetOrientation]</h3>
+    <p>
+      Determines whether the reference values for orientation (`gyroXOffset`, `gyroYOffset`, `gyroZOffset`) should be reset on the next device orientation event. Default: `true`.
+    </p>
+
+		<h2>Methods</h2>
+
+		<h3>[method:void connect]()</h3>
+		<p>
+			Connects the drag functionality by adding event listeners.
+		</p>
+
+		<h3>[method:void disconnect]()</h3>
+		<p>
+			Disconnects the drag functionality by removing event listeners.
+		</p>
+
+		<h3>[method:void dispose]()</h3>
+		<p>
+			Disposes of the drag functionality by cleaning up event listeners and resources.
+		</p>
+
+		<h2>Source</h2>
+
+		<p>[link:https://github.com/Byongho96/three-game-controls/blob/master/src/mixins/GyroMixin.ts mixins/GyroMixin.ts]</p>
+	</body>
+</html>
diff --git a/public/docs/api/third-person/TPKeyDragControls.html b/public/docs/api/third-person/TPKeyDragControls.html
@@ -48,10 +48,9 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
-
+		
 		<h3>[page:DragMixin DragMixin]</h3>
 
 		<p>

diff --git a/public/docs/api/third-person/TPKeyPointerLockControls.html b/public/docs/api/third-person/TPKeyPointerLockControls.html
@@ -48,8 +48,7 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
 
 		<h3>[page:PointerLockMixin PointerLockMixin]</h3>

diff --git a/public/docs/list.json b/public/docs/list.json
@@ -37,6 +37,7 @@
 
     "Mixins": {
       "DragMixin": "api/mixins/DragMixin",
+      "GyroMixin": "api/mixins/GyroMixin",
       "KeyboardMixin": "api/mixins/KeyboardMixin",
       "PointerLockMixin": "api/mixins/PointerLockMixin"
     }

diff --git a/public/docs/manual/Quick-Start.html b/public/docs/manual/Quick-Start.html
@@ -153,8 +153,8 @@ <h2>ThirdPersonControls</h2>
 			gltfLoader.loadAsync( 'collision-world.glb' ),
 			gltfLoader.loadAsync( 'x-bot.glb' ),
 			gltfLoader.loadAsync( 'ani-idle.glb' ),
-			gltfLoader.loadAsync( 'run_forward.glb' ),
 			gltfLoader.loadAsync( 'ani-forward.glb' ),
+			gltfLoader.loadAsync( 'ani-forward-fast.glb' ),
 			gltfLoader.loadAsync( 'ani-jump-up.glb' ),
 			gltfLoader.loadAsync( 'ani-land.glb' ),
 			gltfLoader.loadAsync( 'ani-fall.glb' )

diff --git a/public/examples/files.json b/public/examples/files.json
@@ -8,6 +8,7 @@
   "ThirdPerson": [
     "third-person_keyboard_controls",
     "third-person_mousedrag_controls",
-    "third-person_pointerlock_controls"
+    "third-person_pointerlock_controls",
+    "third-person_gyroscope_mixins"
   ]
 }
diff --git a/public/examples/first-person_keyboard_controls.html b/public/examples/first-person_keyboard_controls.html
@@ -18,7 +18,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../dist/bundle.esm.js"
 				}
 			}
 		</script>

diff --git a/public/examples/first-person_mousedrag_controls.html b/public/examples/first-person_mousedrag_controls.html
@@ -18,7 +18,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../dist/bundle.esm.js"
 				}
 			}
 		</script>

diff --git a/public/examples/first-person_pointerlock_controls.html b/public/examples/first-person_pointerlock_controls.html
@@ -18,7 +18,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../dist/bundle.esm.js"
 				}
 			}
 		</script>

diff --git a/public/examples/screenshots/third-person_gyroscope_mixins.jpg b/public/examples/screenshots/third-person_gyroscope_mixins.jpg
diff --git a/public/examples/shoot/first-person_pointerlock_shooting.html b/public/examples/shoot/first-person_pointerlock_shooting.html
@@ -5,6 +5,7 @@
 		<meta charset="utf-8" />
 		<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0" />
 		<link type="text/css" rel="stylesheet" href="../main.css" />
+		<link type="text/css" rel="stylesheet" href="./styles.css" />
 	</head>
 	<body>
 		<div id="info">Kill the monsters by clicking on them</div>
@@ -16,7 +17,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../../dist/bundle.esm.js"
 				}
 			}
 		</script>

diff --git a/public/examples/shoot/first-person_pointerlock_shooting_vr.html b/public/examples/shoot/first-person_pointerlock_shooting_vr.html
@@ -5,6 +5,7 @@
 		<meta charset="utf-8" />
 		<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0" />
 		<link type="text/css" rel="stylesheet" href="main.css" />
+		<link type="text/css" rel="stylesheet" href="./styles.css" />
 	</head>
 	<body>
 		<div id="info">Kill the monsters by clicking on them</div>
@@ -16,7 +17,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../../dist/bundle.esm.js"
 				}
 			}
 		</script>

diff --git a/public/examples/shoot/styles.css b/public/examples/shoot/styles.css
@@ -0,0 +1,29 @@
+#cross {
+  position: fixed;
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%);
+  width: 50px;
+  height: 50px;
+  pointer-events: none;
+}
+#cross::before,
+#cross::after {
+  content: '';
+  position: absolute;
+  background-color: rgba(68, 68, 68, 0.61);
+}
+#cross::before {
+  top: 0;
+  left: 50%;
+  transform: translateX(-50%);
+  width: 4px;
+  height: 100%;
+}
+#cross::after {
+  top: 50%;
+  left: 0;
+  transform: translateY(-50%);
+  width: 100%;
+  height: 4px;
+}