IMX_ParmDataItem.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.
 *
 * NAME:        IMX_ParmDataItem.h ( GU Library, C++)
 *
 * COMMENTS:    Represents IMX data in parameter.
 */

#ifndef __IMX_ParmDataItem__
#define __IMX_ParmDataItem__

#include "IMX_API.h"
#include "IMX_Attribute.h"
#include "IMX_Layer.h"
#include "IMX_VDB.h"
#include <PRM/PRM_Parm.h>
#include <PRM/PRM_Type.h>

class IMX_API IMX_ParmLayerDataItem : public PRM_DataItem
{
public:
    IMX_ParmLayerDataItem() {}
    IMX_ParmLayerDataItem(IMX_LayerConstPtr layer)
        : myLayer(layer) {}

    PRM_Type::PRM_DataType getDataType() const override 
        { return PRM_Type::PRM_DATA_NONE; }
    const char *getDataTypeToken() const override { return "imagelayer"; }

    bool saveAscii(std::ostream &os) const override;
    bool saveBinary(std::ostream &os) const override;

    int64 getMemoryUsage() const override;

    // Override to return true when we know getDataTypeToken() and saveAscii()
    // are "safe".
    bool canSaveAsUnprotectedString() const override { return true; }

    IMX_LayerConstPtr layer() const { return myLayer; }

private:
    IMX_LayerConstPtr   myLayer;
};

class IMX_API IMX_ParmVDBDataItem : public PRM_DataItem
{
public:
    IMX_ParmVDBDataItem() {}
    IMX_ParmVDBDataItem(IMX_VDBConstPtr vdb)
        : myVDB(vdb) {}

    PRM_Type::PRM_DataType getDataType() const override 
        { return PRM_Type::PRM_DATA_NONE; }
    const char *getDataTypeToken() const override { return "nanovdb"; }

    bool saveAscii(std::ostream &os) const override;
    bool saveBinary(std::ostream &os) const override;

    int64 getMemoryUsage() const override;

    // Override to return true when we know getDataTypeToken() and saveAscii()
    // are "safe".
    bool canSaveAsUnprotectedString() const override { return true; }

    IMX_VDBConstPtr vdb() const { return myVDB; }

private:
    IMX_VDBConstPtr   myVDB;
};

class IMX_API IMX_ParmAttributeDataItem : public PRM_DataItem
{
public:
    IMX_ParmAttributeDataItem() {}
    IMX_ParmAttributeDataItem(IMX_AttributeConstPtr vdb)
        : myAttribute(vdb) {}

    PRM_Type::PRM_DataType getDataType() const override 
        { return PRM_Type::PRM_DATA_NONE; }
    const char *getDataTypeToken() const override { return "attribute"; }

    bool saveAscii(std::ostream &os) const override;
    bool saveBinary(std::ostream &os) const override;

    int64 getMemoryUsage() const override;

    // Override to return true when we know getDataTypeToken() and saveAscii()
    // are "safe".
    bool canSaveAsUnprotectedString() const override { return true; }

    IMX_AttributeConstPtr attrib() const { return myAttribute; }

private:
    IMX_AttributeConstPtr   myAttribute;
};

#endif