HOM_CopCable.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_Defines.h"
#include "HOM_Module.h"

#include "HOM_ImageLayer.h"
#include "HOM_Geometry.h"
#include "HOM_NanoVDB.h"
#include "HOM_DetachedAttrib.h"

SWIGOUT(%rename(CopCable) HOM_CopCable;)
SWIGOUT(%feature("notabstract") HOM_CopCable;)

class HOM_API HOM_CopCable
{
public:
#ifdef SWIG
%extend
{
    HOM_CopCable(HOM_CopCable *const cable = nullptr)
    { return HOM().newCopCable(cable); }
}
#else
    HOM_CopCable()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_CopCable(const HOM_CopCable &)
    { HOM_CONSTRUCT_OBJECT(this) }
#endif
    virtual ~HOM_CopCable()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual int             wireCount() const = 0;
    virtual int             appearanceToIndex(
                                const std::string &name,
                                const int appearance = 0) const = 0;
    virtual int             indexToAppearance(int idx) const = 0;
    virtual std::string     __repr__() const = 0;
    virtual std::string     wireName(int idx) const = 0;
    virtual std::string     wireDataTypeByIndex(int idx) const = 0;
    virtual std::string     wireDataType(const std::string &name,
                                         int idx) const = 0;

    virtual std::vector<std::string> wireNames() const = 0;
    
    SWIGOUT(%newobject layerByIndex);
    virtual HOM_ImageLayer *layerByIndex(int idx) = 0;
    SWIGOUT(%newobject layer);
    virtual HOM_ImageLayer *layer(const std::string &name,
                                  int appearance = 0) = 0;
    SWIGOUT(%newobject geometryByIndex);
    virtual HOM_Geometry   *geometryByIndex(int idx) = 0;
    SWIGOUT(%newobject geometry);
    virtual HOM_Geometry   *geometry(const std::string &name,
                                     int appearance = 0) = 0;
    SWIGOUT(%newobject vdbByIndex);
    virtual HOM_NanoVDB    *vdbByIndex(int idx) = 0;
    SWIGOUT(%newobject vdb);
    virtual HOM_NanoVDB    *vdb(const std::string &name,
                                int appearance = 0) = 0;
    SWIGOUT(%newobject attribByIndex);
    virtual HOM_DetachedAttrib    *attribByIndex(int idx) = 0;
    SWIGOUT(%newobject attrib);
    virtual HOM_DetachedAttrib    *attrib(const std::string &name,
                                int appearance = 0) = 0;
    virtual void            addLayer(const std::string &name,
                                     const HOM_ImageLayer&) = 0;
    virtual void            addGeometry(const std::string &name,
                                        HOM_Geometry&) = 0;
    virtual void            addVDB(const std::string &name,
                                   const HOM_NanoVDB&) = 0;
    virtual void            addAttrib(const std::string &name,
                                   const HOM_DetachedAttrib&) = 0;
    virtual void            removeByIndex(int idx) = 0;
    virtual void            remove(const std::string &name,
                                   int appearance = 0) = 0;
    virtual void            setWireName(int idx, const std::string &name) = 0;
    virtual void            setDataByIndex(int idx, const HOM_ImageLayer&) = 0;
    virtual void            setData(const std::string &name,
                                    const HOM_ImageLayer&) = 0;
    virtual void            setData(const std::string &name, int appearance,
                                    const HOM_ImageLayer&) = 0;
    virtual void            setDataByIndex(int idx, HOM_Geometry&) = 0;
    virtual void            setData(const std::string &name,
                                    HOM_Geometry&) = 0;
    virtual void            setData(const std::string &name, int appearance,
                                    HOM_Geometry&) = 0;
    virtual void            setDataByIndex(int idx, const HOM_NanoVDB&) = 0;
    virtual void            setData(const std::string &name,
                                    const HOM_NanoVDB&) = 0;
    virtual void            setData(const std::string &name, int appearance,
                                    const HOM_NanoVDB&) = 0;
    virtual void            setDataByIndex(int idx, const HOM_DetachedAttrib&) = 0;
    virtual void            setData(const std::string &name,
                                    const HOM_DetachedAttrib&) = 0;
    virtual void            setData(const std::string &name, int appearance,
                                    const HOM_DetachedAttrib&) = 0;
};