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

Cleaner event. More...

+ Inheritance diagram for Castor3D::CleanupEvent< T >:
+ Collaboration diagram for Castor3D::CleanupEvent< T >:

Public Member Functions

 CleanupEvent (T &p_object)
 Constructor. More...
 
 ~CleanupEvent ()
 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 T>
class Castor3D::CleanupEvent< T >

Cleaner event.

Author
Sylvain DOREMUS
Date
24/04/2013
Version
0.7.0
Remarks
Cleans up the member given when constructed.

Constructor & Destructor Documentation

◆ CleanupEvent()

template<class T >
Castor3D::CleanupEvent< T >::CleanupEvent ( T &  p_object)
inline

Constructor.

Parameters
[in]p_objectThe object to cleanup

◆ ~CleanupEvent()

template<class T >
Castor3D::CleanupEvent< T >::~CleanupEvent ( )
inline

Destructor.

Member Function Documentation

◆ Apply()

template<class T >
virtual bool Castor3D::CleanupEvent< T >::Apply ( )
inlinevirtual

Applies the event.

Remarks
Cleans the object up
Returns
true if the event was applied successfully

Implements Castor3D::FrameEvent.


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