[UE5] #04 언리얼 오브젝트 살펴보기!

[ 언리얼 오브젝트 ] 

: 언리얼 엔진이 설계한 새로운 시스템의 단위 오브젝트이다.

https://docs.unrealengine.com/4.27/ko/ProgrammingAndScripting/ProgrammingWithCPP/UnrealArchitecture/Objects/

• 기존 C++ 오브젝트에 모던 객체 지향 설계를 위한 다양한 기능을 추가한 오브젝트이다.
• 언리얼에서는 일반 C++ 오브젝트와 언리얼 오브젝트 모두 사용할 수 있다.
  • C++ 오브젝트 : 접두사로 F 사용. 저수준의 빠른 처리를 위한 기능 구현에 사용
  • 언리얼 오브젝트 : 접두사로 U 사용. 콘텐츠 제작에 관련된 복잡한 설계 구현에 사용
• UCLASS 매크로를 사용하여 언리얼 엔진에 UObject로 등록할 수 있다.

{ 언리얼 오브젝트 기본 헤더 살펴보기 }

• CoreMinimal.h와 UObject/NoExportTypes.h는 언리얼 오브젝트에 기본적으로 포함되어야 할 헤더이다.
• MyObject.generated.h는 리플렉션 등 언리얼이 제공하는 하이레벨 OOP 언어의 기능들이 포함되어있다.
  • GENERATED_BODY()는 #define (현재 파일 ID) + _ + (라인정보) + _GENERATED_BODY 로 치환될 수 있다.
    • 이것은 MyObject.generated.h에 있는 (현재 파일 ID) + _ + (라인정보) + _GENERATED_BODY 이 정의된 아래 부분을 사용한다는 의미이다.
    • 이 부분에는 언리얼이 제공하는 하이 레벨 OOP 언어의 기능들이 포함되어 있다.
• UCLASS() 매크로 : 언리얼에 리플렉션 프로퍼티로 등록
• MYGAME_API를 앞에 붙이면 외부 모듈에서 나의 게임 프로젝트에 속한 UMyObject에 접근할 수 있게 된다. (MYGAME은 나의 게임 프로젝트 이름)

언리얼 헤더 툴(UHT)
위 코드에서 빌드 요청 시 MyObject.generated.h 을 자동 생성해준다.
과정 : 빌드 요청 → 언리얼 헤더 툴이 코드 분석 → MyObject.generated.h 생성 → 컴파일

{ 언리얼 오브젝트 특징 }

• 특징 : 언리얼 엔진이 제공하는 하이레벨 OOP 언어의 기능을 가진다.
  • 클래스 기본 객체(CDO) : 클래스의 기본 값과 타입 정보 제공
  • 리플렉션(Reflection) : 런타임에서 클래스 정보 참조 기능
  • 인터페이스(Interface) : 모던 객체 지향 언어가 제공하는 인터페이스 제공
  • 향상된 열거형(Enum) : 보다 향상된 열거형 지원
  • 델리게이트(Deligate) : 객체간 결합을 낮출 수 있는 델리게이트 기능 제공
  • 가비지컬렉션(Garbage Collection) : 자동 메모리 관리
  • 향상된 구조체(Struct) : 리플렉션이 가능한 구조체 지원
  • 직렬화(Serialization) : 객체 정보를 바이트 스트림으로 저장, 전송, 불러들이는 기능

{ 언리얼 오브젝트의 리플렉션 시스템 }

https://www.unrealengine.com/ko/blog/unreal-property-system-reflection

리플렉션은 프로그램이 실행시간에 자기 자신을 조사하는 기능이다.

• 리플렉션은 언리얼 엔진 기술의 중요한 근간으로 ,에디터의 디테일 패널, 직렬화, 가비지 컬렉션, 네트워크 리플리케이션, 블루프린트/C++커뮤니케이션 등 다수의 시스템 언리얼 시스템에 포함되어 있다.
• 리를렉션 시스템은 옵션이다. 리플렉션 시스템에 보였으면 하는 유형이나 프로퍼티에 주석을 달아주면, 언리얼 헤더 툴(UHT)이 해당 프로젝트를 컴파일할 때 해당 정보를 수집하여 {%FileName%}.generated.h 에 포함시켜준다.
  • UCLASS() , UPROPERTY(), UFUNCTION() 등의 매크로로 해당하는 요소를 마킹하면 리플렉션 프로퍼티로 언리얼 엔진에 등록된다.
    • 매크로의 인자로 에디터와 연동되는 메타 데이터를 전달하여 설정할 수 있다.
• 리플렉션 프로퍼티가 아닌 요소들은 등록된 요소들과 혼합하여 사용할 수 있으나, 언리얼 엔진으로부터 관리받지 못한다.

리플렉션 프로퍼티 등록 과정 (출처)
1. UBT가 리플렉션 키워드 탐색
2. UHT가 해당 .cpp를 파싱
3. 리플렉션 데이터 정보를 수집
4. 수집된 정보는 별개의  {%FileName%}.generated.h와 같은 이름의 .cpp로 저장
5. 빌드 시 기존 코드에  {%FileName%}.generated.h 코드를 include 하여 컴파일

{ 언리얼 오브젝트 구성 }

• 언리얼 오브젝트에 리플렉션 프로퍼티와 함수를 지정할 수 있다.
  • 언리얼 시스템에 의해 관리되는 클래스 멤버 변수는 UPROPERTY() 매크로 지정 가능
  • 언리얼 시스템에 의해 관리되는 클래스 멤버 함수는 UFUNCTION() 매크로 지정 가능
  • 지정한 매크로 안에 에디터와 연동되는 메타 데이터를 심을 수 있다. ( 인자로 전달 )
• 모든 언리얼 오브젝트는 클래스 정보(UClass)와 함께한다.
  • UClass : 언리얼 오브젝트 클래스의 정보를 담은 클래스. 언리얼 오브젝트 클래스는 UClass를 사용해서 자신이 가진 프로퍼티와 함수 정보를 컴파일 타임과 런타임에 조회할 수 있다.
• 이렇게 다양한 기능을 제공하는 언리얼 오브젝트는 NewObjectAPI를 사용해 생성해야 한다.
  • 일반 C++ 객체는 new()로 생성
  • 언리얼 C++ 객체는 NewObject()로 생성
• 언리얼 오브젝트에서 StaticClass()와 GetClass()로 UClass를 얻을 수 있다.
  • StaticClass()와 GetClass() 차이 : StaticClass()는 컴파일 타임에, GetClass()는 런타임에 UClass에 접근한다.

{ 언리얼 오브젝트의 클래스 기본 오브젝트(CDO) }

• 언리얼 클래스 정보에는 클래스 기본 오브젝트(CDO, Class Default Object)가 포함되어 있다.
• CDO는 언리얼 객체가 가진 기본 값을 저장하는 템플릿 객체이다.
• 한 클래스로부터 다수의 물체를 생성해 게임 콘텐츠에 배치할 때 일관성 있게 기본 값을 조정하는데 유용하게 사용된다.
• CDO는 UClass에서 GetDefaultObject() 함수를 호출해 얻을 수 있다.
• UClass 및 CDO는 엔진 초기화 과정에서 생성되므로 콘텐츠 제작에서 안심하고 사용할 수 있다.

{ 언리얼 오브젝트 처리 }

https://docs.unrealengine.com/5.1/ko/unreal-object-handling-in-unreal-engine/

클래스, 프로퍼티, 함수에 적합한 매크로로 마킹해주면 UClass, UProperty, UFunction 으로 변한다. 그러면 언리얼 엔진이 접근할 수 있어, 다수의 내부적인 처리 기능을 구현할 수 있다.

1. 자동 초기화
   UObject는 생성자 호출 전 초기화시 자동으로 0으로 채워진다.
2. 레퍼런스 자동 업데이트
   언리얼 엔진의 가비지 컬렉션으로 안전하게 동적할당할 수 있다.
3. 직렬화
   언리얼 오브젝트 객체를 지정된 포맷에 맞게 저장하거나 불러들이는 것을 일관적으로 진행할 수 있는데, 저장되는 정보를 UProperty로 명시하면 언리얼 오브젝트가 자동으로 디스크에 저장하고 불러들일 수 있다.
4. 프로퍼티 값 업데이트 하기
   하나의 클래스에서 파생된 많은 오브젝트를 게임 월드 상에 배치했을 때, 클래스 디폴트 오브젝트를 이용하여 기본값을 효과적으로 관리할 수 있다.
5. 에디터 통합
   리플렉션 메크로에 메타 데이터를 넣어주면 에디터와 통합되면서 유용한 기능을 사용할 수 있다.
6. 런타임 유형 정보 및 형변환
   리플렉션 기능을 이용해 런타임에 자신의 타입을 확인할 수 있고 안전한 형변환이 가능하다.
7. 가비지 컬렉션
   더 이상 사용되지 않은 오브젝트는 언리얼 엔진이 자동으로 메모리에서 소멸시킨다.
8. 네트워크 리플리케이션
   네트워크로 UProperty로 명시한 언리얼 오브젝트를 자동으로 송수신 할 수 있다.

[ 정리 ]

1. 언리얼 오브젝트는 기존의 C++ 클래스에 모던 객체 지향 설계를 위한 다양한 기능을 추가한 오브젝트이다.
2. 언리얼 오브젝트의 모던 객체 지향적인 기능은 빌드시 UBT와 UHT에 의해 {%FileName%}.generated.h에 생성된다. 
3. 언리얼 오브젝트에는 항상 클래스 정보를 담은 UClass 객체가 매칭되어 있다.
4. UClass로부터 언리얼 오브젝트의 정보를 파악할 수 있다.
5. UClass에는 클래스 기본 오브젝트(CDO)가 연결되어 있어 이를 활용해 개발의 생산성을 향상시킬 수 있다.
6. 클래스 정보(UClass)와 CDO는 엔진 초기화 과정에서 생성되므로 게임 개발에서 안전하게 사용 가능하다.
7. 헤더 정보를 변경하거나 생성자 정보를 변경하면 에디터를 끄고 컴파일 하는 것이 안정적이다. 

 

reference

강의 : 이득우 언리얼 프로그래밍 강좌