BRAY_FilterBase.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.
 *
 * NAME:        BRAY_FilterBase.h (RAY Library, C++)
 *
 * COMMENTS:
 */

#ifndef __BRAY_FilterBase__
#define __BRAY_FilterBase__

#include "BRAY_API.h"
#include <SYS/SYS_Hash.h>
#include <UT/UT_UniquePtr.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringArray.h>

class UT_Options;
class BRAY_FilterInit;

/// Base class for image filters.  These are any filters which process AOV data
class BRAY_API BRAY_FilterBase
{
public:
    BRAY_FilterBase(const UT_Options *o);
    virtual ~BRAY_FilterBase();

    /// Return an identifier for this plugin
    virtual const char  *className() const = 0;

    /// @{
    /// Return the rasters written and read by this plugin (as computed during
    /// initialization)
    const UT_StringArray        &writePlanes() const { return myWriteNames; }
    const UT_StringArray        &readPlanes() const { return myReadNames; }
    /// @}
    void        initialize(BRAY_FilterInit &init,
                        const UT_StringArray &all_aovs)
    {
        myWriteNames.clear();
        myReadNames.clear();
        if (!getAOVs(init, all_aovs, myWriteNames, myReadNames))
        {
            myWriteNames.clear();
            myReadNames.clear();
        }
    }

    /// Hash of the options passed to the constructor
    SYS_HashType        optionsHash() const { return myOptionsHash; }

    /// The list of @c available AOV planes in the render is passed in.  This is
    /// the list the renderer has been told to create.  The plugin should fill
    /// the string array of planes which it will @c write into, but also planes
    /// which it will @c read from.  For example, if you want to apply color
    /// correction to an image plane, you would need to add the plane to the @c
    /// write array but also to the @c read array.
    ///
    /// The method should return @c true if the plugin is valid (false if
    /// invalid).
    virtual bool        getAOVs(BRAY_FilterInit &init,
                                const UT_StringArray &available,
                                UT_StringArray &write,
                                UT_StringArray &read) = 0;

    /// Return the error if processImage() fails.  By default, this returns an
    /// empty string.
    virtual const UT_StringHolder       &errorMessage() const
    {
        return UT_StringHolder::theEmptyString;
    }

    /// Convenience method to add an error using printf style formatting
    UT_StringHolder     makeError(const char *fmt, ...)
                                SYS_PRINTF_CHECK_ATTRIBUTE(2, 3);

private:
    UT_StringArray      myWriteNames;
    UT_StringArray      myReadNames;
    SYS_HashType        myOptionsHash;
};

#endif