Scene Fusion 2 API Reference
KS::ksEvent< Arguments > Class Template Reference

#include <ksEvent.h>

Public Types

typedef std::function< void(Arguments...)> Handler
 
typedef std::shared_ptr< ksEvent< Arguments... > > SPtr
 
typedef std::weak_ptr< ksEvent< Arguments... > > WPtr
 

Public Member Functions

 ksEvent (Handler callback)
 
virtual ~ksEvent ()
 
bool IsExpired ()
 

Static Public Member Functions

static SPtr CreateSPtr (Handler callback)
 

Friends

template<typename ... T>
class EventSystem
 

Detailed Description

template<typename ... Arguments>
class KS::ksEvent< Arguments >

Tracks an event handler and provides friend access to the EventSystem

Constructor & Destructor Documentation

◆ ksEvent()

template<typename ... Arguments>
KS::ksEvent< Arguments >::ksEvent ( Handler  callback)
inline

Constructor

Parameters
std::function<void(Arguments...)>callback

◆ ~ksEvent()

template<typename ... Arguments>
virtual KS::ksEvent< Arguments >::~ksEvent ( )
inlinevirtual

Destructor

Member Function Documentation

◆ CreateSPtr()

template<typename ... Arguments>
static SPtr KS::ksEvent< Arguments >::CreateSPtr ( Handler  callback)
inlinestatic

Shared pointer constructor

Parameters
std::function<void(Arguments...)>callback
Returns
std::shared_ptr<ksEvent<Arguments...>>

◆ IsExpired()

template<typename ... Arguments>
bool KS::ksEvent< Arguments >::IsExpired ( )
inline

Check if the EventSystem that created this event has been destroyed.

Returns
bool

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