HOM/HOM_Volume.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_Volume_h__
#define __HOM_Volume_h__

#include "HOM_API.h"
#include "HOM_Prim.h"

SWIGOUT(%rename(Volume) HOM_Volume;)

class HOM_API HOM_Volume : virtual public HOM_Prim
{
public:
    HOM_Volume()
    { HOM_CONSTRUCT_OBJECT(this) }

    // Because the lowermost base classes initialize the virtual bases
    // before any non-virtual bases, the correct thing to do here is
    // explicitly call the constructor for HOM_Prim.
    HOM_Volume(const HOM_Volume &volume)
    : HOM_Prim(volume)
    { HOM_CONSTRUCT_OBJECT(this) }

    virtual ~HOM_Volume()
    { 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 float sample(const std::vector<float> &position)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_InvalidSize,
            HOM_Error) = 0;

    SWIGOUT(%newobject gradient;)
    virtual HOM_Vector3 *gradient(const std::vector<float> &position)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_InvalidSize,
            HOM_Error) = 0;

    virtual float voxel(const std::vector<int> &index)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_InvalidSize,
            HOM_Error) = 0;

    virtual void setVoxel(const std::vector<int> &index, float value)
        throw(HOM_GeometryPermissionError, HOM_OperationFailed,
            HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_Error) = 0;

    virtual std::vector<float> allVoxels()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string allVoxelsAsString()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void setAllVoxels(const std::vector<float> &values)
        throw(HOM_GeometryPermissionError, HOM_OperationFailed,
            HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_Error) = 0;

    virtual void setAllVoxelsFromString(const std::string &values)
        throw(HOM_GeometryPermissionError, HOM_OperationFailed,
            HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_Error) = 0;

    virtual std::vector<int> resolution()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject indexToPos;)
    virtual HOM_Vector3 *indexToPos(const std::vector<int> &index)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_InvalidSize,
            HOM_Error) = 0;

    virtual std::vector<int> posToIndex(const std::vector<float> &position)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_InvalidSize,
            HOM_Error) = 0;

    virtual bool isValidIndex(const std::vector<int> &index)
        throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_Error) = 0;

    virtual float volumeMax()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual float volumeMin()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual float volumeAverage()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject transform;)
    virtual HOM_Matrix3 *transform()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual float taperX()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual float taperY()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---