RixRiCtl.h

Go to the documentation of this file.

/*
# ------------------------------------------------------------------------------
#
# Copyright (c) 2021 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
#
# ------------------------------------------------------------------------------
*/

#ifndef RixRiCtl_h
#define RixRiCtl_h

#include "RixInterfaces.h"              // for RixInterface
#include "ri.h"                         // for RtString, RtBoolean, etc

class Ri;

enum RixRifEditMode
{
    k_DisallowRifEdits = 0,
    k_AllowRifEdits = 1,
    k_DisallowRifDeleteEdits = 2
};

class RixRiCtl : public RixInterface
{
public:


    virtual int PRManBegin(int argc, char* argv[]) = 0;

    virtual int PRManGo() = 0;

    virtual int PRManEnd() = 0;

    virtual Ri* GetRiCtx() = 0;


    virtual void Flush(
        RtString marker,
        RtBoolean synchronous,
        RtUString flushmode) = 0;

    virtual int GetProgress() = 0;
    
    virtual int SetWantsProgress(int wantsProgress) = 0;

    virtual void ProcessCallbacks() = 0;

    virtual void Option(RtString name, RtPointer value) = 0;

    virtual void SetRifEditMode(RixRifEditMode m) = 0;

    virtual void RifInit(int argc, const char *argv[]) = 0;

    // Tell prman a texture is dirty and needs to flush it from the texture cache.
    virtual void InvalidateTexture(RtUString const name) = 0;


    virtual int PRManSystemBegin(int argc, const char* argv[]) = 0;

    virtual int PRManRenderBegin(int argc, const char* argv[]) = 0;

    virtual int PRManSystemEnd() = 0;

    virtual int PRManRenderEnd() = 0;

protected:
    RixRiCtl() : RixInterface(1) {}
    virtual ~RixRiCtl() {}
};

#endif