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

#ifndef __HOM_DetachedAttrib_h__
#define __HOM_DetachedAttrib_h__

#include "HOM_API.h"
#include "HOM_BinaryString.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_IterableList.h"
#include "HOM_EnumModules.h"
#include "HOM_Matrix4.h"
#include <UT/UT_Tuple.h>
#include <vector>
#include <string>

SWIGOUT(%rename(DetachedAttrib) HOM_DetachedAttrib;)
// Force SWIG to output an __init__ method even though it determines this
// class is abstract.
SWIGOUT(%feature("notabstract") HOM_DetachedAttrib;)

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

    virtual std::string __repr__() = 0;

    virtual HOM_DetachedAttrib *__enter__() { return this; }

#ifdef SWIG
%extend
{
    // We can ignore the type, value, and traceback Python objects.
    SWIGOUT(virtual void __exit__(
            InterpreterObject type, InterpreterObject value, 
            InterpreterObject traceback)
    { self->close(); };)
}
#endif

    virtual void close() = 0;

    virtual HOM_EnumValue       &dataType() const = 0;
    SWIGOUT(%warnfilter(321) type;)
    virtual HOM_EnumValue       &type() const = 0;
    virtual bool                 isArrayType() const = 0;
    virtual HOM_EnumValue       &numericDataType() const = 0;
    virtual std::string          qualifier() const = 0;

    virtual int                  tupleSize() const = 0;
    virtual int                  channelCount() const = 0;
    /// Size means tupleSize for HOM_Atrib so can't use that for our
    /// length
    virtual int64                length() const = 0;

    virtual bool                 onCPU() const = 0;
    virtual bool                 onGPU() const = 0;


    SWIGOUT(%newobject freeze;)
    virtual HOM_DetachedAttrib         *freeze() const = 0;
    virtual bool                 isFrozen() const = 0;
    
    virtual std::map<std::string, hboost::any> properties() const = 0;
    virtual void                  setProperties(const std::map<std::string, hboost::any> &p) = 0;
    virtual void                  updateProperties(const std::map<std::string, hboost::any> &p) = 0;

    virtual HOM_BinaryString     rawDetachedAttrib() const = 0;

    // statistics
    virtual hboost::any          computeMin(int channel = 0) const = 0;
    virtual hboost::any          computeMax(int channel = 0) const = 0;
    virtual hboost::any          computeMinLength() const = 0;
    virtual hboost::any          computeMaxLength() const = 0;
    virtual double               computeAverage(int channel = 0) const = 0;

#ifdef SWIG
%extend
{
    void setFromRawDetachedAttrib(InterpreterObject values)
    {
        HOM_PyBuffer buffer(values);
        self->opaqueSetFromRawDetachedAttrib(
            (const char *)buffer.myData, buffer.myLength);
    }
}
#endif

    SWIGOUT(%ignore opaqueSetFromRawDetachedAttrib);
    virtual void opaqueSetFromRawDetachedAttrib(const char *values, int64 length) = 0;

};

#endif