All files / components/screens/controls/components Key3D.tsx

82.75% Statements 24/29
81.81% Branches 18/22
87.5% Functions 7/8
84.61% Lines 22/26

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178                                                                                  3x 3531x 3531x     3531x 3531x 3531x     3531x 1649x 1649x 1649x 1649x       3531x     3531x                       3531x 1608x                                               3531x     3531x 1608x 1608x 1608x         3531x                         3531x                                                                                                            
/**
 * Key3D - Individual 3D keyboard key component with press animation
 * 
 * Renders a 3D box mesh for a keyboard key with category-based coloring,
 * press animation, and bilingual label overlay.
 * 
 * @module components/screens/controls/components
 */
 
import { Html } from "@react-three/drei";
import { useFrame } from "@react-three/fiber";
import React, { useEffect, useMemo, useRef } from "react";
import * as THREE from "three";
import { FONT_FAMILY, KOREAN_COLORS } from "../../../../types/constants";
import { hexToRgbaString } from "../../../../utils/colorUtils";
import { getKeyCategoryColor, type KeyData } from "../constants/ControlsConstants";
 
/**
 * Props for Key3D component
 */
export interface Key3DProps {
  /** Key data containing position, label, and category */
  readonly keyData: KeyData;
  /** Whether this key is currently pressed */
  readonly isPressed: boolean;
}
 
/**
 * Key3D Component
 * 
 * Individual 3D keyboard key with press animation and label overlay.
 * Uses category-based coloring and emissive glow when pressed.
 * 
 * @example
 * ```tsx
 * <Key3D
 *   keyData={{ code: 'Space', label: 'Space', row: 4, col: 2, width: 3, category: 'combat' }}
 *   isPressed={pressedKeys.has('Space')}
 * />
 * ```
 */
export const Key3D: React.FC<Key3DProps> = ({ keyData, isPressed }) => {
  const meshRef = useRef<THREE.Mesh>(null);
  const targetScale = useRef(new THREE.Vector3(1, 1, 1));
 
  // Key dimensions
  const keyWidth = (keyData.width ?? 1) * 0.6; // 0.6 units per key width
  const keyHeight = 0.6;
  const keyDepth = 0.2;
 
  // Calculate position based on row and column
  const position = useMemo<[number, number, number]>(() => {
    const x = keyData.col * 0.6 + (keyWidth / 2) - 3.0; // Center around origin
    const y = -keyData.row * 0.6;
    const z = isPressed ? -0.05 : 0; // Press down slightly when pressed
    return [x, y, z];
  }, [keyData.col, keyData.row, keyWidth, isPressed]);
 
  // Get category color
  const categoryColor = useMemo(() => getKeyCategoryColor(keyData.category), [keyData.category]);
 
  // Animate scale when pressed
  useFrame(() => {
    if (!meshRef.current) return;
 
    // Target scale: smaller when pressed
    const targetScaleValue = isPressed ? 0.9 : 1.0;
    targetScale.current.set(targetScaleValue, targetScaleValue, 1.0);
 
    // Smooth interpolation
    meshRef.current.scale.lerp(targetScale.current, 0.2);
  });
 
  // Create materials once (unpressed and pressed states)
  const materials = useMemo(
    () => ({
      unpressed: new THREE.MeshStandardMaterial({
        color: categoryColor,
        emissive: categoryColor,
        emissiveIntensity: 0.3,
        metalness: 0.6,
        roughness: 0.4,
        transparent: true,
        opacity: 0.9,
      }),
      pressed: new THREE.MeshStandardMaterial({
        color: categoryColor,
        emissive: categoryColor,
        emissiveIntensity: 2.5,
        metalness: 0.6,
        roughness: 0.4,
        transparent: true,
        opacity: 0.9,
      }),
    }),
    [categoryColor]
  );
 
  // Select material based on pressed state
  const keyMaterial = isPressed ? materials.pressed : materials.unpressed;
 
  // Dispose materials on unmount
  useEffect(() => {
    return () => {
      materials.unpressed.dispose();
      materials.pressed.dispose();
    };
  }, [materials]);
 
  // Label style for Html overlay
  const labelStyle = useMemo(() => ({
    fontFamily: FONT_FAMILY.KOREAN,
    fontSize: keyData.width && keyData.width > 2 ? '11px' : '13px',
    fontWeight: 'bold' as const,
    color: isPressed ? hexToRgbaString(KOREAN_COLORS.ACCENT_GOLD) : hexToRgbaString(KOREAN_COLORS.TEXT_PRIMARY),
    textAlign: 'center' as const,
    pointerEvents: 'none' as const,
    userSelect: 'none' as const,
    textShadow: isPressed ? `0 0 8px ${hexToRgbaString(categoryColor, 0.8)}` : 'none',
    whiteSpace: 'nowrap' as const,
    lineHeight: 1.2,
  }), [isPressed, categoryColor, keyData.width]);
 
  return (
    <group position={position}>
      {/* 3D key box */}
      <mesh
        ref={meshRef}
        castShadow
        receiveShadow
        name={`key-${keyData.code}`}
        data-testid={`key-${keyData.code}`}
      >
        <boxGeometry args={[keyWidth, keyHeight, keyDepth]} />
        <primitive object={keyMaterial} attach="material" />
      </mesh>
 
      {/* Label overlay */}
      <Html
        position={[0, 0, keyDepth / 2 + 0.01]}
        center
        distanceFactor={2}
        style={{ pointerEvents: 'none' }}
      >
        <div style={labelStyle}>
          {/* Main label */}
          <div>{keyData.label}</div>
          {/* Korean label (if available) */}
          {keyData.labelKorean && (
            <div style={{
              fontSize: '10px',
              color: hexToRgbaString(KOREAN_COLORS.ACCENT_GOLD),
              marginTop: '2px',
            }}>
              {keyData.labelKorean}
            </div>
          )}
        </div>
      </Html>
 
      {/* Glow ring when pressed */}
      {isPressed && (
        <mesh position={[0, 0, -keyDepth / 2 - 0.02]} rotation={[0, 0, 0]}>
          <ringGeometry args={[Math.max(keyWidth, keyHeight) * 0.6, Math.max(keyWidth, keyHeight) * 0.7, 32]} />
          <meshBasicMaterial
            color={categoryColor}
            transparent
            opacity={0.6}
            side={THREE.DoubleSide}
          />
        </mesh>
      )}
    </group>
  );
};
 
export default Key3D;