IFD/IFD_StreamEvent.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        IFD_StreamEvent.h ( IFD Library, C++)
 *
 * COMMENTS:    Event notifiers for changes to IPR trees.
 *
 *      The stream events are sent out by different classes at different (and
 *      sometimes unexpected) times.
 *
 *      CREATED
 *              Called by IFD_Output when an IFD_RenderStream is created
 *      DELETED
 *              Called in the destructor of the stream.  The destructor is
 *              called in several different places:
 *                 - File streams will be destroyed at the end of the frame
 *                 - Process streams (in foreground) will be destroyed at the
 *                   end of frame.
 *                 - Process streams (in background) may be destroyed at the
 *                   end of frame if the render was extremely fast.  Otherwise,
 *                   the stream can only be deleted when
 *                   IFD_RenderStream::pruneList() is called (which occurs in
 *                   various places throughout the code.
 *      KILLED
 *      PAUSED
 *      RESTART 
 *              Called when the method on the IFD_RenderStream is called.
 */

#ifndef __IFD_StreamEvent__
#define __IFD_StreamEvent__

#include "IFD_API.h"

#include <UT/UT_Notifier.h>

class IFD_RenderStream;

class IFD_API IFD_StreamEvent
{
public:
    enum IFD_StreamEventType
    {
        IFD_STREAM_CREATED,     // IFD_Output has created a stream
        IFD_STREAM_DELETED,     // Stream is about to be deleted
        IFD_STREAM_KILLED,      // When stream's process is killed
        IFD_STREAM_PAUSED,      // When stream's process is paused
        IFD_STREAM_RESTARTED    // When stream's process is restarted
    };

    IFD_StreamEvent(IFD_StreamEventType type, IFD_RenderStream *stream)
        : myEventType(type), myStream(stream) {}

    IFD_StreamEventType  myEventType;
    IFD_RenderStream    *myStream;
};

#endif

---