HOM/HOM_RopNode.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.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_RopNode_h__
#define __HOM_RopNode_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Node.h"

SWIGOUT(%rename(RopNode) HOM_RopNode;)

class HOM_API HOM_RopNode : virtual public HOM_Node
{
public:
    HOM_RopNode()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_RopNode(const HOM_RopNode &rop_node)
    : HOM_Node(rop_node)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_RopNode()
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;)

    virtual bool isBypassed()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void bypass(bool on)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool isLocked()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setLocked(bool on)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "inputDependencies(self) -> tuple of RopNode and float tuple tuples")
        inputDependencies;)
    virtual std::vector<std::pair<HOM_ElemPtr<HOM_Node>,
                        std::vector<float> > >
        inputDependencies()
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%kwargs render;)
    SWIGPYTHONOUT(%feature("autodoc",
        "render(self, frame_range=(), res=(), output_file=None, "
        "output_format=None, to_flipbook=False, quality=2, "
        "ignore_inputs=False, method=RopByRop, ignore_bypass_flags=False, "
        "ignore_lock_flags=False)") render;)
    virtual void render(
                const std::vector<float> &frame_range = std::vector<float>(),
                const std::vector<float> &res = std::vector<float>(),
                const char *output_file = NULL,
                const char *output_format = NULL,
                bool to_flipbook = false,
                int quality = 2,
                bool ignore_inputs = false,
                HOM_EnumValue &method = HOM_renderMethod::RopByRop,
                bool ignore_bypass_flags = false,
                bool ignore_lock_flags = false)
        throw(HOM_InvalidSize, HOM_PermissionError, HOM_ObjectWasDeleted,
                HOM_OperationFailed, HOM_Error) = 0;
};

#endif

---