FBX C++ API Reference
FbxEmitter Class Reference

#include <fbxemitter.h>

Class Description

Base class to emit event with the specified event type.

The event type could be a specific class which derived from FbxEvent. Please read FbxEmitter::Emit() for more details. Event emitter contains a list of event handlers. FBX object could be used as emitter, since FbxObject is derived from FbxEmitter. Before using emitter to emit an event, one or more event handlers must be added to the handlers list of current emitter. In other words, it's "bind event handlers to emitter". There are two ways to bind event handlers to emitter.

  • 1. If you already got an event handler and would like to bind it to current emitter, please call FbxEmitter::AddListener().
  • 2. Or you can create an event listener first and then call FbxListener::Bind(). It will create an event handler automatically and bind the handler to the specified emitter. It's similar to unbind or remove an even handler. For more details,
    See also
    FbxEmitter::RemoveListener()
    FbxListener::Unbind()
    Remarks
    An object(emitter) can emit a certain type of event, the plug-in(listener) who are listening to that type of event, will receive a signal and take action to process the event data.
    The whole process of event is:
  • 1. Create an emitter and a listener, then bind them together via the same event handler.
  • 2. Emitter can emit an event at certain conditions. The event could be handled by event handler.
  • 3. Once an event is emitted, the listener to this event will receive a signal.
  • 4. And then the listener could process the event data according to the types of event, by calling event handler.
    Note
    The event data is process by the callback function of event handler.
    See also
    FbxListener FbxEventHandler FbxEvent FbxEventBase

Definition at line 49 of file fbxemitter.h.

+ Inheritance diagram for FbxEmitter:

Public Member Functions

void AddListener (FbxEventHandler &pHandler)
 Add the specified event handler to current emitter list. More...
 
void RemoveListener (FbxEventHandler &pHandler)
 Remove the specified event handler from current emitter list. More...
 
template<typename EventType >
void Emit (const EventType &pEvent) const
 Emit an event with the specified the event type. More...
 

Member Function Documentation

◆ AddListener()

void AddListener ( FbxEventHandler pHandler)

Add the specified event handler to current emitter list.

Parameters
pHandlerThe event handler will be added to the handlers list of current emitter.

◆ RemoveListener()

void RemoveListener ( FbxEventHandler pHandler)

Remove the specified event handler from current emitter list.

Parameters
pHandlerThe event handler will be removed from the handlers list of current emitter.

◆ Emit()

void Emit ( const EventType &  pEvent) const
inline

Emit an event with the specified the event type.

One the event is emitted, the listener to this event will receive a signal.

Parameters
pEventSpecify the event type to emit. Could be a specific class which derived from FbxEvent, such as FbxObjectPropertyChanged.
See also
FbxEventBase FbxObjectPropertyChanged FbxEventReferencedDocument FbxEventPostExport
FbxEventPostImport FbxEventPreExport FbxEventPreImport FbxEventPopulateSystemLibrary

Definition at line 64 of file fbxemitter.h.

65  {
66  if( !mData ) return;
67  EventHandlerList::iterator itBegin = mData->mEventHandlerList.Begin();
68  EventHandlerList::iterator itEnd = mData->mEventHandlerList.End();
69  for( EventHandlerList::iterator it = itBegin; it != itEnd; ++it )
70  {
71  if ((*it).GetHandlerEventType() == pEvent.GetTypeId())
72  {
73  (*it).FunctionCall(pEvent);
74  }
75  }
76  }

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