Unreal之Houdini Api 学习

楚一帆 · 发表于 2021-3-11 10:07

20210226
目前游戏领域中，程序化内容生产（Procedural Content Generation， PCG）的比重越来越重，其中Houdini工具的运用占据了主要比例。目前网上很多资料都是偏向于美术侧，本文着重讲一些程序侧方向，主要是平时学习的记录。
Houdini Api地址：https://www.sidefx.com/docs/hengine17.5/index.html。
一. 版本问题

Houdini 对于版本要求很高，在项目中一般我们都是要求每个人安装的版本都必须一致。在学习过程中，需要区分下Houdini 软件版本和api版本，一面误导。
其中Houdini软件版本指的是我们实际安装软件的版本，一般在软件icon上就能看到。例如如下所示：
Houdini Api 版本则只能通过代码中查看，查看位置：HAPI_Version.h中：

// The two components of the Houdini Engine (marketed) version.
#define HAPI_VERSION_HOUDINI_ENGINE_MAJOR 3
#define HAPI_VERSION_HOUDINI_ENGINE_MINOR 2

复制代码

这里指定了我当前使用的Houdini Api 版本是3.2。同时，在这一个文件中也记录了对应的软件版本：

// The three components of the Houdini version that HAPI is
// expecting to compile against.
#define HAPI_VERSION_HOUDINI_MAJOR 17
#define HAPI_VERSION_HOUDINI_MINOR 5
#define HAPI_VERSION_HOUDINI_BUILD 391
#define HAPI_VERSION_HOUDINI_PATCH 0

复制代码

另一方面，Houdini api 库提供函数HAPI_GetEnvInt()用来获取版本内容，通过给定HAPI_EnvIntType字段可获取到特定版本信息，类似代码如下：

int32 RunningMajor = 0;
int32 RunningMinor = 0;
int32 RunningBuild = 0;
int32 RunningPatch = 0;
if ( FHoudiniApi::IsHAPIInitialized() )
{
const HAPI_Session * Session = FHoudiniEngine::Get().GetSession();
// Retrieve version numbers for running Houdini.
FHoudiniApi::GetEnvInt( HAPI_ENVINT_VERSION_HOUDINI_MAJOR, &RunningMajor );
FHoudiniApi::GetEnvInt( HAPI_ENVINT_VERSION_HOUDINI_MINOR, &RunningMinor );
FHoudiniApi::GetEnvInt( HAPI_ENVINT_VERSION_HOUDINI_BUILD, &RunningBuild );
FHoudiniApi::GetEnvInt( HAPI_ENVINT_VERSION_HOUDINI_PATCH, &RunningPatch );
}

复制代码

Ps：由于本地是Unreal版本的Houdini 库，与原生Houdini库存在一些差异，但并不影响理解，因此就手动改代码了。
二. 文件介绍

Houdini 安装之后，会提供Houdini Api库文件（同时会提供unity、unreal、maya等平台库文件）。路径参考如下：

C:\Program Files\Side Effects Software\Houdini 17.5.391\toolkit\include\HAPI

复制代码

库文件包含：

HAPI.h // 声明所有API格式
HAPI_Common.h // 定义用到结构和枚举类
HAPI_Version.h // 版本信息
HAPI_Helpers.h // 声明一些用来初始化结构的函数
HAPI_API.h // 链接库和其他一些定义

复制代码

三. 对字符串的处理

通常情况下，如果我们要从houdini获取一个字符串，比方获取一个HAD参数面板的一个属性：字段为file的路径。Houdini并不是直接返回一个string，而是通过HAPI_StringHandle形式。通过HAPI_StringHandle，我们会获取到该string的id，然后根据这个id获取到具体的string。
HAPI_StringHandle的定义如下：

// HAPI_Common.h
/// Use this with HAPI_GetString() to get the value.
/// See @ref HAPI_Fundamentals_Strings.
typedef int HAPI_StringHandle;

复制代码

下面给出2个具体通过HAPI_StringHandle过得到string的方案。
方案一：HAPI_GetStringBufLength() + HAPI_GetString()
通过HAPI_GetStringBufLength获取到字符串长度（buffer），然后HAPI_GetString()获取。类似代码如下：

int buffer_length;
HAPI_GetStatusStringBufLength(
nullptr, id, HAPI_STATUSVERBOSITY_ERRORS, &buffer_length );
char * buf = new char[ buffer_length ];
HAPI_GetStatusString( nullptr, id, buf );
std::string result( buf ); // result 即为字符串
delete[] buf;

复制代码

Ps：这点代码是由官方提供，暂时未经过测试（想来应该也是能用的），HAPI_GetStatusStringBufLength 第三个参数还需要测试一下。
方案二：FHoudiniEngineString函数
FHoudiniEngineString是Houdini Api中Unreal引擎侧的一个类，具体路径位置在HoudiniEngineString.h文件中，通过提供的toString方法，可以获得到给定string id的string值。具体代码类似如下：

// 获取csv路径
HAPI_StringHandle MatNamesValueHandle;
HAPI_Result result;
FString csvPath = &#34;&#34;;
result = FHoudiniApi::GetParmStringValue(
FHoudiniEngine::Get().GetSession(), NodeId, TCHAR_TO_UTF8(*(FString(&#34;file&#34;))), 0, 0, &MatNamesValueHandle);
FHoudiniEngineString(MatNamesValueHandle).ToFString(csvPath);

复制代码

GetParmStringValue函数根据给定的参数，获取到属性面板对应参数。
四. 获取Houdini 错误信息

基本上所有Houdini函数的返回结果都是HAPI_Result，通过HAPI_Result可以得到函数具体结果，其中除了HAPI_RESULT_SUCCESS意外，其他均是错误信息。因此有些时候我们很有必要得到错误信息内容。通过以下函数，我们可以获取到具体错误信息：

static std::string get_last_error()
{
int buffer_length;
HAPI_GetStatusStringBufLength(
nullptr, HAPI_STATUS_CALL_RESULT, HAPI_STATUSVERBOSITY_ERRORS, &buffer_length );
char * buf = new char[ buffer_length ];
HAPI_GetStatusString( nullptr, HAPI_STATUS_CALL_RESULT, buf );
std::string result( buf );
delete[] buf;
return result;
}

复制代码

五. 总结

暂时第一部分Houdini学习就到这里为止，都是一些比较基本的内容，重在抛砖引玉。下个内容，给出一些关于创建节点和Houdini交互的相关内容吧。

		自动登录	找回密码
密码			立即注册

Unreal之Houdini Api 学习

本帖子中包含更多资源