[Unreal] 프로퍼티(리플렉션), 매크로, 가비지 컬렉션

1. 리플렉션

리플렉션(Reflection)은 프로그램이 실행 시간에 자기 자신을 조사하는 기능이다. 여기서 자기 자신이란 클래스, 구조체, 함수, 멤버 변수, 열거형 등을 의미한다. 즉, 런타임에 객체의 타입을 보는 것을 포함해 구조와 행동까지 수정하는 것이 리플렉션이다.

 

2. 프로퍼티

자바나 C#에서는 리플렉션을 지원하지만, 언리얼 C++에서는 지원하지 않고 있다. 그래서 언리얼 자체 시스템으로 리플렉션을 제공하고 있으며 그 시스템을 언리얼의 리플렉션인 프로퍼티라 부른다.

 

언리얼 내의 여러 가지 시스템들이 이 리플렉션 객체에 의존한다.

• 네트워크 리플리케이션
• 블루프린트와 C++ 연동
• 에디터의 디테일 패널
• 자동 시리얼라이제이션
• 가비지 컬렉션

 

3. 매크로

클래스, 변수, 함수 등 상황에 맞게 매크로를 달아두면, UHT(Unreal Header Tool)가 빌드 전처리 시 필요한 정보를 수집하여 프로퍼티 시스템에 등록하게 된다.

• 매크로를 잘 조작함으로서 C++와 블루프린트 연동을 잘할 수 있다.
• UENUM(), UCLASS(), USTURCT(), UFUNCTIONI(), UPROPERTY() 등

 

// 리플렉션이 있는 타입은 이 헤더파일을 인클루드해서 UHT에 알린다.
#include "MyObject.generated.h"

// MyObject는 리플렉션 되는 클래스임을 나타낸다.
UCLASS()
class UMyObject : public UObject
{
    // 자동 생성된 코드가 여기에 삽입된다는 마커.
    GENERATED_BODY()
    
    // MyFunc는 리플렉션 되는 멤버 함수임을 나타낸다.
    UFUNCTION()
    void MyFunc(int, double) {}
    
    // MyData는 리플렉션 되는 멤버 변수임을 나타낸다.
    UPROPERTY()
    int32 MyData;
    
    // 리플렉션이 되지 않는 것을 섞어도 된다.
    // 하지만 리플렉션 시스템에 보이지 않으므로 주의해야한다.
    uint8 MyNum;
    // 예를 들면 리플렉션 되지 않는 UObject 포인터를 저장하는 것은 
    // 가비지 컬렉터가 레퍼런스를 확인할 수 없기 때문에 위험하다.
    UObject* MyObjectRef;
}

// MyEnum은 리플렉션 되는 열거형임을 나타낸다.
UENUM()
enum class EMyEnum
{
    ....
};

// MyStruct는 리플렉션 되는 구조체임을 나타낸다.
USTRUCT()
struct FMyStruct
{
    GENERATED_BODY()
    
    UPROPERTY()
    int32 MyData;
    
    // 구조체의 멤버함수는 UFUNCTION으로 지정할 수 없다!
    // UFUNCTION()
    void MyFunc(double) {}
}

 

1) UPROPERTY()

변수에 붙는 매크로이며 인자 값을 넣어서 용도에 맞게 활용할 수 있다.

 

UPROPERTY(VisibleInstanceOnly, BlueprintReadOnly, Category = Attack, Meta = (AllowPrivateAccess = true))
float AttackRange;

 

1) 변수 공개와 수정 권한

• VisibleDefaultsOnly: 블루프린트 에디터 창의 디테일 패널에서 값 보기 가능
• VisibleInstanceOnly: 월드 상에 배치된 오브젝트의 디테일 패널에서 값 보기 가능
• VisibleAnywhere: 둘 다 보기 가능 
• EditDefulatOnly: 블루프린트 에디터 창의 디테일 패널에서 값 수정 가능
• EditInstanceOnly: 월드 상에 배치된 오브젝트의 디테일 패널에서 값 수정 가능
• EditAnywhere: 둘 다 수정 가능

 

2) 블루프린트 공개와 수정 권한

• BlueprintReadOnly: 블루프린트에서 읽기 가능
• BlueprintReadWrite: 블루프린트에서 읽기와 쓰기 가능
• BlueprintGetter: 해당 함수를 통해 블루프린트에서 접근 가능
• BlueprintSetter: 해당 함수를 통해 블루프린트에서 수정 가능

 

2) UFUNCTION()

함수에 붙는 매크로이다.

 

// header 파일
UFUNCTION(BlueprintCallable, Category = "value")
void Function();

// cpp 파일
void AMyActor::Function()
{
	// 동작
}

• BlueprintCallable: 블루프린트 내에서 사용 가능
• BlueprintPure: 블루프린트 내에서 값 하나 반환하는 형태에 사용
• BlueprintImplementableEvent, BlueprintNativeEvent

 

3) UEnum()

UENUM(BlueprintType)
enum class ETestEnum : uint8
{
    TE_OptionA UMETA(DisplayName = "Option A"),
    TE_OptionB UMETA(DisplayName = "Option B"),
};

• BlueprintType: 구조체가 블루프린트에서 사용 가능

 

4) USTRUCT()

USTRUCT(Atomic, BlueprintType)
struct FCustomStruct
{
    GENERATED_BODY()
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    AActor* actor;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    int32 i;
};

• Atomic: 구조체가 항상 하나의 단위로 직렬화(Serialize) 됨
• BlueprintType: 구조체가 블루프린트에서 사용 가능

 

4. 가비지 컬렉션

가비지 컬렉션은 더 이상 필요하지 않은 객체를 가비지 컬렉터가 메모리에서 할당 해제해 주는 방법이다. 프로그램의 규모가 커질수록 아래와 같은 상황들을 신경 쓰기가 어렵기 때문에 등장한 개념이라고 볼 수 있다.

• 메모리 누수: 더 이상 사용되지 않는 객체인데 delete를 하지 않음
• Dangling pointer: 아직 사용 중인 객체인데 delete 해버림
• undefined behaviour: 할당되지 않은 영역에 대해 delete 해버림

 

언리얼에서는 참조 그래프를 만들어 어느 오브젝트가 사용 중이고 어느 것이 사용 중이지 않은지 확인한다. 루트에는 Root set이 있으며 UObject가 아래에 추가된다.

 

참조 그래프

 

가비지 컬렉션이 발생하면 Root set부터 시작해서 트리를 검색한다. 여기서 찾지 못한 오브젝트는 참조되지 않은 오브젝트이므로 해제하고 제거한다. 이러한 방식은 Mark & Sweep 방식이라 부르며 Root set부터 Mark 되고 Mark 되지 않은 오브젝트들은 Sweep 된다고 할 수 있다.

 

이렇게 Root set부터 아래 UObject를 따라 내려가기 위해서는 프로퍼티가 필요하다. 프로퍼티가 객체 내의 UObject 포인터 위치를 가비지 컬렉터에게 알려주기 때문이다. 

 

참고

https://upbo.tistory.com/79

[Unreal Engine] 리플렉션(프로퍼티)과 가비지 컬렉션

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

언리얼 프로퍼티 시스템 (리플렉션)

https://hyo-ue4study.tistory.com/182

[언리얼엔진] 리플렉션 (aka. 프로퍼티 시스템)