Castor3D  ..
Public Member Functions | List of all members
Castor3D::FunctorEvent< Functor > Class Template Reference

Functor event. More...

+ Inheritance diagram for Castor3D::FunctorEvent< Functor >:
+ Collaboration diagram for Castor3D::FunctorEvent< Functor >:

Public Member Functions

 FunctorEvent (eEVENT_TYPE p_type, Functor p_functor)
 Constructor. More...
 
 ~FunctorEvent ()
 Destructor. More...
 
virtual bool Apply ()
 Applies the event. More...
 
- Public Member Functions inherited from Castor3D::FrameEvent
C3D_API FrameEvent (eEVENT_TYPE p_type)
 Constructor. More...
 
C3D_API FrameEvent (FrameEvent const &p_object)
 Copy constructor. More...
 
C3D_API FrameEvent (FrameEvent &&p_object)
 Move constructor. More...
 
C3D_API FrameEventoperator= (FrameEvent const &p_object)
 Copy assignment operator. More...
 
C3D_API FrameEventoperator= (FrameEvent &&p_object)
 Move assignment operator. More...
 
virtual C3D_API ~FrameEvent ()
 Destructor. More...
 
eEVENT_TYPE GetType ()
 Retrieves the event type. More...
 

Additional Inherited Members

- Protected Attributes inherited from Castor3D::FrameEvent
eEVENT_TYPE m_type
 The event type. More...
 

Detailed Description

template<class Functor>
class Castor3D::FunctorEvent< Functor >

Functor event.

Author
Sylvain DOREMUS
Date
24/04/2013
Version
0.7.0
Remarks
Executes a function when processed

Constructor & Destructor Documentation

◆ FunctorEvent()

template<class Functor >
Castor3D::FunctorEvent< Functor >::FunctorEvent ( eEVENT_TYPE  p_type,
Functor  p_functor 
)
inline

Constructor.

Parameters
[in]p_typeThe event type
[in]p_functorThe functor to execute

◆ ~FunctorEvent()

template<class Functor >
Castor3D::FunctorEvent< Functor >::~FunctorEvent ( )
inline

Destructor.

Member Function Documentation

◆ Apply()

template<class Functor >
virtual bool Castor3D::FunctorEvent< Functor >::Apply ( )
inlinevirtual

Applies the event.

Remarks
Executes the function
Returns
true if the event was applied successfully

Implements Castor3D::FrameEvent.


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