【Native】正片叠底色/屏幕色

最終更新： 2022年5月19日

通过将正片叠底色和屏幕色应用于模型，可以实时更改色调。
通过使用Cubism 4.2或更高版本的Cubism Native Framework，无需任何追加编码即可应用Cubism Editor上设置的正片叠底色和屏幕色。
关于Cubism Editor上的正片叠底色和屏幕色的设置，请参考Editor手册中的“正片叠底色/屏幕色”。
另外，根据需要进行编码，可以从SDK中操作正片叠底色和屏幕色，也可以进行如下操作。

• 交互式应用正片叠底色/屏幕色
• 应用未在Cubism Editor上设置的正片叠底色/屏幕色
• 禁用Cubism Editor上设置的正片叠底色/屏幕色

以下是该步骤的说明。

处理步骤

按照以下流程处理。

• 正片叠底色/屏幕色覆盖标志设置
• 正片叠底色/屏幕色设置
• 模型绘制

正片叠底色/屏幕色覆盖标志设置

首先，将正片叠底色/屏幕色覆盖标志设置为true。默认为false。

model->GetModel()->SetOverwriteFlagForMultiplyColors(true); // 正片叠底色覆盖标志
model->GetModel()->SetOverwriteFlagForScreenColors(true); // 屏幕色覆盖标志

void SetOverwriteFlagForMultiplyColors(csmBool value)和void SetOverwriteFlagForScreenColors(csmBool value)在Framework的CubismModel类中定义。
Cubism SDK for Native的范例项目定义了一个LAppModel类，以CubismModel作为操作模型的基类，上述代码中的model就是LAppModel类。
它以GetModel()为中介从LAppModel类调用CubismModel类的函数。

正片叠底色/屏幕色设置

定义正片叠底色和屏幕色，并在模型中设置它们。
在下面的代码中，它是对所有Drawable设置红色为正片叠底色，设置绿色为屏幕色时的设置值。
RGBA可用作设置颜色。

for (Csm::csmUint32 i = 0; i < model->GetModel()->GetDrawableCount(); i++)
{
  Csm::Rendering::CubismRenderer::CubismTextureColor multiplyColor; // 正片叠底色
  multiplyColor.R = 1.0f;
  multiplyColor.G = 0.5f;
  multiplyColor.B = 0.5f;
  multiplyColor.A = 1.0f;
  Csm::Rendering::CubismRenderer::CubismTextureColor screenColor; // 屏幕色
  screenColor.R = 0.0f;
  screenColor.G = 0.5f;
  screenColor.B = 0.0f;
  screenColor.A = 1.0f;
  model->GetModel()->SetMultiplyColor(i, multiplyColor);
  model->GetModel()->SetScreenColor(i, screenColor);
}

正片叠底色/屏幕色应用之前

应用红色作为正片叠底色、绿色作为屏幕色后

首先，关于由模型的DrawableCount进行循环处理的部位，正片叠底色和屏幕色处理每一帧都由所有的Drawable进行。

Csm::Rendering::CubismRenderer::CubismTextureColor multiplyColor; // 正片叠底色
multiplyColor.R = 1.0f;
multiplyColor.G = 1.0f;
multiplyColor.B = 1.0f;
multiplyColor.A = 1.0f;
Csm::Rendering::CubismRenderer::CubismTextureColor screenColor; // 屏幕色
screenColor.R = 0.0f;
screenColor.G = 0.0f;
screenColor.B = 0.0f;
screenColor.A = 1.0f;

模型绘制

model->Draw(projection);

调用Cubism SDK for Native范例项目中原本使用的模型的Draw()函数，通过Cubism Native Framework内部的渲染处理，绘制包含正片叠底色和屏幕色的模型。

其他相关函数

获取正片叠底色/屏幕色覆盖标志

 true优先考虑SDK中设置的颜色信息，false 优先考虑模型的颜色信息。

csmBool GetOverwriteFlagForMultiplyColors() const; // 获取正片叠底色覆盖标志
csmBool GetOverwriteFlagForScreenColors() const; // 获取屏幕色覆盖标志

正片叠底色/屏幕色设置

上面介绍了如何设置Rendering::CubismRenderer::CubismTextureColor作为参数，但也有可以直接设置RGBA的函数。（输入值 0.0～1.0）

void SetMultiplyColor(csmInt32 index, csmFloat32 r, csmFloat32 g, csmFloat32 b, csmFloat32 a = 1.0f); // 正片叠底色设置
void SetScreenColor(csmInt32 index, csmFloat32 r, csmFloat32 g, csmFloat32 b, csmFloat32 a = 1.0f); // 屏幕色设置

正片叠底色和屏幕色的获取

使用CubismTextureColor类型获取各Drawable的正片叠底色和屏幕色。

Rendering::CubismRenderer::CubismTextureColor GetMultiplyColor(csmInt32 index) const;
Rendering::CubismRenderer::CubismTextureColor GetScreenColor(csmInt32 index) const;

参数index将是Drawable索引。

Cubism Native Framework的内部处理

用于表达正片叠底色和屏幕色的Framework的内部处理。
按照以下流程处理。

• 从Cubism Core获取模型正片叠底色/屏幕色
• 使用覆盖标志判断获取的正片叠底色/屏幕色
• 在着色器程序中设置获取的正片叠底色/屏幕色
• 使用标志着色器计算纹理颜色时添加正片叠底色和屏幕色

从Cubism Core获取模型正片叠底色/屏幕色

使用Cubism Core的API从模型中获取所有Drawable的正片叠底色和屏幕色。

Core::csmVector4 CubismModel::GetDrawableMultiplyColor(csmInt32 drawableIndex) const
{
    const Core::csmVector4* multiplyColors = Core::csmGetDrawableMultiplyColors(_model);
    return multiplyColors[drawableIndex];
}

Core::csmVector4 CubismModel::GetDrawableScreenColor(csmInt32 drawableIndex) const
{
    const Core::csmVector4* screenColors = Core::csmGetDrawableScreenColors(_model);
    return screenColors[drawableIndex]; }

Core的API如下。

csmApi const csmVector4* csmCallingConvention csmGetDrawableMultiplyColors(const csmModel* model); // 获取正片叠底色
csmApi const csmVector4* csmCallingConvention csmGetDrawableScreenColors(const csmModel* model); // 获取屏幕色

当CubismModel类原始化时，所有的Drawable都被获取并存储在成员数组中。
在SDK端设置正片叠底色和屏幕色时，在SetOverwriteFlagForMultiplyColors()和 SetOverwriteFlagForScreenColors()中设置为true，然后用 SetMultiplyColor()和SetScreenColor()覆盖成员数组。