Destructors

Module description

This section describes the functions used to destroy HIK objects.

For details on memory management when destroying these objects, see ~{ HumanIK Objects and Memory Management }~.

For details on using these functions in the context of closing HumanIK, see ~{ Cleanup }~.

Functions

void HIKPropertySetStateDestroy (HIKPropertySetState *pPropertySetState, HIKFree pFree)
 Destroy HIKPropertySetState pPropertySetState. More...
 
void HIKCharacterDestroy (HIKCharacter *pCharacter, HIKFree pFree)
 Destroy HIKCharacter pCharacter. More...
 
void HIKEffectorSetStateDestroy (HIKEffectorSetState *pESetState, HIKFree pFree)
 Destroy HIKEffectorSetState pESetState. More...
 
void HIKCharacterStateDestroy (HIKCharacterState *pCharacterState, HIKFree pFree)
 Destroy HIKCharacterState pCharacterState. More...
 
void HIKCreatureDestroy (HIKCreature *pCreature, HIKFree pFree)
 Destroy HIKCreature pCreature. More...
 
void HIKCreatureEffectorSetStateDestroy (HIKCreatureEffectorSetState *pEffectorSetState, HIKFree pFree)
 Destroy HIKCreatureEffectorSetState pEffectorSetState. More...
 
void HIKCreatureStateDestroy (HIKCreatureState *pCreatureState, HIKFree pFree)
 Destroy HIKCreatureState pCreatureState. More...
 

Function Documentation

void HIKCharacterDestroy ( HIKCharacter pCharacter,
HIKFree  pFree 
)

Destroy HIKCharacter pCharacter.

Parameters
pCharacterCharacter to destroy.
pFreePointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.
+ Examples:
void HIKCharacterStateDestroy ( HIKCharacterState pCharacterState,
HIKFree  pFree 
)
void HIKCreatureDestroy ( HIKCreature pCreature,
HIKFree  pFree 
)

Destroy HIKCreature pCreature.

Parameters
pCreatureCharacter to destroy.
pFreePointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.
void HIKCreatureEffectorSetStateDestroy ( HIKCreatureEffectorSetState pEffectorSetState,
HIKFree  pFree 
)

Destroy HIKCreatureEffectorSetState pEffectorSetState.

Parameters
pEffectorSetStateHIKCreatureEffectorSetState to destroy.
pFreePointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.
void HIKCreatureStateDestroy ( HIKCreatureState pCreatureState,
HIKFree  pFree 
)

Destroy HIKCreatureState pCreatureState.

Parameters
pCreatureStateHIKCreatureState to destroy.
pFreePointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.
void HIKEffectorSetStateDestroy ( HIKEffectorSetState pESetState,
HIKFree  pFree 
)

Destroy HIKEffectorSetState pESetState.

Parameters
pESetStateHIKEffectorSetState to destroy.
pFreePointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.
+ Examples:
void HIKPropertySetStateDestroy ( HIKPropertySetState pPropertySetState,
HIKFree  pFree 
)

Destroy HIKPropertySetState pPropertySetState.

Parameters
pPropertySetStateHIKPropertySetState to destroy.
pFreePointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.
+ Examples: