HOM_CopNode.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.
 *
 * COMMENTS:
 */

#pragma once

#include "HOM_API.h"
#include "HOM_BinaryString.h"
#include "HOM_CopCableStructure.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_OpNode.h"
#include "HOM_ImageLayer.h"
#include "HOM_NanoVDB.h"
#include "HOM_DetachedAttrib.h"

class HOM_CopVerb;

SWIGOUT(%rename(CopNode) HOM_CopNode;)

class HOM_API HOM_CopNode : virtual public HOM_OpNode
{
public:
    HOM_CopNode()
    : HOM_NetworkMovableItem(HOM_networkItemType::Node)
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_CopNode(const HOM_CopNode &cop_node)
    : HOM_OpNode(cop_node),
      HOM_NetworkMovableItem(cop_node)
    { HOM_CONSTRUCT_OBJECT(this) }
    ~HOM_CopNode() override
    { HOM_DESTRUCT_OBJECT(this) }

    SWIGOUT(%newobject cable;)
    SWIGOUT(%kwargs cable;)
    virtual HOM_CopCable *cable(int output_index=0) = 0;
    SWIGOUT(%newobject cableAtFrame;)
    SWIGOUT(%kwargs cableAtFrame;)
    virtual HOM_CopCable *cableAtFrame(double frame, int output_index=0) = 0;
    
    SWIGOUT(%newobject geometry;)
    SWIGOUT(%kwargs geometry;)
    virtual HOM_Geometry *geometry(int output_index=0) = 0;
    SWIGOUT(%newobject geometryAtFrame;)
    SWIGOUT(%kwargs geometryAtFrame;)
    virtual HOM_Geometry *geometryAtFrame(double frame, int output_index=0) = 0;

    SWIGOUT(%newobject layer;)
    SWIGOUT(%kwargs layer;)
    virtual HOM_ImageLayer *layer(int output_index=0) = 0;
    SWIGOUT(%newobject layerAtFrame;)
    SWIGOUT(%kwargs layerAtFrame;)
    virtual HOM_ImageLayer *layerAtFrame(double frame, int output_index=0) = 0;

    SWIGOUT(%newobject vdb;)
    SWIGOUT(%kwargs vdb;)
    virtual HOM_NanoVDB *vdb(int output_index=0) = 0;
    SWIGOUT(%newobject vdbAtFrame;)
    SWIGOUT(%kwargs vdbAtFrame;)
    virtual HOM_NanoVDB *vdbAtFrame(double frame, int output_index=0) = 0;

    SWIGOUT(%newobject attrib;)
    SWIGOUT(%kwargs attrib;)
    virtual HOM_DetachedAttrib *attrib(int output_index=0) = 0;
    SWIGOUT(%newobject attribAtFrame;)
    SWIGOUT(%kwargs attribAtFrame;)
    virtual HOM_DetachedAttrib *attribAtFrame(double frame, int output_index=0) = 0;

    SWIGOUT(%newobject inputCableStructure;)
    virtual HOM_CopCableStructure *inputCableStructure(int input_index) = 0;
    SWIGOUT(%newobject outputCableStructure;)
    virtual HOM_CopCableStructure *outputCableStructure(int output_index) = 0;

    virtual bool hasVerb() = 0;
    SWIGOUT(%newobject verb;)
    virtual HOM_CopVerb *verb() = 0;

    virtual bool isBypassed() = 0;
    virtual void bypass(bool on) = 0;
    virtual bool isDisplayFlagSet() = 0;
    virtual void setDisplayFlag(bool on) = 0;
    virtual bool isTemplateFlagSet() = 0;
    virtual void setTemplateFlag(bool on) = 0;
    virtual bool isSelectableTemplateFlagSet() = 0;
    virtual void setSelectableTemplateFlag(bool on) = 0;
    virtual bool isCompressFlagSet() = 0;
    virtual void setCompressFlag(bool on) = 0;
    virtual bool isExportFlagSet() = 0;
    virtual void setExportFlag(bool on) = 0;

    virtual std::vector<std::string> outputDataTypes() = 0;
    virtual std::vector<std::string> inputDataTypes() = 0;
    virtual bool isInputCompatible(int idx, HOM_CopNode &other, int other_idx,
            bool allow_conversions = false) = 0;

    SWIGOUT(%newobject displayNode;)
    virtual HOM_Node *displayNode() = 0;

    SWIGOUT(%newobject pairedNode;)
    virtual HOM_CopNode *pairedNode() = 0;

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