HPS::Stream::ImportEventHandler Class Reference

#include <hps.h>

Public Member Functions

virtual bool Handle (ImportEvent *in_event)
 

Detailed Description

The ImportEventHandler class is the base class for user-defined ImportEvent handlers. If your ImportEventHandler elects not to import incoming geometry, then subsequent operations on that geometry along with follow-up attributes (priority, user-data, etc...) will throw an InvalidObjectException.

Member Function Documentation

◆ Handle()

virtual bool HPS::Stream::ImportEventHandler::Handle ( ImportEvent in_event)
virtual

The handler function for Stream ImportEvents. Override this function to process the ImportEvent to suit your needs. This function is called synchronously as data is imported by Stream; Stream import will be paused until this function returns.

Parameters
in_eventA pointer to the ImportEvent representing the impending change to the database.
Returns
A bool that specifies if the database change indicated by in_event should be applied. true means that the change will be applied to the database; false means that no change will be made.

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