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	HIKCharacterDestroy (HIKCharacter *pCharacter, HIKFree pFree)
	Destroy HIKCharacter pCharacter. More...
void	HIKCharacterStateDestroy (HIKCharacterState *pCharacterState, HIKFree pFree)
	Destroy HIKCharacterState pCharacterState. More...
void	HIKEffectorSetStateDestroy (HIKEffectorSetState *pESetState, HIKFree pFree)
	Destroy HIKEffectorSetState pESetState. More...
void	HIKPropertySetStateDestroy (HIKPropertySetState *pPropertySetState, HIKFree pFree)
	Destroy HIKPropertySetState pPropertySetState. More...

Function Documentation

void HIKCharacterDestroy	(	HIKCharacter *	pCharacter,
		HIKFree	pFree
	)

Destroy HIKCharacter pCharacter.

Parameters

pCharacter	Character to destroy.
pFree	Pointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.

void HIKCharacterStateDestroy	(	HIKCharacterState *	pCharacterState,
		HIKFree	pFree
	)

Destroy HIKCharacterState pCharacterState.

Parameters

pCharacterState	HIKCharacterState to destroy.
pFree	Pointer 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

pESetState	HIKEffectorSetState to destroy.
pFree	Pointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.

void HIKPropertySetStateDestroy	(	HIKPropertySetState *	pPropertySetState,
		HIKFree	pFree
	)

Destroy HIKPropertySetState pPropertySetState.

Parameters

pPropertySetState	HIKPropertySetState to destroy.
pFree	Pointer to a memory de-allocation function. If you do not have a custom memory de-allocation function, use &free.