FbxQueryEvent< QueryT > Class Template Reference

FbxQueryEvent< QueryT > Class Template Reference

#include <fbxqueryevent.h>

Class Description

template<typename QueryT>
class FbxQueryEvent< QueryT >

A query event is something that is emitted by an entity, with the goal of being filled by someone that listen to it.

You can see that like a form that you send to some people. If those people know how to fill the form, they fill it and return it to you with the right information in it. A query event is emitted, and plug-in who are listening to that type of query, fill the data that can be accessed by the query emitter.

Definition at line 27 of file fbxqueryevent.h.

+ Inheritance diagram for FbxQueryEvent< QueryT >:

Public Member Functions

Public interface
 FbxQueryEvent (QueryT *pData)
 Constructor. More...
 
QueryT & GetData () const
 Accessor to a mutable reference to the data. More...
 
- Public Member Functions inherited from FbxEvent< FbxQueryEvent< QueryT > >
virtual ~FbxEvent ()
 Destructor. More...
 
virtual int GetTypeId () const
 Retrieve the event type ID. More...
 
- Public Member Functions inherited from FbxEventBase
virtual ~FbxEventBase ()
 Destructor. More...
 

Friends

class FbxEvent< FbxQueryEvent< QueryT > >
 

Additional Inherited Members

- Static Public Member Functions inherited from FbxEvent< FbxQueryEvent< QueryT > >
static void ForceTypeId (int pTypeId)
 Update the type ID of current event with the given type ID. More...
 
static int GetStaticTypeId ()
 Retrieve the event type ID. More...
 
- Static Protected Member Functions inherited from FbxEventBase
static int GetStaticTypeId (const char *)
 

Constructor & Destructor Documentation

FbxQueryEvent ( QueryT *  pData)
inlineexplicit

Constructor.

Parameters
pDataThe requested data.

Definition at line 37 of file fbxqueryevent.h.

37 :mData(pData){}

Member Function Documentation

QueryT& GetData ( ) const
inline

Accessor to a mutable reference to the data.

Event are usually const and can't be modified by listener. This special type of event can have is content modified via this accessor.

Returns
A mutable reference the requested data.

Definition at line 43 of file fbxqueryevent.h.

43 { return *mData; }

Friends And Related Function Documentation

friend class FbxEvent< FbxQueryEvent< QueryT > >
friend

Definition at line 52 of file fbxqueryevent.h.


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