타임라인🎬 05 - Custom Playables 트랙 만들기

14 Jan 2021 in Dev.Log on Unity, Timeline, Playables

애니메이션 및 튜토리얼 제작에 유용한 유니티 타임라인에 대해 알아본다. 이번 포스팅에서는 타임라인의 꽃이라고 할 수 있는 Custom Playables에 대해 다룬다.

• Playables?
• 유니티 공식지원 에셋 - Default Playables✨
  • Playables Wizard 🧙‍♂️
• 스크립트 간단설명 🗃
  • ~MixerBehaviour.cs 부연설명
    • ProcessFrame() 코드 설명
    • Input Count
    • Input Weight
• 마무리

타임라인에서는 기본으로 존재하는 트랙 외의 사용자가 만든 트랙과 클립을 이용할 수 있다. 이러한 작업을 부르는 명칭은 현재 하나로 통일되지 않고 여러 단어로 쓰이고 있다. 그 중 많이 쓰이는 단어는 아래와 같다. 아래의 단어로 좀 더 서칭해보면 좋을 것이다.

• extending timeline
• custom playables
• timeline scripting
• custom track

Playables?

이 포스팅에서는 custom playables라는 단어로 서술한다.
Timeline은 내부적으로 Playables API를 상속받고 있다. 타임라인 관리 컴포넌트 이름도 Playable Director이고, 클래스들도 Playables를 상속받고 있는 것을 볼 수 있다.

예시-유니티에서 지원하는 TimeDilation Custom Playables Track

그렇다면 Playables는 무엇일까 궁금해진다. 찾아보니 애니메이션이나 오디오, 그리고 스크립트까지 믹스와 블렌드를 지원해준다고 한다.

👉참고: Unity Playable API Documentation

유니티 공식지원 에셋 - Default Playables✨

👉에셋스토어 링크: Default Playables

먼저 공식에셋을 다운받는 것을 추천한다. [Default Playables]에는 예제와 함께 커스텀 플레이어블을 쉽게 만들 수 있는 에디터인 [Playables Wizard]를 함께 지원해주기 때문이다.

임포트를 완료했다면 타임라인에서 예제 트랙을 생성할 수 있다. 예제는 총 7가지이며 활용성이 높은 것들로 이루어져 있다. 소스코드도 모두 들어있고 나중에 이 예제들을 참고하여 코드를 수정하기도 하기 때문에 시간이 많다면 천천히 예제를 다뤄보며 이해하는 것을 추천한다.

Playables Wizard 🧙‍♂️

플레이어블 위자드는 커스텀 플레이어블 스크립트의 틀을 만들어주는 역할을 한다. 세부적인 코드를 작성할 수는 없지만 적어도 이름, 트랙 색상, 블렌드 타입, 바인딩 컴포넌트 선택, 변수 선택 등 필수적인 요소들을 기반으로 빠르게 스크립트를 만들어준다.

유니티 에디터에서 [Window → Timeline Playable Wizard…]를 선택하여 창을 연다.

창을 열면 이러한 에디터창이 뜨게 된다. [Show Help]에 체크를 하게 되면 각각 어떤 역할을 하는지 설명해주는 메세지박스가 뜬다. 천천히 읽어보면 이해가 가능하다.

그 중 조금 헷깔리는 것은 [Exposed References]와 [Behaviour Variables]일텐데, 이 둘은 클립에 바인딩되는 변수들이다. 이름만 봐도 알겠지만 각각 참조와 값을 받는다. 씬에 있어서 참조해야할 변수는 Exposed References로 지정하고, 씬에 없고 값만 존재하는 변수는 Behaviour Variables로 지정하면 된다.

스크립트 간단설명 🗃

타임라인 커스텀 플레이어블 스크립트 보통 5가지 종류로 분류한다.

1. ~Track.cs

   트랙의 색상, 바인딩타입을 정하는 등 트랙 자체에 관여하는 스크립트

2. ~Clip.cs

   블렌딩 타입 등 클립 생성에 관여하는 스크립트.
   참조변수(Exposed References)는 Resolve()라는 함수를 호출해야만 사용할 수 있기 때문에 Clip 스크립트에서 CreatePlayable() 함수를 통해 Behaviour 스크립트에게 넘겨준다.

3. ~Behaviour.cs

   클립을 클릭하면 인스펙터창에 나오는 변수들(Behaviour Variables)이 여기에 존재한다.

4. ~MixerBehaviour.cs

   가장 중요한 스크립트. 재생 시에 이루어지는 거의 모든 처리는 이 스크립트에서 담당한다.
   클립에 들어설 때, 클립을 통과 중일 때, 클립을 나갈 때, 블렌드 되고 있을 때 등등의 처리를 모두 ProcessFrame()이라는 함수를 override함으로써 처리 가능하다.

5. ~Drawer.cs (Editor)

   클립의 에디터. 클립을 클릭하면 인스펙터창에 이 에디터 스크립트에서 설정한 레이아웃으로 표시된다.

~MixerBehaviour.cs 부연설명

주어진 예제를 분석하는 것이 스크립트에 대한 이해가 가장 빠르겠지만, 가장 중요한 MixerBehaviour 스크립트는 좀 더 설명을 써두겠다. 아래부터 이어지는 부연설명들은 스크립트를 대충이라도 분석해본 사람을 위해 적는 것이므로 바로 이해가 힘들 수는 있다.

만약 예제를 분석하기 어렵다면 다음 포스팅에서 필자가 작성한 커스텀 플레이어블 트랙을 분석하는 내용을 다룰테니 그것을 보아도 좋다.

ProcessFrame() 코드 설명

[Timeline Playable Wizard…]를 통해 타임라인을 만들었다면 MixerBehaviour에 자동으로 ProcessFrame()을 override하는 함수가 생성되어 있을 것이다. 주의해야할 것은 유니티 에디터의 플레이 버튼을 누르지 않아도 타임라인을 실행하거나 인디케이터를 옮기면 함수가 호출된다는 점이다. 이를 염두에 두고 스크립트를 짜야한다.

아래의 코드는 ProcessFrame()함수에서 있으면 편한 것들에 대해 추려놓은 코드이다.

	// 주의: 이 함수는 Play모드가 아닌 Edit모드에서도(플레이 버튼을 누르지 않았을 때도) 호출됨.
	public override void ProcessFrame(Playable playable, FrameData info, object playerData)
	{
		// 트랙에 존재하는 클립의 갯수
		int inputCount = playable.GetInputCount();
		int currentInputCount = 0;
		
		for (int i = 0; i < inputCount; i++)
		{
			// 클립의 blending에 비례하여 계산하는 트랙 점유율(0~1)
			float inputWeight = playable.GetInputWeight(i);
			
			if (inputWeight > 0f)
				currentInputCount++;
		}

        // 클립이 없는 곳을 지나는 중
        if (currentInputCount == 0)
        {
            Debug.Log("없음");
        }
        // 클립이 1개인 곳을 지나는 중
        else if(currentInputCount == 1)
        {
            Debug.Log("1개");
        }
	// 클립이 2개 이상인 블렌딩되고 있는 곳을 지나는 중
        else
        {
            Debug.Log("블렌딩");
        }
	}

Input Count

InputCount란 해당 트랙에 존재하는 클립의 갯수를 뜻한다. 기본적으로 Playable.GetInputCount()를 통해 클립의 갯수를 int로 반환받는다.

Input Weight

InputWeight란 현재 클립이 트랙에서 blending에 비례하여 얼마나 트랙을 점유하고 있는지에 대한 값이다. 0에서 1까지의 float값으로 반환받는다. 만약 블렌딩되고 있지 않다면 1을 반환하고, 해당 클립이 재생되고 있지 않다면 0을 반환한다. 블렌딩되고 있다면 0과 1의 사이값을 반환한다.

플레이어블 트랙이 재생 중에 있다면 함수 안에서 InputWeight를 이용하여 현재 재생중인 곳(인디케이터의 위치)에 클립이 있는지 없는지 검사할 수 있다.

마무리

타임라인에서 이 커스텀 플레이어블만 잘 써도 정말 무궁무진한 확장이 가능하다. 이 매력에 반해서 다음 프로젝트로 타임라인을 사용하면 어떨까 생각하고 있다. 프로젝트용으로 커스텀 플레이어블을 사용할 때에는 시간에 쫓겨 구현에만 급급했는데, 포스팅을 하면서 차분히 돌아볼 수 있어서 좋았다.

이전에 설명한 시그널보다는 커스텀 플레이어블을 추천하는 이유는 반복사용에 용이하다는 점 때문이다. 다음 포스팅에선 실제 프로젝트에 사용된 코드를 분석해보도록 하자.