Document: Description of RtsCamera - Tiny-Metro/Poly-Metro GitHub Wiki

ARtscamera::ARtsCamera

이 함수는 클래스의 생성자로, 인스턴스가 만들어질 때 한 번만 호출됩니다. 이 생성자에서는 필요한 컴포넌트를 초기화하고 설정합니다.

이 생성자는 ARtsCamera 클래스의 인스턴스를 초기화하는 역할을 합니다. 이 생성자에서는 카메라의 구성 요소들을 생성하고 초기화합니다.

• CustomCollisionComponent: 구체 충돌 컴포넌트를 생성하고 초기화합니다. 이 컴포넌트는 카메라의 충돌 체크와 움직임에 사용됩니다. 여기서 CustomCollisionComponent는 USphereComponent 타입으로 생성되며, "RtsCamera_CollisionComponent0"이라는 이름을 갖습니다. 이 컴포넌트는 카메라가 어떻게 충돌할 것인지 정합니다. 충돌 컴포넌트가 구 형태이고 그 반경은 100 유닛으로 설정되어있습다.
• MovementComponent: 이 컴포넌트는 카메라의 움직임을 제어하는 데 사용됩니다. UFloatingPawnMovement 타입의 Movement Component를 생성하고 초기화 합니다. 이름은 "RtsCameran_MovementComponen0" 입니다.
• RootComponent: 카메라의 루트 컴포넌트로 CustomCollisionComponent 를 설정합니다.

ARtscamera::SetupPlayerInputComponent

이 함수는 입력 컴포넌트에 마우스 휠 입력과 회전 모드 관련 액션을 바인딩합니다.

이 함수는 플레이어의 입력 컴포넌트에 입력 바인딩을 설정하는 역할을 합니다. InputComponent 매개변수를 통해 플레이어의 입력 컴포넌트를 받아온 후, 다양한 입력 축과 액션을 바인딩합니다. 이 함수를 통해 마우스 휠 입력, 카메라 회전 모드 활성화 및 비활성화 액션을 설정합니다.

• BindAxis로 마우스 휠을 줌인 함수에 바인딩 하였고
• BindAction으로 마우스 오른쪽 버튼을 눌렀을 때 함수 EngageRotation으로 회전모드가 활성화되게 하였고 떼었을 DisEngageRotation으로 회전모드가 비활성화되게 만들었습니다.

ARtscamera::Tick

• playerController 가 유효하지 않은 경우, GetController() 를 통해 해당 카메라의 컨트롤러를 가져옵니다.
• GetMousePosition()을 사용하여 마우스의 현재 위치(mouseLocation)를 가져옵니다.
• rotationMode 가 활성화된 경우, 마우스 움직임에 따라 회전을 처리합니다.
  • DeltaMouse 변수는 마우스 움직임의 변화량을 나타내며, mouseScreenLocationGrab 과 mouseLocation 의 차이로 계산됩니다.
  • RotationSpeed 와 DeltaSeconds 값을 곱하여 회전 속도를 계산합니다.
  • 회전 각도를 NewRotation 으로 업데이트한 후 SetActorRotation() 함수로 적용합니다.
  • mouseScreenLocationGrab 을 현재 mouseLocation 으로 업데이트합니다.
• rotationMode 가 비활성화된 경우, 마우스 위치에 따라 팬(Pan) 작업을 수행합니다.
  • 화면 가장자리에 마우스가 위치한 경우, 해당 방향으로 카메라를 패닝합니다.
  • ScreenEdgePanZonePercent 값을 기준으로 판닝이 발생할 지점을 결정합니다.
  • 각 방향에 대한 패닝 함수들(PanLeft(), PanRight(), PanForward(), PanBackward())을 호출합니다.

ARtscamera::BeginPlay

BeginPlay 함수에서는 게임 시작 시 한 번만 호출되며, 플레이어 컨트롤러의 인스턴스를 받아오고 초기 위치와 회전 값을 설정합니다.

• playerController: 현재 카메라의 컨트롤러를 가져와 playerController 변수에 할당합니다.
• CustomCollisionComponent 의 위치와 회전을 초기 값인 initLocation 과 initRotation 으로 설정합니다.
• CustomCollisionComponent 라는 스피어 컴포넌트의 월드 위치를 initLocation 변수로 설정합니다. 게임이 시작될 때 카메라의 위치를 initLocation 값으로 초기화합
• CustomCollisionComponent 의 월드 회전을 initRotation 값으로 설정합니다. 카메라의 회전을 initRotation 값으로 초기화합니다.
• playerController 를 통해 현재 화면의 너비와 높이인 screenWidth 와 screenHeight 를 얻어옵니다. playerController 의 뷰포트 크기를 가져와 screenWidth 와 screenHeight 변수에 할당합니다. 이를 통해 카메라의 화면 크기를 알 수 있습니다.

ARtscamera::ChangePitch

이 함수는 카메라의 피치(상하 회전)를 변경하는 역할을 합니다.

• magnitude 값에 따라 피치를 변경합니다. 입력된 magnitude 값이 양수면 위쪽 방향으로, 음수면 아래쪽 방향으로 피치를 변경합니다.
• 회전 모드가 활성화되어야 하며, playerController 가 유효하고 설정된 최대 및 최소 피치 값을 벗어나지 않아야 합니다.
• 위 조건을 만족하는 경우, AddControllerPitchInput() 함수를 사용하여 컨트롤러의 피치 입력을 변경합니다. magnitude 와 PitchChangeRate, GetWorld()->GetDeltaSeconds() 값을 조합하여 피치 변화의 크기 및 속도를 결정합니다.

ARtscamera::ChangeYaw

ChangeYaw 함수는 사용자 입력에 반응하여 카메라의 요(yaw, 좌우 회전)를 변경하는 역할을 합니다.

• magnitude 값에 따라 좌우 회전을 변경합니다. 입력된 magnitude 값이 양수면 우측 방향으로, 음수면 좌측 방향으로 회전합니다.
• 회전 모드가 활성화되어야 하며, playerController 가 유효한 경우에만 회전을 수행합니다.
• 위 조건을 만족하는 경우, AddControllerYawInput() 함수를 사용하여 컨트롤러의 요 입력을 변경합니다. magnitude 와 YawRate, GetWorld()->GetDeltaSeconds() 값을 조합하여 요 변화의 크기 및 속도를 결정합니다.

ARtscamera::Orbit

Orbit 함수는 카메라가 목표 주위를 회전(Orbit)하는 기능을 구현합니다.

• magnitude 매개변수는 Orbit의 크기를 나타내며, 양수일 경우 오른쪽으로, 음수일 경우 왼쪽으로 Orbit 동작이 수행됩니다.
• 조건을 만족하는 경우, AddControllerYawInput() 함수를 사용하여 컨트롤러의 요 입력을 변경합니다. magnitude 와 YawRate , GetWorld()->GetDeltaSeconds() 값을 조합하여 Yaw 변화의 크기 및 속도를 결정합니다
• 카메라의 Yaw 회전값에 입력을 추가합니다. 여기서 magnitude는 원점 주위의 회전 정도를 나타내며, YawRate은 Yaw 축을 따른 회전 속도를 나타냅니다. GetWorld()->GetDeltaSeconds()로 프레임 사이의 시간 간격(Delta Time)을 가져와 얼마나 많은 회전이 발생해야 하는지 계산합니다.
• 현재 컨트롤러의 방향으로부터 Y축 방향 벡터를 얻고, 이 벡터 방향으로 카메라를 이동시킵니다. 여기서도 마찬가지로 Delta Time과 다른 요소들을 곱하여 얼마나 많은 이동이 발생해야 하는지 계산합니다.

ARtscamera::PanForward/PanBackward/PanRight/PanLeft

이 네 가지 함수는 카메라를 각각 앞, 뒤, 오른쪽, 왼쪽으로 이동시키는 역할을 합니다.

• AddMovementInput() 함수를 호출하여 카메라의 위치를 움직입니다.
• 이동 방향은 카메라의 현재 회전에 따라 계산되며, FRotationMatrix(GetControlRotation()).GetScaledAxis() 를 사용합니다.
• PanRate 값에 따라 이동 속도가 결정됩니다.
• 회전 모드가 비활성화되어야 하며, playerController 가 유효한 경우에만 이동을 수행합니다.
• PanForward: 카메라를 앞으로 이동시키는 함수입니다. rotationMode가 비활성화되어 있고 playerController가 존재할 때만 이동합니다. FRotationMatrix(GetControlRotation()).GetScaledAxis(EAxis::X)로 현재 컨트롤러의 방향에서 X축 방향 벡터를 얻고, 이 벡터 방향으로 카메라를 PanRate * GetWorld()->GetDeltaSeconds() 만큼 이동시킵니다.
• PanBackward: 카메라를 뒤로 이동시키는 함수입니다. 위와 동일한 방식이지만, 마지막에 -PanRate * GetWorld()->GetDeltaSeconds()를 사용하여 반대 방향으로 이동시킵니다.
• PanRight: 카메라를 오른쪽으로 이동시키는 함수입니다. rotationMode가 비활성화되어 있고 playerController가 존재할 때만 이동합니다. FRotationMatrix(GetControlRotation()).GetScaledAxis(EAxis::Y)로 현재 컨트롤러의 방향에서 Y축 방향 벡터를 얻고, 이 벡터 방향으로 카메라를 PanRate * GetWorld()->GetDeltaSeconds() 만큼 이동시킵니다.
• PanLeft: 카메라를 왼쪽으로 이동시키는 함수입니다. 위와 동일한 방이지만, 마지막에 -PanRate * GetWorld()->GetDeltaSeconds()를 사용하여 반대 방향으로 이동시킵니다.

ARtscamera::ZoomIn

이 함수는 카메라의 줌 인/아웃을 처리하는 역할을 합니다, 마우스 휠에 바인딩되어 조작할 수 있습니다.

• magnitude 값에 따라 카메라의 Z 축 위치를 변경하여 줌 인 또는 줌 아웃을 수행합니다. 입력된 magnitude 값이 플러스면 줌 인, 마이너스면 줌 아웃이 됩니.
• 줌 속도는 ZoomRate 변수에 따라 바뀌며, GetWorld()->GetDeltaSeconds() 를 통해 프레임 간 시간 변화를 고려합니다.
• 카메라의 위치 변경을 AddMovementInput() 함수를 사용하여 수행합니다.
• 최대 및 최소 줌 값(MinZoom, MaxZoom) 범위 내에서만 변경됩니다.
• 회전 모드가 비활성화되어야 하며, playerController 가 유효한 경우에만 줌이 수행됩니다.
• 위 조건을 만족하는 경우, FRotationMatrix(GetControlRotation()).GetScaledAxis(EAxis::Z) 를 사용하여 컨트롤러의 현재 높이 축 벡터를 가져온 후, magnitude, -ZoomRate 값, GetWorld()->GetDeltaSeconds() 값을 조합하여 이동 입력의 크기와 속도를 결정합니다.

ARtscamera::EngageRotation()

오른쪽 마우스 버튼을 눌러서 카메라의 회전 기능을 활성화합니다.

이 함수는 카메라를 회전 모드로 전환하는 역할을 합니다. 회전 모드는 마우스 움직임에 따라 카메라가 회전하도록 만드는 것을 의미합니다. 함수 내에서 수행되는 주요 작업은 다음과 같습니다.

• playerController 가 유효한 경우에만 아래의 코드를 실행합니다.
• rotationMode 변수를 true 로 설정하여 회전 모드를 활성화합니다.
• playerController 의 마우스 커서 표시 여부와 클릭 이벤트 활성화 여부를 설정하여, 마우스 커서가 사라지고 클릭 이벤트가 비활성화되도록 합니다.
• InitialRotation 변수에 현재 카메라의 회전 값을 저장하여 회전 모드를 종료할 때 복원할 수 있도록 합니다.

ARtscamera::DisengageRotation()

EngageRotation과 반대로 작동하여 카메라의 회전 기능을 비활성화합니다.

이 함수는 회전 모드를 비활성화하여 카메라를 팬 모드로 전환하는 역할을 합니다. 함수 내에서 수행되는 주요 작업은 다음과 같습니다

• rotationMode 가 활성화되어 있고, playerController 가 유효한 경우에만 아래의 코드를 실행합니다.
• rotationMode 변수를 false 로 설정하여 회전 모드를 비활성화합니다.
• playerController 의 마우스 커서 표시 여부와 클릭 이벤트 활성화 여부를 복원하여 정상 상태로 돌아오게 합니다.
• InitialRotation 에 저장된 초기 회전 값을 사용하여 카메라의 회전 값을 원래 상태로 복원합니다.

ARtscamera::Jumpto

특정 위치로 즉시 카메라를 이동시키는 데 사용, 이 함수는 지정한 위치로 카메라를 순간이동시키는 역할을 합니다.

• FVector NewLocation 매개변수로 전달된 위치로 카메라의 위치를 변경합니다.
• NewLocation 벡터의 X와 Y 좌표를 그대로 사용하고, Z 좌표는 현재 카메라의 Z 좌표값을 사용하여 새로운 위치를 계산합니다. 이렇게 함으로써 카메라의 높이는 변경되지 않고 X와 Y 좌표만 변경됩니다. 새로운 위치 벡터 NewCameraLocation 을 사용하여 카메라의 위치를 이동시킵니다.
• 이 기능은 외부에서도 사용할 함수이기 때문에 UFuction으로 만들었습니다.