RixRIB.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
#
# ------------------------------------------------------------------------------
*/

#ifndef RixRIB_h
#define RixRIB_h

#include "RixInterfaces.h"              // for RixInterface
#include "ri.h"                         // for RtBound

class Ri;

class RixZipSubfile;

class RixZipWriter {
public:
    
    virtual bool
    BeginSubfile(const char *subfilename, bool compress, bool bufferall,
                 RixZipSubfile **result) = 0;
    
    virtual int
    EndSubfile() = 0;
    
    virtual const char*
    GetError(void) = 0;
    
    virtual
    ~RixZipWriter() {}
};

class RixZipSubfile {
public:
    
    virtual size_t
    GetSize(void) = 0;
    
    virtual void
    BeginReading(void) = 0;
    
    virtual void
    Read(void *blk, size_t blocksize) = 0;
    
    virtual void
    EndReading(void) = 0;
    
    virtual void
    Write(const void *blk, size_t blocksize) = 0;
    

    virtual
    ~RixZipSubfile() {}
};



class RixRIB : public RixInterface
{
public:
    struct Configuration
    {
        enum Format
        {
            k_fmtUndef,
            k_fmtAscii,
            k_fmtBinary,
        };
        enum Compression
        {
            k_cmpUndef,
            k_cmpNone,
            k_cmpGzip,
        };
        enum AsciiStyle
        {
            k_asIndented = 0x1,
            k_asWide     = 0x2,
        };
        Configuration() : format(k_fmtUndef), compression(k_cmpUndef), asciiStyle(0), precision(0), bbox{0,0,0,0,0,0} {}
        Format format;
        Compression compression;
        int asciiStyle;
        int precision;
        RtBound bbox;
    };

    virtual Ri* CreateRIBGenerator(Ri* parent = 0L, Configuration* config = nullptr) = 0;

    virtual void DestroyRIBGenerator(Ri*) = 0;

    virtual RixZipWriter*
    GetZipWriter(void) = 0;

    virtual RixZipSubfile*
    OpenSubfileForRead(const char* path, const char* subfileName) = 0;

    virtual bool GetBound(const char* archiveName, RtBound bound) = 0;

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

#endif