Logging

Module description

This section describes the functions and enumerations provided for logging messages from HumanIK.

For an overview, see ~{ Logging Debug Messages }~

Enumerations

enum  HIKLoggingLevel {
  HIKNone = 0, HIKError = 1 << 0, HIKMessage = 1 << 2, HIKCallstack = 1 << 3,
  HIKStacksize = 1 << 4, HIKLimits = 1 << 5, HIKNone = 0, HIKError = 1 << 0,
  HIKMessage = 1 << 2, HIKCallstack = 1 << 3, HIKStacksize = 1 << 4, HIKLimits = 1 << 5
}
 Lists the possible logging levels that you can set for HumanIK. More...
 

Functions

void HIKSetLoggingLevel (int pLogging)
 Set the logging level for HumanIK. More...
 

Enumeration Type Documentation

Lists the possible logging levels that you can set for HumanIK.

See HIKSetLoggingLevel().

Enumerator
HIKNone 

If specified on its own, this flag disables the generation of all log messages.

If specified in conjunction with any other logging level listed below, this flag has no effect.

HIKError 

Configures HumanIK to log severe problems with your character setup.

For example, if your HIKCharacter is missing one or more required Nodes.

HIKMessage 

Configures HumanIK to log informational messages that may indicate problems with your character setup.

For example, if your character's arms do not appear to be aligned along the X axis.

HIKCallstack 

Configures HumanIK to log its call stack.

HIKStacksize 

Configures HumanIK to log the size of its call stack.

HIKLimits 

Configures HumanIK to log the Degrees of Freedom set for each character when its geometry is finalized through a call to the HIKCharacterizeGeometry function.

HIKNone 

If specified on its own, this flag disables the generation of all log messages.

If specified in conjunction with any other logging level listed below, this flag has no effect.

HIKError 

Configures HumanIK to log severe problems with your character setup.

For example, if your HIKCharacter is missing one or more required Nodes.

HIKMessage 

Configures HumanIK to log informational messages that may indicate problems with your character setup.

For example, if your character's arms do not appear to be aligned along the X axis.

HIKCallstack 

Configures HumanIK to log its call stack.

HIKStacksize 

Configures HumanIK to log the size of its call stack.

HIKLimits 

Configures HumanIK to log the Degrees of Freedom set for each character when its geometry is finalized through a call to the HIKCharacterizeGeometry function.

Definition at line 486 of file hikutils.h.

487 {
490  HIKNone = 0,
493  HIKError = 1 << 0,
496  HIKMessage = 1 << 2,
497  HIKCallstack = 1 << 3,
498  HIKStacksize = 1 << 4,
499 
501  HIKLimits = 1 << 5
502 };
Configures HumanIK to log informational messages that may indicate problems with your character setup...
Definition: hikutils.h:496
Configures HumanIK to log the size of its call stack.
Definition: hikutils.h:498
Configures HumanIK to log its call stack.
Definition: hikutils.h:497
If specified on its own, this flag disables the generation of all log messages.
Definition: hikutils.h:490
Configures HumanIK to log the Degrees of Freedom set for each character when its geometry is finalize...
Definition: hikutils.h:501
Configures HumanIK to log severe problems with your character setup.
Definition: hikutils.h:493

Function Documentation

void HIKSetLoggingLevel ( int  pLogging)

Set the logging level for HumanIK.

Parameters
pLoggingLogging level, expressed as a bit mask built from the HIKLoggingLevel enumeration. To enable multiple types of log messages, concatenate them using the | operator (bitwise OR).