Castor3D::FrameEvent Class Reference

The interface which represents a frame event. More...

Inheritance diagram for Castor3D::FrameEvent:

Public Member Functions
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 FrameEvent &	operator= (FrameEvent const &p_object)
	Copy assignment operator. More...
C3D_API FrameEvent &	operator= (FrameEvent &&p_object)
	Move assignment operator. More...
virtual C3D_API	~FrameEvent ()
	Destructor. More...
virtual C3D_API bool	Apply ()=0
	Applies the event. More...
eEVENT_TYPE	GetType ()
	Retrieves the event type. More...

Protected Attributes
eEVENT_TYPE	m_type
	The event type. More...

Detailed Description

The interface which represents a frame event.

Author

Sylvain DOREMUS

Date

03/03/2010

Version

0.1

Remarks

Basically a frame event has a eEVENT_TYPE to know when it must be applied.
It can be applied, so the function must be implemented by children classes

Constructor & Destructor Documentation

FrameEvent() [1/3]

C3D_API Castor3D::FrameEvent::FrameEvent

(

eEVENT_TYPE

p_type

)

Constructor.

Parameters

[in]

p_type

The event type

FrameEvent() [2/3]

C3D_API Castor3D::FrameEvent::FrameEvent

(

FrameEvent const &

p_object

)

Copy constructor.

Parameters

[in]

p_object

The object to copy

FrameEvent() [3/3]

C3D_API Castor3D::FrameEvent::FrameEvent

(

FrameEvent &&

p_object

)

Move constructor.

Parameters

[in]

p_object

The object to move

~FrameEvent()

virtual C3D_API Castor3D::FrameEvent::~FrameEvent ( )

virtual

Destructor.

Member Function Documentation

Apply()

virtual C3D_API bool Castor3D::FrameEvent::Apply ( )

pure virtual

Applies the event.

Remarks

Must be implemented by children classes

Returns

true if the event was applied successfully

Implemented in Castor3D::InitialiseEvent< T >, Castor3D::CleanupEvent< T >, Castor3D::FunctorEvent< Functor >, Castor3D::ResizeWindowEvent, and Castor3D::SubdivisionFrameEvent.

GetType()

eEVENT_TYPE Castor3D::FrameEvent::GetType ( )

inline

Retrieves the event type.

Returns

The event type

References m_type.

operator=() [1/2]

C3D_API FrameEvent& Castor3D::FrameEvent::operator=

(

FrameEvent const &

p_object

)

Copy assignment operator.

Parameters

[in]

p_object

The object to copy

Returns

A reference to this object

operator=() [2/2]

C3D_API FrameEvent& Castor3D::FrameEvent::operator=

(

FrameEvent &&

p_object

)

Move assignment operator.

Parameters

[in]

p_object

The object to move

Returns

A reference to this object

Member Data Documentation

m_type

eEVENT_TYPE Castor3D::FrameEvent::m_type

protected

The event type.

Referenced by GetType().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/FrameEvent.hpp