IRasterEvents.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once
#include "RasterCore.h"

BEGIN_RASTER_NAMESPACE

enum RasterEventType
    {
    RASTER_EVENTTYPE_Modify           = 0,
    RASTER_EVENTTYPE_Create           = 1,
    RASTER_EVENTTYPE_Delete           = 2,
    };

enum RasterFileEventType
    {
    RASTERFILE_EVENTTYPE_PaletteChanged  = 0,
    RASTERFILE_EVENTTYPE_Reload          = 1,
    RASTERFILE_EVENTTYPE_Reloaded        = 2,
    };

enum RasterEventSource
    {
    RASTER_EVENTSOURCE_Action         = 0,
    RASTER_EVENTSOURCE_Undo           = 1,
    RASTER_EVENTSOURCE_Redo           = 2,
    };

enum RasterProgressType
    {
    RASTER_THUMBNAIL_PROGRESSION   = 0,
    RASTER_EXPORT_PROGRESSION      = 1,
    RASTER_DISPLAY_PROGRESSION     = 2,
    RASTER_HISTOGRAM_PROGRESSION   = 3,
    };




/*=================================================================================**/
struct    IRasterEventHandler
{
public:

virtual void _OnRasterAttachmentEvent   (DgnRasterCP afterRaster, DgnRasterCP beforeRaster, RasterEventType type, RasterEventSource source) {}

virtual void _OnRasterFileEvent         (DgnRasterCPArray const& rasterArray, RasterFileEventType type, RasterEventSource source) {}

virtual void _OnRasterCleanup           (DgnRasterR raster) {}

virtual void _OnRasterSisterFileCreated (DgnDocumentCR rasterFile, WCharCP sisterFilename) {}

}; // IRasterEventHandler

/*=================================================================================**/
struct    IRasterProgressListener
{
public:
    virtual void    _OnProgress(UInt64 actualCount, UInt64 totalCount, double elapsedTime, double estimatedTotalTime, bool& shouldStop)     { shouldStop=false; }
    virtual void    _OnLifeSignal(bool& shouldStop)                                                                                         { shouldStop=false; }
}; // IRasterProgressListener





//=======================================================================================
//=======================================================================================
struct RasterEventManager : DgnHost::IHostObject
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

/*---------------------------------------------------------------------------------**/
RASTERCORE_EXPORT void       AddEventHandler (IRasterEventHandler& handler);

/*---------------------------------------------------------------------------------**/
RASTERCORE_EXPORT void       RemoveEventHandler (IRasterEventHandler& handler);

/*---------------------------------------------------------------------------------**/
RASTERCORE_EXPORT void       AddProgressListener (IRasterProgressListener& handler,RasterProgressType type);

/*---------------------------------------------------------------------------------**/
RASTERCORE_EXPORT void       RemoveProgressListener (IRasterProgressListener& handler,RasterProgressType type);


RASTERCORE_EXPORT static RasterEventManager& GetManager ();

}; // RasterEventManager

END_RASTER_NAMESPACE