RixEventCallbacks.h

Go to the documentation of this file.

/*
# ------------------------------------------------------------------------------
#
# Copyright (c) 2020 Pixar. All rights reserved.
#
# The information in this file (the "Software") is provided for the exclusive
# use of the software licensees of Pixar ("Licensees").  Licensees have the
# right to incorporate the Software into other products for use by other
# authorized software licensees of Pixar, without fee. Except as expressly
# permitted herein, the Software may not be disclosed to third parties, copied
# or duplicated in any form, in whole or in part, without the prior written
# permission of Pixar.
#
# The copyright notices in the Software and this entire statement, including the
# above license grant, this restriction and the following disclaimer, must be
# included in all copies of the Software, in whole or in part, and all permitted
# derivative works of the Software, unless such copies or derivative works are
# solely in the form of machine-executable object code generated by a source
# language processor.
#
# PIXAR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL PIXAR BE
# LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
# OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  IN NO CASE WILL
# PIXAR'S TOTAL LIABILITY FOR ALL DAMAGES ARISING OUT OF OR IN CONNECTION WITH
# THE USE OR PERFORMANCE OF THIS SOFTWARE EXCEED $50.
#
# Pixar
# 1200 Park Ave
# Emeryville CA 94608
#
# ------------------------------------------------------------------------------
*/

/*
 * Version 0.2
 *
 * This is a preview release and is not supported.  This API will change substantially
 * in the next release of RenderMan.  Names, namespaces, methods, parameters, types,
 * enums, and the structure of the interface are expected to change.
 *
 */

#ifndef RixEventCallbacks_h
#define RixEventCallbacks_h

#include "RixInterfaces.h"

class RixEventCallbacks : public RixInterface
{
public:
    enum Event
    {
        k_Scene,      
        k_Render,     
        k_Progress,   
        k_Iteration,  
    };
    typedef void (*Callback)(Event event, void const* eventData, void* clientData);

    virtual bool RegisterCallback(Event event, Callback cb, void* clientData) = 0;

    virtual bool UnregisterCallback(Event event, Callback cb, void* clientData) = 0;

protected:
    RixEventCallbacks() : RixInterface(1)
    {}
};

#endif  // RixEventCallbacks_h