Logging Debug Messages

Retrieving debug messages

HumanIK sends its log messages to the following locations:

• The output window of a debugging application, such as Microsoft Visual Studio.
• A plain-text file, humaniklog.txt, generated by HumanIK in your application directory.

Setting up logging

To set up HumanIK to generate log messages:

1. Link your application against the Verbose library of HumanIK, located at libs\<platform>\verbose\humanik.lib, can generate log messages. The Release library does not generate any log messages.

   Note that this library is currently available only on Windows platforms.

2. Include the hikutils.h file in your application.
3. Call the HIKSetLoggingLevel() function to set the level of messages you want HumanIK to log. You must specify a bit mask that includes any one or more of the elements from the HIKLoggingLevel enumeration. To enable multiple types of log messages, concatenate them using the | operator (bitwise OR).

For example, the following call configures HumanIK to log all errors, informational messages, and the call stack:

HIKSetLoggingLevel (HIKError | HIKMessage | HIKCallstack);

By default, the logging level is set to HIKLoggingLevel::HIKNone, which disables all log messages. It is therefore mandatory to call HIKSetLoggingLevel() in order to receive any messages at all.

Note that only messages of the specified logging levels are printed to the log; no other information is recorded. If, for example, you set the logging level to HIKError, and no errors are detected during your characterization, no messages will be printed to the log. Therefore, if you simply want to test that you have enabled logging correctly, set the logging level to include HIKCallstack.