Main Page Class List Class Members

# Nv::Blast::TkEvent Struct Reference

`#include <NvBlastTkEvent.h>`

List of all members.

## Public Types
## Public Member Functions
template<typename T >
const T * | getPayload () const
## Public Attributes
const void * | payload
| Type-dependent payload data.
Type | type
| See the Type enum, above.

## Detailed Description

Event data dispatched to TkEventListener objects. The user may implement the abstract TkEventListener interface and pass the listener object to a BlastTk object which dispatches events. (See for example TkFamily.)

## Member Enumeration Documentation

enum Nv::Blast::TkEvent::Type

Enumerator:

  Split | Sent when a TkActor is split. See TkSplitEvent.
  FractureCommand | Sent when a TkActor generated fracture commands using TkActor::generateFracture.
  FractureEvent | Sent when a TkActor is fractured using TkActor::applyFracture.
  JointUpdate | Sent when TkJoints change their attachment state. See TkJointUpdateEvent.
  TypeCount |

## Member Function Documentation

template<typename T >

const T* Nv::Blast::TkEvent::getPayload | ( |  | ) | const`[inline]`

Casts the payload data into its type-dependent format.

Returns:
  the payload for an event of type T

## Member Data Documentation

const void* Nv::Blast::TkEvent::payload

Type-dependent payload data.

Type Nv::Blast::TkEvent::type

See the Type enum, above.

The documentation for this struct was generated from the following file:

- sdk/toolkit/include/NvBlastTkEvent.h