TIL_NullFilter.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024
 *    Side Effects Software Inc.  All rights reserved.
 *
 * Redistribution and use of Houdini Development Kit samples in source and
 * binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. The name of Side Effects Software may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __TIL_NullFilter__
#define __TIL_NullFilter__

#include <PXL/PXL_Raster.h>
#include <TIL/TIL_RasterFilter.h>
#include <UT/UT_Debug.h>

#ifdef _WIN32
#  ifndef WIN32_LEAN_AND_MEAN
#    define WIN32_LEAN_AND_MEAN
#  endif
#  include<windows.h>
#endif

/// Sample code to install a pass-through Image Filter into Houdini
///
/// These filters can be used in:
///   - Karma Image Filters
///   - The AI Denoise COP
///   - The @c idenoise application
/// For example, after the code is build, the filters should appear when
/// running <tt>idenoise -l</tt>.
///
/// To make this example, you can run: @code
/// hcustom -i ~/houdini/dso/img_filter TIL_NullFilter.C
/// @endcode
///
/// To test the filter, you can try: @code
/// % idenoise -d null_filter --options '{"verbose":1,"test":3.2}"' Mandril.pic x.exr
/// % idenoise -d null_filter --normal N --extra_aovs P --options '{"verbose":1}"' Snail.pic x.exr
/// @endcode

class TIL_NullFilter final : public TIL_RasterFilter
{
public:
    TIL_NullFilter();
    ~TIL_NullFilter() override;

    /// @{
    /// Overridden methods from the base class
    const char  *className() const override { return "TIL_NullFilter"; }
    bool         setOptions(const UT_Options &argstr) override;
    bool         apply(PXL_Raster *raster) override;
    void         reset() override;
    /// @}

    /// Since the filters run in a few milliseconds, they can be considered
    /// interactive.
    bool         isInteractive() const override { return true; }

private:
    bool        myVerbose;
};

#endif