CubismNativeFramework를 직접 이용하는 방법

업데이트: 2020/01/30

Cubism SDK for Native와 함께 제공되는 샘플 프로젝트는 CubismNativeFramework(SDK 패키지의 /Framework/ 이하)를 사용하여 Cubism 모델을 처리합니다.
Cubism 모델을 취급하는 프로젝트를 작성하는 경우는 샘플 프로젝트를 기초로 이용하는 것이 좋다고 생각하지만, 기존 애플리케이션이나 유저의 독자적인 엔진 등에 구현할 때는 CubismNativeFramework의 API를 직접 취급하고 싶은 경우가 있습니다.
그러나 포함된 샘플 프로젝트는 고기능이기 때문에, 이를 참고로 하는 것만으로는 구조의 이해와 분리가 쉽지 않습니다.

아래에서는 위와 같은 사용자를 대상으로 CubismFramework를 직접 호출하여 모델을 취급하는 최소 스니펫을 소개합니다.

CubismFramework 사이클

CubismFramework를 다루는 절차는 다음과 같습니다.

  1. CubismFramework 초기화
  2. 모델 파일의 패스 가져오기
  3. 모델 불러오기
  4. 업데이트 처리
  5. 모델 파기
  6. CubismFramework 종료 처리

CubismFramework 초기화

CubismFramework의 초기화 처리는 다음과 같습니다.

CubismFramework는 CubismFramework::StartUp()의 첫 번째 인수에 전달된 할당자를 사용하여 메모리를 확보합니다.
Cubism SDK for Native에는 CubismNativeSamples에 할당자 샘플이 있습니다.
CubismFramework에서 사용하는 할당자는 정렬을 지정하여 확보하는 구현도 필요합니다.
그 때문에, 기본적으로는 샘플의 것을 이용하는 편이 빠르게 임베디드 할 수 있기 때문에 좋다고 생각되지만, 메모리의 확보도 독자적인 것으로 커스터마이즈 하고 싶은 경우는 유저 측에서 독자적으로 실장한 것으로 교체하거나 샘플을 개조해서 임베디드 하는 것도 가능합니다.

할당자의 구체적인 구현에 대해서는 여기를, 커스텀 메모리 할당자의 작성상의 주의에 대해서는 여기를 봐 주세요.  

    // 로그 등의 옵션 설정.
    CubismFramework::Option _cubismOption;
    
    // 할당자.
    LAppAllocator _cubismAllocator;
    
    // 메시지 출력 함수.
    static void PrintMessage(const Csm::csmChar* message);
    // 로그 출력 레벨을 설정. LogLevel_Verbose의 경우는 상세 로그를 출력시킨다.
    _cubismOption.LoggingLevel = CubismFramework::Option::LogLevel_Verbose;
    _cubismOption.LogFunction = PrintMessage;
    
    // CubismNativeFramework 초기화에 필요한 파라미터를 설정한다.
    CubismFramework::StartUp(&_cubismAllocator, &_cubismOption);
    
    // CubismFramework를 초기화한다.
    CubismFramework::Initialize();
Tips

CubismFramework::Initialize()를 호출하는 것은 초기화 시의 한 번뿐으로, 그 후에는 CubismFramework가 파기되지 않는 한 연속으로 호출해도 스킵 합니다. 단, 한번 CubismFramework를 파기한 후라면 재차 초기화를 실시하는 경우 CubismFramework::Initialize()를 호출합니다.

모델 파일의 패스 가져오기

Cubism의 임베디드용 데이터 세트는 model3.json에 각각의 상대 패스가 기술되어 있습니다.
.moc3 파일이나 텍스쳐 등을 직접 지정해 읽어도 괜찮지만, 기본적으로는 model3.json으로부터 패스를 취득해 읽어들이는 것을 추천합니다.

model3.json의 투시는 CubismFramework의 CubismModelSettingJson 클래스를 사용합니다.

    csmByte* CreateBuffer(const csmChar* path, csmSizeInt* size)
    {
        if (DebugLogEnable)
        {
            LAppPal::PrintLog("[APP]create buffer: %s ", path);
        }
        return LAppPal::LoadFileAsBytes(path, size);
    }

    void DeleteBuffer(csmByte* buffer, const csmChar* path = "")
    {
        if (DebugLogEnable)
        {
            LAppPal::PrintLog("[APP]delete buffer: %s", path); } LAppPal::ReleaseBytes(buffer); }
    // model3.json 불러오기.
    csmSizeInt size;
    const csmString modelSettingJsonPath = _modelHomeDir + modelSettingJsonName;
    csmByte* buffer = CreateBuffer(modelSettingJsonPath, &size);
    ICubismModelSetting* setting = new CubismModelSettingJson(buffer, size);
    DeleteBuffer(buffer, modelSettingJsonPath.GetRawString());
    
    // model3.json에 기술된 모델의 패스를 취득.
    csmString moc3Path = _modelSetting->GetModelFileName();
    moc3Path = _modelHomeDir + moc3Path;

모델 불러오기

모델을 로드하려면 CubismModel 인터페이스를 사용합니다.

CubismModel의 인스턴스는 CubismNativeFramework에서는 CubismUserModel::_model을 보유하고 있습니다.
이쪽을 이용하는 경우 CubismUserModel를 상속한 클래스로 취급하는 것을 추천하고 있습니다.

또 텍스쳐나 모션, 표정 모션 등의 리소스 관리는 외부에서 실시하는 것도 가능합니다.

이 예에서는 CubismUserModel을 상속한 CubismUserModelExtend를 사용하여 설명합니다.

    // 모델의 인스턴스를 생성.
    CubismUserModelExtend* userModel = new CubismUserModelExtend();
	
    // moc3 파일 불러오기.
    buffer = CreateBuffer(moc3Path.GetRawString(), &size);
    userModel->LoadModel(mocBuffer, mocSize);
    DeleteBuffer(buffer, moc3Path.GetRawString());


로드할 moc3 파일의 패스는 위와 같이 model3.json에서 얻을 수 있는데, 마찬가지로 model3.json에서 표정, 물리 연산, 포즈, 눈 깜빡임, 립싱크, 사용자 데이터, 모션 패스도 얻을 수 있습니다.
SDK의 샘플에서는 모델의 로드와 동시에 이러한 로드도 실시하고 있습니다.
각각의 로드 방법에 대해서는 이하를 참고해 주세요.

Tips

상기의 스니펫은 화면에 모델을 1개 표시하는 것을 전제로 한 것입니다. 화면에 복수의 모델을 동시에 표시하는 경우 표시하는 모델과 같은 수의 CubismUserModel 파생 클래스의 인스턴스를 생성합니다.

업데이트 처리

Cubism 모델의 업데이트 처리는 모델의 초기화와 같이 CubismModel의 인터페이스인 CubismModel::Update()를 호출하여 실시합니다.
CubismModel::Update()를 호출하면 Cubism Core의 업데이트 처리가 이루어지고, 그때까지 설정된 파라미터나 파츠의 값으로부터 정점 정보를 갱신합니다.

    void CubismUserModelExtend::Update()
    {
        // 파라미터 조작.
        _model->SetParameterValue(CubismFramework::GetIdManager()->GetId("ParamAngleX"), value);
        
        // 파츠 불투명도 조작.
        _model->SetPartOpacity(CubismFramework::GetIdManager()->GetId("PartArmL"), opacity);
        
        // 모델 정점 정보 업데이트
        _model->Update();
    }

업데이트 처리에서는 반드시 Update() 이전에 시선 추종이나 물리 연산, 모션 재생 등을 실시합니다.

CubismModel::Update()보다 나중에 파라미터의 값을 조작해도 반영되지 않습니다.
그 후 다시 CubismModel::Update()를 호출하면 반영되지만, 이 처리는 부하가 높기 때문에 하나로 정리하는 것을 추천합니다.

    // 정점에 반영됨
    _model->SetParameterValue(CubismFramework::GetIdManager()->GetId("ParamAngleX"), value);
    
    // 모델 정점 정보 업데이트
    _model->Update();
    
    // 정점에 반영되지 않음
    _model->SetParameterValue(CubismFramework::GetIdManager()->GetId("ParamAngleX"), value);


모션을 재생하는 CubismMotionManager::UpdateMotion()은 재생하는 모션에 사용되는 ID의 파라미터값을 모두 덮어쓰기합니다.
그 때문에, 이 처리 이전에 파라미터의 값을 조작해도 모두 CubismMotionManager::UpdateMotion()의해 덮어쓰기되어 버립니다.
시선 추종 등의 값 조작이나 물리 연산 등은 먼저 모션의 재생 처리를 실시한 후에 실시하는 것을 추천합니다.

    // 재생 중인 모션을 모델에 반영
    _motionManager->UpdateMotion(_model, deltaTimeSeconds);
    
    // 시선 추종 등의 값 조작이나 물리 연산 처리
    
    // 모델 정점 정보 업데이트
    _model->Update();


또한 재생하는 모션에 모든 파라미터가 사용되고 있지 않은 경우나 모션의 재생이 정지하고 있는 등의 이유로 파라미터의 값을 조작하지 않는 경우 이전 프레임에서 실시한 값 조작의 결과가 남아 있는 상태가 됩니다.
그러므로 나중에 수행하는 상대적인 파라미터의 값 조작 결과가 의도하지 않은 것이 될 가능성이 있습니다.
이것은 모션을 모델에 반영시키는 처리의 전후에 CubismModel::LoadParameter(), CubismModel::SaveParameter()를 호출함으로써 그 후에 실시하는 상대적인 값 조작을 리셋하는 것이 가능합니다.

    // 모든 파라미터의 값을 저장 시 상태로 복원
    _model->LoadParameters();
    
    // 재생 중인 모션을 모델에 반영
    _motionManager->UpdateMotion(_model, deltaTimeSeconds);
    
    // 모든 파라미터의 값을 저장
    _model->SaveParameters();
    
    
    // 상대적인 값 조작 처리
    
    
    // 모델 정점 정보 업데이트
    _model->Update();


시선 추종이나 물리 연산, 모션의 재생 등의 처리 자체에 대해서는 각각의 문서를 참조해 주세요.

이 갱신 후의 정점 정보 등을 렌더러에 전달하면 Cubism 모델을 화면에 그릴 수 있습니다.

모델 파기

모델을 파기하려면 생성된 CubismUserModel 파생 클래스의 인스턴스를 파기합니다.
이렇게 하면 이 모델이 보유하고 있는 모션이나 표정, 물리 연산 등의 정보가 CubismUserModel의 소멸자로부터 파기됩니다.

    // 모델 데이터 파기
    delete userModel;

Cubism Framework 종료 처리

CubismFramework가 확보한 공통 부분의 리소스를 해제하려면 CubismFramework::Dispose()를 호출합니다.
CubismFramework::Dispose()는 CubismFramework::Initialize()를 호출하기 전에 호출하지 마십시오.

또한 CubismFramework::Dispose()를 호출하는 경우 모든 모델을 미리 파기해야 합니다.
이것은 모델을 파기하는 처리가 할당자의 Deallocate()를 이용하고 있기 때문입니다.

    // CubismFramework 파기
    CubismFramework::Dispose();
Tips

CubismFramework로 초기화된 데이터는 static한 영역에 배치되며 모델 데이터에 의존하지 않습니다. 따라서 여러 모델 간에서 쓸 수 있으며 모델 전환만이라면 CubismFramework::Dispose()를 호출할 필요가 없습니다.

이 기사에 관한 의견 및 요청사항을 보내 주시기 바랍니다.