CVEX/CVEX_Value.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
 *
 * NAME:        CVEX_Value.h ( CVEX Library, C++)
 *
 * COMMENTS:    C++ interface to VEX.  This class is used to specify
 *              input/output variable data.
 */

#ifndef __CVEX_Value__
#define __CVEX_Value__

#include "CVEX_API.h"

class UT_StringArray;

typedef enum {
    CVEX_TYPE_INVALID = -1,     // Invalid type
    CVEX_TYPE_INTEGER,          // 32 bit integer
    CVEX_TYPE_FLOAT,            // 32 bit float
    CVEX_TYPE_VECTOR3,          // 3-tuple of 32 bit float
    CVEX_TYPE_VECTOR4,          // 4-tuple of 32 bit float
    CVEX_TYPE_MATRIX3,          // 9-tuple of 32 bit float
    CVEX_TYPE_MATRIX4,          // 16-tuple of 32 bit float
    CVEX_TYPE_STRING            // string values
} CVEX_Type;

class CVEX_API CVEX_Value {
public:
     CVEX_Value(const char *name, CVEX_Type type, bool varying);
    ~CVEX_Value();

    const char  *getName() const        { return myName; }
    CVEX_Type    getType() const        { return myType; }
    bool         isExport() const       { return myExport; }
    bool         isVarying() const      { return myVarying; }
    int          getArraySize() const   { return myArraySize; }

    // Get the data pointer
    void        *getData()              { return myData; }

    // The array size is NOT the size in bytes, but rather the array size of
    // the input data.  It should either be 1 or N, where N is the number of
    // values being computed by VEX.
    //
    // When setting values for string types, you need to pass in a
    // UT_StringArray instead of a void *.  For input variables, the length
    // of the array will determine whether the parameter is varying or
    // uniform.
    //
    // When passing data for output variables, please check to see whether
    // the output variable is uniform or varying.  Varying values need to
    // have a full array of data (including string arrays).
    bool         setData(void *data, int array_size);
    bool         setData(UT_StringArray &stringdata);

private:
    static int          cvexToVexType(CVEX_Type type);
    static CVEX_Type    vexToCVexType(int vextype);

    void        *myData;
    const char  *myName;
    CVEX_Type    myType;        // Data type
    int          myVexType;     // VEX Type (mapped from CVEX_Type)
    int          myVexIndex;    // Offset into VEX symbol table
    int          myArraySize;   // Array size
    bool         myExport;      // Whether the data is output by VEX
    bool         myVarying;     // Whether the data is varying

    friend class        CVEX_Context;
};

#endif

---