VEX_GeoCommand.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:        VEX_GeoCommand.h ( VEX Library, C++)
 *
 * COMMENTS:    Generic commands and queues to store geometry
 *              edit operations
 */

#ifndef __VEX_GeoCommand__
#define __VEX_GeoCommand__

#include "VEX_API.h"
#include "VEX_Types.h"
#include <UT/UT_Array.h>
#include <UT/UT_IntArray.h>
#include <UT/UT_Map.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_PageArray.h>
#include <UT/UT_SharedString.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_StringSet.h>
#include <UT/UT_Vector3.h>
#include <UT/UT_VectorTypes.h>

#include <variant>

// Do NOT use VEX_API here for template classes with all code in the header!

enum class VEX_GeoMode
{
    SET,
    ADD,
    MAX,
    MIN,
    MULTIPLY,
    TOGGLE,
    APPEND,

    INVALID
};
enum class VEX_GeoPrimType
{
    POLY_OPEN,
    POLY_CLOSED,
    TET,
    SPHERE,
    CIRCLE,
    TUBE,
    METABALL,
    METASQUAD,
    PACKEDALEMBIC,
    PACKEDDISK,
    HEX,
    CHANNEL,
    PLANE,

    INVALID
};
enum class VEX_GeoDictType
{
    DETAIL,
    DETAILINTRINSIC,
    PRIM,
    PRIMINTRINSIC,
    PRIMGROUP,
    POINT,
    POINTGROUP,
    VERTEX,
    VERTEXGROUP,
    EDGEGROUP,
    
    INVALID
};
enum class VEX_GeoTypeInfo
{
    NOCHANGE = -1,
    NONE = 0,
    POINT,
    HPOINT,
    VECTOR,
    NORMAL,
    COLOR,
    TRANSFORM,
    QUATERNION,
    INDEXPAIR,
    NONARITHMETIC_INTEGER,
    ARITHMETIC_INTEGER,
    TEXTURE_COORD
};

enum class VEX_GeoPrimChannelOperation
{
    InsertKey,
    DestroyKey,
    Clear,
    SetKeyValue,
    SetKeySlope,
    SetKeyAccel,

    Invalid
};

// These must match the order of the definitions in $SHS/vex/include/chprim_util.h
enum class VEX_GeoPrimChannelKeyHalf
{
    In,
    Out,
    InOut
};

namespace VEX_Geo
{
    VEX_API VEX_GeoMode modeFromString(const char*);
    VEX_API VEX_GeoPrimType typeFromString(const char*);
    VEX_API VEX_GeoDictType dictFromString(const char*);
    VEX_API VEX_GeoTypeInfo typeinfoFromString(const char*);

} // namespace VEX_Geo

class VEX_API VEX_GeoCommand
{
public:
    VEX_GeoCommand(exint srcelem) { mySourceElem = srcelem; }
    VEX_GeoCommand(): mySourceElem(-1) {}

    exint        elem() const { return mySourceElem; }

protected:
    exint        mySourceElem;
};

template <VEX_Precision PREC>
class VEX_GeoCommandPrimAdd : public VEX_GeoCommand
{
public:
    VEX_GeoCommandPrimAdd(exint srcelem, VEX_GeoPrimType primtype)
        : VEX_GeoCommand(srcelem)
        , myType(primtype)
    {
    }
    VEX_GeoCommandPrimAdd(): myType(VEX_GeoPrimType::INVALID) {}

    VEX_GeoPrimType type() const { return myType; }

protected:
    VEX_GeoPrimType myType;
};

template <VEX_Precision PREC>
class VEX_GeoCommandPointAdd : public VEX_GeoCommand
{
public:
    VEX_GeoCommandPointAdd(exint srcelem, VEXvec3<PREC> pos)
        : VEX_GeoCommand(srcelem)
        , myPos(pos)
        , mySrcPt(-1)
    {
    }
    VEX_GeoCommandPointAdd(exint srcelem, VEXint<PREC> srcpt)
        : VEX_GeoCommand(srcelem)
        , myPos(0.0, 0.0, 0.0)
        , mySrcPt(srcpt)
    {
    }
    VEX_GeoCommandPointAdd(): mySrcPt(-1) {}

    VEXvec3<PREC>       pos() const { return myPos; }
    VEXint<PREC>        srcpt() const { return mySrcPt; }

protected:
    // Ideally we'd union, but C++ makes this frustrating.
    VEXint<PREC> mySrcPt;
    VEXvec3<PREC> myPos;
};

template <VEX_Precision PREC>
class VEX_GeoCommandVertexAdd : public VEX_GeoCommand
{
public:
    VEX_GeoCommandVertexAdd(
        exint srcelem, VEXint<PREC> primnum, VEXint<PREC> ptnum)
        : VEX_GeoCommand(srcelem)
        , myPrimNum(primnum)
        , myPtNum(ptnum)
    {
    }
    VEX_GeoCommandVertexAdd(): myPrimNum(-1), myPtNum(-1) {}

    VEXint<PREC>        primnum() const { return myPrimNum; }
    VEXint<PREC>        ptnum() const { return myPtNum; }

protected:
    VEXint<PREC> myPrimNum;
    VEXint<PREC> myPtNum;
};

template <VEX_Precision PREC>
class VEX_GeoCommandObjectRemove : public VEX_GeoCommand
{
public:
    VEX_GeoCommandObjectRemove(exint srcelem, VEXint<PREC> obj_id)
        : VEX_GeoCommand(srcelem)
        , myObjID(obj_id)
    {
    }
    VEX_GeoCommandObjectRemove(): myObjID(-1) {}

    VEXint<PREC> objID() const { return myObjID; }

protected:
    VEXint<PREC> myObjID;
};

namespace VEX_DataObjID
{
    static SYS_FORCE_INLINE void initID(int32 &id) { id = -1; }
    static SYS_FORCE_INLINE bool isValidID(int32 id) { return id >= 0; }

    static SYS_FORCE_INLINE void initID(int64 &id) { id = -1; }
    static SYS_FORCE_INLINE bool isValidID(int64 id) { return id >= 0; }

    static SYS_FORCE_INLINE void initID(UT_StringHolder &id) { id.clear(); }
    static SYS_FORCE_INLINE bool isValidID(const UT_StringHolder &id) 
            { return id.isstring(); }

    static SYS_FORCE_INLINE void initID(UT_OptionsHolder &id) { id.clear(); }
    static SYS_FORCE_INLINE bool isValidID(const UT_OptionsHolder &id) 
            { return !id.isEmpty(); }
};

template <VEX_Precision PREC, typename OBJ_ID, typename SEC_ID, typename T>
class VEX_DataCommandAttribEdit : public VEX_GeoCommand
{
public:
    VEX_DataCommandAttribEdit(
        exint srcelem, const OBJ_ID &obj_id, const SEC_ID &sec_id,
        VEX_GeoMode mode, T data)
        : VEX_GeoCommand(srcelem)
        , myObjID(obj_id)
        , mySecID(sec_id)
        , myMode(mode)
        , myData(data)
    {
    }
    VEX_DataCommandAttribEdit()
        : mySecID(-1)
        , myMode(VEX_GeoMode::SET)
        , myData(T()) 
    {
        VEX_DataObjID::initID(myObjID);
    }

    const OBJ_ID &      objID() const { return myObjID; }
    const SEC_ID &      secID() const { return mySecID; }
    VEX_GeoMode         mode() const { return myMode; }
    T                   data() const { return myData; }

protected:
    OBJ_ID              myObjID;
    SEC_ID              mySecID;
    VEX_GeoMode         myMode;
    T                   myData;
};

template <VEX_Precision PREC, typename T>
using VEX_GeoCommandAttribEdit = 
    VEX_DataCommandAttribEdit<PREC, VEXint<PREC>, VEXint<PREC>, T>;
template <VEX_Precision PREC, typename T>
using VEX_UsdCommandAttribEdit = 
    VEX_DataCommandAttribEdit<PREC, UT_StringHolder, VEXint<PREC>, T>;

template <VEX_Precision PREC>
class VEX_GeoCommandVertexRewire : public VEX_GeoCommand
{
public:
    VEX_GeoCommandVertexRewire(
        exint srcelem, VEXint<PREC> primnum,
        VEXint<PREC> vtxidx, VEXint<PREC> newptnum)
        : VEX_GeoCommand(srcelem)
        , myPrimNum(primnum)
        , myVtxIdx(vtxidx)
        , myPtNum(newptnum)
    {
    }
    VEX_GeoCommandVertexRewire(): myPrimNum(-1), myVtxIdx(-1), myPtNum(-1) {}

    // -1 for primnum implies a linear vertex
    VEXint<PREC>        primnum() const { return myPrimNum; }
    VEXint<PREC>        vtxidx() const { return myVtxIdx; }
    VEXint<PREC>        ptnum() const { return myPtNum; }

protected:
    VEXint<PREC>        myPrimNum, myVtxIdx, myPtNum;
};

template <VEX_Precision PREC>
class VEX_GeoCommandAgentChannelEdit : public VEX_GeoCommand
{
public:
    VEX_GeoCommandAgentChannelEdit(exint srcelem, VEXint<PREC> primnum,
                                   const VEXfloat<PREC> &value,
                                   VEXint<PREC> channelidx)
        : VEX_GeoCommand(srcelem),
          myPrimNum(primnum),
          myValue(value),
          myChannelIdx(channelidx)
    {
    }

    VEX_GeoCommandAgentChannelEdit()
        : myPrimNum(-1), myValue(0.0), myChannelIdx(-1)
    {
    }

    VEXint<PREC> primnum() const { return myPrimNum; }
    VEXfloat<PREC> value() const { return myValue; }
    VEXint<PREC> channelIdx() const { return myChannelIdx; }

private:
    VEXint<PREC> myPrimNum;
    VEXfloat<PREC> myValue;
    VEXint<PREC> myChannelIdx;
};

template <VEX_Precision PREC>
class VEX_GeoCommandAgentXformEdit : public VEX_GeoCommand
{
public:
    VEX_GeoCommandAgentXformEdit(exint srcelem, VEXint<PREC> primnum,
            const VEXmat4<PREC> &xform, VEXint<PREC> xformidx, bool worldspace)
        : VEX_GeoCommand(srcelem),
          myPrimNum(primnum),
          myData(SingleEdit(xform, xformidx)),
          myWorldSpace(worldspace)
    {
    }
    VEX_GeoCommandAgentXformEdit(exint srcelem, VEXint<PREC> primnum,
            const UT_Array<VEXmat4<PREC>> &xforms, bool worldspace)
        : VEX_GeoCommand(srcelem),
          myPrimNum(primnum),
          myData(FullEdit(xforms)),
          myWorldSpace(worldspace)
    {
    }
    VEX_GeoCommandAgentXformEdit(): myPrimNum(-1) {}

    VEXint<PREC>         primnum() const { return myPrimNum; }
    const VEXmat4<PREC> &xform() const
    {
        UT_ASSERT(myData.index() == 0);
        return std::get<SingleEdit>(myData).first;
    }
    VEXint<PREC>         xformidx() const
    {
        UT_ASSERT(myData.index() == 0);
        return std::get<SingleEdit>(myData).second;
    }
    const UT_Array<VEXmat4<PREC>> &xforms() const
    {
        UT_ASSERT(myData.index() == 1);
        return std::get<FullEdit>(myData);
    }
    bool                worldspace() const { return myWorldSpace; }

    bool                isSingleEdit() const { return myData.index() == 0; }

protected:
    typedef std::pair<VEXmat4<PREC>,VEXint<PREC>> SingleEdit;
    typedef UT_Array<VEXmat4<PREC>>               FullEdit;

    VEXint<PREC> myPrimNum;
    // Allow setting a single transform or setting all of them
    std::variant<SingleEdit, FullEdit> myData;
    bool                myWorldSpace;
};

template <VEX_Precision PREC>
class VEX_GeoCommandAgentClipEdit : public VEX_GeoCommand
{
public:
    VEX_GeoCommandAgentClipEdit(exint srcelem, VEXint<PREC> primnum,
                                const UT_Array<VEXint<PREC>> &clipids,
                                const UT_Array<VEXfloat<PREC>> &cliptimes,
                                const UT_Array<VEXfloat<PREC>> &clipweights,
                                const UT_Array<VEXint<PREC>> &clipxformgroupids,
                                const UT_Array<VEXint<PREC>> &cliplayerids,
                                const UT_Array<VEXint<PREC>> &cliplayermodes,
                                const UT_Array<VEXfloat<PREC>> &cliplayerweights,
                                const UT_Array<VEXint<PREC>> &cliplayerparents)
        : VEX_GeoCommand(srcelem),
          myPrimNum(primnum),
          myClipIds(clipids),
          myClipTimes(cliptimes),
          myClipWeights(clipweights),
          myClipXformGroupIds(clipxformgroupids),
          myClipLayerIds(cliplayerids),
          myClipLayerModes(cliplayermodes),
          myClipLayerWeights(cliplayerweights),
          myClipLayerParents(cliplayerparents)
    {
    }

    VEX_GeoCommandAgentClipEdit() = default;
    VEX_GeoCommandAgentClipEdit(const VEX_GeoCommandAgentClipEdit &) = default;
    VEX_GeoCommandAgentClipEdit(VEX_GeoCommandAgentClipEdit &&) = default;
    VEX_GeoCommandAgentClipEdit &operator=(const VEX_GeoCommandAgentClipEdit &) = default;
    VEX_GeoCommandAgentClipEdit &operator=(VEX_GeoCommandAgentClipEdit &&) = default;

    const VEXint<PREC>                   primnum()          const { return myPrimNum; }
    const UT_Array<VEXint<PREC>>        &clipids()          const { return myClipIds; }
    const UT_Array<VEXfloat<PREC>>      &cliptimes()        const { return myClipTimes; }
    const UT_Array<VEXfloat<PREC>>      &clipweights()      const { return myClipWeights; }
    const UT_Array<VEXint<PREC>>        &clipxformgroupids() const { return myClipXformGroupIds; }
    const UT_Array<VEXint<PREC>>        &cliplayerids()     const { return myClipLayerIds; }
    const UT_Array<VEXint<PREC>>        &cliplayermodes()   const { return myClipLayerModes; }
    const UT_Array<VEXfloat<PREC>>      &cliplayerweights() const { return myClipLayerWeights; }
    const UT_Array<VEXint<PREC>>        &cliplayerparents() const { return myClipLayerParents; }

protected:
    VEXint<PREC>                myPrimNum;
    UT_Array<VEXint<PREC>>      myClipIds;
    UT_Array<VEXfloat<PREC>>    myClipTimes;
    UT_Array<VEXfloat<PREC>>    myClipWeights;
    UT_Array<VEXint<PREC>>      myClipXformGroupIds;
    UT_Array<VEXint<PREC>>      myClipLayerIds;
    UT_Array<VEXint<PREC>>      myClipLayerModes;
    UT_Array<VEXfloat<PREC>>    myClipLayerWeights;
    UT_Array<VEXint<PREC>>      myClipLayerParents;
};

template <VEX_Precision PREC>
class VEX_GeoCommandAgentLayerEdit : public VEX_GeoCommand
{
public:
    VEX_GeoCommandAgentLayerEdit(exint srcelem, VEXint<PREC> primnum,
            const UT_Array<VEXint<PREC>> &layer_ids, bool is_collision)
        : VEX_GeoCommand(srcelem),
          myPrimNum(primnum),
          myLayerIds(layer_ids),
          myIsCollision(is_collision)
    {
    }
    VEX_GeoCommandAgentLayerEdit() = default;

    VEXint<PREC> primnum() const { return myPrimNum; }
    const UT_Array<VEXint<PREC>> &layerIds() const { return myLayerIds; }
    bool isCollision() const { return myIsCollision; }

private:
    VEXint<PREC> myPrimNum = -1;
    UT_Array<VEXint<PREC>> myLayerIds;
    bool myIsCollision = false;
};

class CL_Clip;

template <VEX_Precision PREC>
class VEX_GeoCommandAgentAddClip : public VEX_GeoCommand
{
public:
    VEX_GeoCommandAgentAddClip(
            exint srcelem,
            VEXint<PREC> primnum,
            const UT_StringHolder &clip_name,
            const UT_StringHolder &clip_path,
            bool keep_ref)
        : VEX_GeoCommand(srcelem)
        , myPrimNum(primnum)
        , myClipName(clip_name)
        , myClipPath(clip_path)
        , myKeepRef(keep_ref)
    {
    }
    VEX_GeoCommandAgentAddClip()
        : VEX_GeoCommand()
        , myPrimNum(-1)
        , myClipName()
        , myClipPath()
        , myKeepRef(true)
    {
    }

    VEXint<PREC> primnum() const { return myPrimNum; }

    VEXint<PREC>    myPrimNum;
    UT_StringHolder myClipName;
    UT_StringHolder myClipPath;
    bool            myKeepRef;
};

template <VEX_Precision PREC>
class VEX_GeoCommandPrimChannelEdit : public VEX_GeoCommand
{
public:
    VEX_GeoCommandPrimChannelEdit(
            exint srcelem,
            VEXint<PREC> primnum,
            VEX_GeoPrimChannelOperation operation,
            float time = 0.0,
            float value = 0.0,
            VEX_GeoPrimChannelKeyHalf half = VEX_GeoPrimChannelKeyHalf::InOut)
        : VEX_GeoCommand(srcelem)
        , myPrimNum(primnum)
        , myOperation(operation)
        , myTime(time)
        , myValue(value)
        , myHalf(half)
    {
    }
    VEX_GeoCommandPrimChannelEdit()
        : VEX_GeoCommand()
        , myPrimNum(-1)
        , myOperation(VEX_GeoPrimChannelOperation::Invalid)
        , myTime(0)
        , myValue(0)
        , myHalf(VEX_GeoPrimChannelKeyHalf::InOut)
    {
    }

    VEXint<PREC> primnum() const { return myPrimNum; }

    VEXint<PREC> myPrimNum;
    VEX_GeoPrimChannelOperation myOperation;
    float myTime;
    float myValue;
    VEX_GeoPrimChannelKeyHalf myHalf;
};

template <VEX_Precision PREC, typename OBJ_ID, typename SEC_ID>
class VEX_API VEX_AttribEdit
{
public:
    //
    // A variant of all VEXint,VEXfloat,VEXvecN,VEXmatN types
    class DefaultValue
    {
    public:
        DefaultValue() { memset(f, 0, sizeof(VEXfloat<PREC>)*16); i = 0; }

        void            set(VEXint<PREC> v) { i = v; }
        void            set(VEXfloat<PREC> v) { f[0] = v; }
        void            set(VEXvec2<PREC> v) { memcpy(f, &v, sizeof(v)); }
        void            set(VEXvec3<PREC> v) { memcpy(f, &v, sizeof(v)); }
        void            set(VEXvec4<PREC> v) { memcpy(f, &v, sizeof(v)); }
        void            set(VEXmat2<PREC> v) { memcpy(f, &v, sizeof(v)); }
        void            set(VEXmat3<PREC> v) { memcpy(f, &v, sizeof(v)); }
        void            set(VEXmat4<PREC> v) { memcpy(f, &v, sizeof(v)); }

        VEXfloat<PREC> f[16];
        VEXint<PREC>   i;
    };

    VEX_AttribEdit(VEX_GeoDictType dict,
                   const UT_StringHolder &name);
    // This constructor is only used for the VEX_UsdEdit incarnation of
    // this class. This avoids having to define a subclass and introducing
    // virtual function calls. The path is used to group and sort USD edits
    // according to their location in the scene graph tree, rather than just
    // using the attribute name or metadata key (which are supplied in the
    // name parameter).
    VEX_AttribEdit(VEX_GeoDictType dict,
                   const UT_StringHolder &path,
                   const UT_StringHolder &name);
    ~VEX_AttribEdit();

    UT_NON_COPYABLE(VEX_AttribEdit)

    void                setTypeInfo(exint srcelem,
                                    const char *typeinfo);

    void                addAttribute(exint srcelem,
                                    VEX_Type type,
                                    bool isarray,
                                    const DefaultValue &value);
                                    
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXfloat<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXint<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXvec2<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXvec3<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXvec4<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXmat2<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXmat3<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   VEXmat4<PREC> data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const char *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   UT_OptionsHolder dict);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXfloat<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXvec2<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXvec3<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXvec4<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXmat2<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXmat3<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXmat4<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<VEXint<PREC>> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<const char *> *data);
    void                appendEdit(exint srcelem,
                                   const OBJ_ID &obj_id,
                                   const SEC_ID &sec_id,
                                   VEX_GeoMode mode,
                                   const UT_Array<UT_OptionsHolder> *data);


    // This may steal the command list from the source!
    void                merge(VEX_AttribEdit &src);

    void                sort();

    void                clear();

    // These convert our command list to the specified type.
    //
    // If the stored VEX_Type matches the return type, the result will be
    // valid. Otherwise nullptr is returned.
    
    // Functions:
    // fCmd, iCmd, v2Cmd, v3Cmd, v4Cmd, m2Cmd, m3Cmd, m4Cmd, sCmd, dCmd
    // afCmd, aiCmd, av2Cmd, av3Cmd, av4Cmd, am2Cmd, am3Cmd, am4Cmd, asCmd, adCmd
#define VEX_GEOATTRIBEDIT_CASE(vtype, type, name, isarray) \
    UT_Array<VEX_DataCommandAttribEdit<PREC, OBJ_ID, SEC_ID, type>> * \
    name##Cmd() \
    {\
        if (myType == vtype && myIsArray == isarray)\
            return (UT_Array<VEX_DataCommandAttribEdit<PREC, OBJ_ID, SEC_ID, type>>*) myCmdList;\
        return nullptr;\
    }
#define VEX_GEOATTRIBEDIT_CASE_DIRECT(ty, name) \
    VEX_GEOATTRIBEDIT_CASE(VEX_VexTypeResolver<VEX##ty<PREC>>::type,VEX##ty<PREC>,name,false)
#define VEX_GEOATTRIBEDIT_CASE_ARRAY(ty, name) \
    VEX_GEOATTRIBEDIT_CASE(VEX_VexTypeResolver<VEX##ty<PREC>>::type,const UT_Array<VEX##ty<PREC>>*,name,true)

    VEX_GEOATTRIBEDIT_CASE_DIRECT(float, f)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(int, i)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(vec2, v2)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(vec3, v3)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(vec4, v4)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(mat2, m2)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(mat3, m3)
    VEX_GEOATTRIBEDIT_CASE_DIRECT(mat4, m4)

    VEX_GEOATTRIBEDIT_CASE(VEX_TYPE_STRING, const char*, s, false)
    VEX_GEOATTRIBEDIT_CASE(VEX_TYPE_DICT, UT_OptionsHolder, d, false)

    VEX_GEOATTRIBEDIT_CASE_ARRAY(float, af)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(int, ai)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(vec2, av2)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(vec3, av3)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(vec4, av4)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(mat2, am2)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(mat3, am3)
    VEX_GEOATTRIBEDIT_CASE_ARRAY(mat4, am4)
    
    VEX_GEOATTRIBEDIT_CASE(VEX_TYPE_STRING, const UT_Array<const char*>*, as, true)
    VEX_GEOATTRIBEDIT_CASE(VEX_TYPE_DICT, const UT_Array<UT_OptionsHolder>*, ad, true)

#undef VEX_GEOATTRIBEDIT_CASE_ARRAY
#undef VEX_GEOATTRIBEDIT_CASE_DIRECT
#undef VEX_GEOATTRIBEDIT_CASE

    VEX_GeoDictType      dict() const { return myDict; }
    const UT_StringHolder &name() const { return myName; }
    VEX_Type             type() const { return myType; }
    bool                 isArray() const { return myIsArray; }
    bool                 shouldcreate() const { return myDoCreate; }
    VEX_GeoTypeInfo      typeinfo() const { return myTypeInfo; }
    const DefaultValue  &defaultValue() const { return myDefValue; }

    // The path component is only used by USD edits, to hold the primitive or
    // property path so that we can sort the edits and apply them in the order
    // of the scene graph hierarchy.
    const UT_StringHolder &path() const { return myPath; }

protected:
    // The earliest proc that refered to us.
    exint                myDefiningElem;
    VEX_GeoDictType      myDict;
    UT_StringHolder      myName;
    UT_StringHolder      myPath;
    VEX_Type             myType;
    bool                 myIsArray;
    // The proc that set the typeinfo.
    // Because we are logically overwriting, it makes sense for this
    // to be the last person to set it!
    exint                myTypeInfoElem; 
    VEX_GeoTypeInfo      myTypeInfo;

    void                *myCmdList;
    // The proc that marked us for creation
    exint                myCreationElem;
    bool                 myDoCreate;
    DefaultValue         myDefValue;
};

class VEX_AttribEditId
{
public:
    enum UseUnsafeStringsType {
        UseUnsafeStrings
    };
    VEX_AttribEditId(VEX_GeoDictType dict,
            const UT_StringRef &path,
            const UT_StringRef &name,
            UseUnsafeStringsType)
        : myDict(dict),
          myPath(UTmakeUnsafeRef(path)),
          myName(UTmakeUnsafeRef(name))
    { }
    VEX_AttribEditId(VEX_GeoDictType dict,
            const UT_StringHolder &path,
            const UT_StringHolder &name)
        : myDict(dict),
          myPath(path),
          myName(name)
    { }

    bool operator==(const VEX_AttribEditId &other) const
    {
        return myDict == other.myDict &&
               myPath == other.myPath &&
               myName == other.myName;
    }

    VEX_GeoDictType  myDict;
    UT_StringHolder  myPath;
    UT_StringHolder  myName;
};
VEX_API std::size_t hash_value(const VEX_AttribEditId &id);
using VEX_AttribEditIndexMap = UT_Map<VEX_AttribEditId, exint>;

template <VEX_Precision PREC>
using VEX_GeoAttribEdit = VEX_AttribEdit<PREC, VEXint<PREC>, VEXint<PREC>>;
template <VEX_Precision PREC>
using VEX_UsdEdit = VEX_AttribEdit<PREC, UT_StringHolder, VEXint<PREC>>;

template <VEX_Precision PREC>
class VEX_GeoCommandEdgeGroupEdit : public VEX_GeoCommand
{
public:
    VEX_GeoCommandEdgeGroupEdit(
            exint srcelem,
            VEXint<PREC> ptnum0, VEXint<PREC> ptnum1,
            VEXint<PREC> data)
        : VEX_GeoCommand(srcelem)
        , myPtNum0(ptnum0)
        , myPtNum1(ptnum1)
        , myData(data)
    {
    }
    VEX_GeoCommandEdgeGroupEdit()
        : VEX_GeoCommand(), myPtNum0(-1) , myPtNum1(-1), myData(-1)
    {}

    VEXint<PREC> ptNum0() const { return myPtNum0; }
    VEXint<PREC> ptNum1() const { return myPtNum1; }
    VEXint<PREC> data() const { return myData; }

protected:
    VEXint<PREC> myPtNum0;
    VEXint<PREC> myPtNum1;
    VEXint<PREC> myData;
};

template <VEX_Precision PREC>
class VEX_API VEX_GeoEdgeGroupEdit
{
public:
    VEX_GeoEdgeGroupEdit(const UT_StringHolder &groupname): myGroupName(groupname) {}

    const UT_StringHolder &groupName() const { return myGroupName; }

    const UT_Array<VEX_GeoCommandEdgeGroupEdit<PREC>> &cmd() const { return myCmdList; }

    void appendEdit(exint srcelem,
            VEXint<PREC> ptnum0,
            VEXint<PREC> ptnum1,
            VEXint<PREC> data);

    void merge(VEX_GeoEdgeGroupEdit &src);

    void sort();

protected:
    UT_StringHolder     myGroupName;
    UT_Array<VEX_GeoCommandEdgeGroupEdit<PREC>> myCmdList;
};

template <VEX_Precision PREC>
class VEX_API VEX_GeoCommandQueue
{
public:
    VEX_GeoCommandQueue();
    ~VEX_GeoCommandQueue();
    UT_NON_COPYABLE(VEX_GeoCommandQueue)

    // Converts the given string to one in our string table, ensuring
    // the pointer remains valid and avoids duplication.
    const char *hardenString(const char *str);
    
    // Creates a new array which is owned by this queue.  Does
    // not de-duplicate, but will return 0 for empty lists.
    const UT_Array<VEXfloat<PREC>> *hardenArray(const UT_Array<VEXfloat<PREC>> &arr);
    const UT_Array<VEXvec2<PREC>> *hardenArray(const UT_Array<VEXvec2<PREC>> &arr);
    const UT_Array<VEXvec3<PREC>> *hardenArray(const UT_Array<VEXvec3<PREC>> &arr);
    const UT_Array<VEXvec4<PREC>> *hardenArray(const UT_Array<VEXvec4<PREC>> &arr);
    const UT_Array<VEXmat2<PREC>> *hardenArray(const UT_Array<VEXmat2<PREC>> &arr);
    const UT_Array<VEXmat3<PREC>> *hardenArray(const UT_Array<VEXmat3<PREC>> &arr);
    const UT_Array<VEXmat4<PREC>> *hardenArray(const UT_Array<VEXmat4<PREC>> &arr);
    const UT_Array<VEXint<PREC>>  *hardenArray(const UT_Array<VEXint<PREC>> &arr);
    // ALSO hardens the contents:
    const UT_Array<const char *>   *hardenArray(const UT_Array<const char *> &arr);

    const UT_Array<UT_OptionsHolder>  *hardenArray(const UT_Array<UT_OptionsHolder> &arr);

    // Merges the src into us.  Note that the result may still
    // reference strings in the stringtable of src, so src must *not*
    // be deleted until the queue is processed!
    // This also may destroy src in the merging if stealing is more
    // efficient.
    void        merge(VEX_GeoCommandQueue &src);
    // Ensure our commands are in srcelem order.
    void        sort();

    bool        isEmpty() const
    {
        return myPointAdd.isEmpty() &&
               myPrimAdd.isEmpty() &&
               myVertexAdd.isEmpty() &&
               myVertexRewire.isEmpty() &&
               myAttribEdit.isEmpty() &&
               myUsdEdit.isEmpty() &&
               myEdgeGroupEdit.isEmpty() &&
               myAgentChannelEdit.isEmpty() &&
               myAgentXformEdit.isEmpty() &&
               myAgentClipEdit.isEmpty() &&
               myAgentLayerEdit.isEmpty() &&
               myAgentAddClip.isEmpty() &&
               myPrimChannelEdit.isEmpty() &&
               myPointRemove.isEmpty() &&
               myPointWithPrimRemove.isEmpty() &&
               myPrimRemove.isEmpty() &&
               myPrimWithPointRemove.isEmpty() &&
               myVertexRemove.isEmpty() &&
               myLocalVariables.empty() &&
               !myNewVisualizers &&
               !myAttribRemoval[(int)VEX_GeoDictType::DETAIL] &&
               !myAttribRemoval[(int)VEX_GeoDictType::PRIM] &&
               !myAttribRemoval[(int)VEX_GeoDictType::PRIMGROUP] &&
               !myAttribRemoval[(int)VEX_GeoDictType::POINT] &&
               !myAttribRemoval[(int)VEX_GeoDictType::POINTGROUP] &&
               !myAttribRemoval[(int)VEX_GeoDictType::VERTEX] &&
               !myAttribRemoval[(int)VEX_GeoDictType::VERTEXGROUP] &&
               !myAttribRemoval[(int)VEX_GeoDictType::EDGEGROUP]
               ;
    }

    // These return the new element number *relative* to the srcelem!
    VEXint<PREC> addPrim(exint srcelem, VEX_GeoPrimType primtype);
    VEXint<PREC> addPoint(exint srcelem, VEXvec3<PREC> pos);
    VEXint<PREC> addPoint(exint srcelem, VEXint<PREC> srcpt);
    VEXint<PREC> addVertex(exint srcelem, VEXint<PREC> primnum,
                    VEXint<PREC> ptnum);

    void        setEdgeGroup(
                    exint srcelem,
                    const UT_StringHolder &groupname,
                    VEXint<PREC> ptnum0, VEXint<PREC> ptnum1,
                    VEXint<PREC> data);

    void        addLocalVariable(exint srcelem, const char *attrib, const char *local);
    void        addVisualizer(const UT_StringHolder &visualizer);

    // If the given primnum is -1, it will treat vtxidx as a linear vertex
    void        rewireVertex( exint srcelem, VEXint<PREC> primum,
                    VEXint<PREC> vtxidx, VEXint<PREC> ptnum);

    void        removeAttrib(VEX_GeoDictType owner, const UT_StringHolder &name);
    void        removePoint(exint srcelem, VEXint<PREC> ptnum, bool includeprims);
    void        removePrim(exint srcelem, VEXint<PREC> primnum, bool includepoints);
    void        removeVertex(exint srcelem, VEXint<PREC> primnum);

    void        setAgentChannelValue(exint srcelem, VEXint<PREC> primnum,
                                     VEXfloat<PREC> value,
                                     VEXint<PREC> channelidx);

    void        setAgentTransform(exint srcelem, VEXint<PREC> primnum,
                                  const VEXmat4<PREC> &xform, VEXint<PREC> xformidx,
                                  bool worldspace);

    void        setAgentTransforms(exint srcelem, VEXint<PREC> primnum,
                                   const UT_Array<VEXmat4<PREC>> &xforms,
                                   bool worldspace);

    void        setAgentClips(exint srcelem, VEXint<PREC> primnum,
                              const UT_Array<VEXint<PREC>> &clipids,
                              const UT_Array<VEXfloat<PREC>> &cliptimes,
                              const UT_Array<VEXfloat<PREC>> &clipweights,
                              const UT_Array<VEXint<PREC>> &clipxformgroupids,
                              const UT_Array<VEXint<PREC>> &cliplayerids,
                              const UT_Array<VEXint<PREC>> &cliplayermodes,
                              const UT_Array<VEXfloat<PREC>> &cliplayerweights,
                              const UT_Array<VEXint<PREC>> &cliplayerparents);

    void        setAgentLayers(exint srcelem, VEXint<PREC> primnum,
                              const UT_Array<VEXint<PREC>> &layer_ids,
                              bool is_collision);

    void        agentAddClip(
                    exint srcelem,
                    VEXint<PREC> primnum,
                    const UT_StringHolder &clip_name,
                    const UT_StringHolder &clip,
                    const bool keep_ref);

    void        primChannelInsertKey(exint srcelem,
                                     VEXint<PREC> primnum,
                                     float time);

    void        primChannelDestroyKey(exint srcelem,
                                     VEXint<PREC> primnum,
                                     float time);

    void        primChannelClear(exint srcelem, VEXint<PREC> primnum);

    void primChannelSetKeyValue(exint srcelem, VEXint<PREC> primnum,
            float time, float value,
            VEX_GeoPrimChannelKeyHalf half = VEX_GeoPrimChannelKeyHalf::InOut);

    void primChannelSetKeySlope(exint srcelem, VEXint<PREC> primnum,
            float time, float slope,
            VEX_GeoPrimChannelKeyHalf half = VEX_GeoPrimChannelKeyHalf::InOut);

    void primChannelSetKeyAccel(exint srcelem, VEXint<PREC> primnum,
            float time, float accel,
            VEX_GeoPrimChannelKeyHalf half = VEX_GeoPrimChannelKeyHalf::InOut);

    VEX_GeoAttribEdit<PREC> *findEdit(VEX_GeoDictType dict,
                    const UT_StringRef &name);
    VEX_GeoAttribEdit<PREC> *findOrCreateEdit(VEX_GeoDictType dict,
                    const UT_StringRef &name);

    // Finds a list of VEX edits to the given primitive (or property) path and
    // name (could be a property or metadata item). We need to store the path
    // as well as the name for USD edits so that we apply the edits walking
    // down the scene graph hierarchy. This ensures that edits to attribs on
    // a prim will occur after the prim has been created, or edits to metadata
    // on a property will occur after the property has been created.
    VEX_UsdEdit<PREC> *findOrCreateUsdEdit(VEX_GeoDictType dict,
                    const UT_StringRef &path,
                    const UT_StringRef &name);

    /// NOTE: This should not be its own type, this should be embedded
    /// in findEdit using the proper VEX_GeoDictType!
    VEX_GeoEdgeGroupEdit<PREC> *findOrCreateEdgeGroupEdit(
                    const UT_StringHolder &groupname);

    // Creators
    UT_Array<VEX_GeoCommandPointAdd<PREC>>      myPointAdd;
    UT_Array<VEX_GeoCommandPrimAdd<PREC>>       myPrimAdd;
    UT_Array<VEX_GeoCommandVertexAdd<PREC>>     myVertexAdd;
    // Requested local variables.
    struct      VariableEntry
    {
        exint elem;
        const char *local;              // hardened!
    };
    UT_StringMap<VariableEntry>         myLocalVariables;

    UT_StringSet                        *myNewVisualizers;
    UT_StringSet                        *myAttribRemoval[(int)VEX_GeoDictType::INVALID];

    // Edits
    UT_Array<VEX_GeoCommandVertexRewire<PREC>>  myVertexRewire;
    UT_Array<VEX_GeoAttribEdit<PREC> *>         myAttribEdit;
    VEX_AttribEditIndexMap                      myAttribEditIndexMap;
    UT_Array<VEX_UsdEdit<PREC> *>               myUsdEdit;
    VEX_AttribEditIndexMap                      myUsdEditIndexMap;
    UT_Array<VEX_GeoEdgeGroupEdit<PREC> *>      myEdgeGroupEdit;
    UT_Array<VEX_GeoCommandAgentChannelEdit<PREC>> myAgentChannelEdit;
    UT_Array<VEX_GeoCommandAgentXformEdit<PREC>> myAgentXformEdit;
    UT_Array<VEX_GeoCommandAgentClipEdit<PREC>> myAgentClipEdit;
    UT_Array<VEX_GeoCommandAgentLayerEdit<PREC>> myAgentLayerEdit;
    UT_Array<VEX_GeoCommandAgentAddClip<PREC>>  myAgentAddClip;

    UT_Array<VEX_GeoCommandPrimChannelEdit<PREC>> myPrimChannelEdit;

    // Destructors
    // Note we don't have to sort these.  We do need to track
    // the source element to be able to lookup the relevant point
    // or primitive number, however.
    UT_Array<VEX_GeoCommandObjectRemove<PREC>> myPointRemove;
    UT_Array<VEX_GeoCommandObjectRemove<PREC>> myPointWithPrimRemove;
    UT_Array<VEX_GeoCommandObjectRemove<PREC>> myPrimRemove;
    UT_Array<VEX_GeoCommandObjectRemove<PREC>> myPrimWithPointRemove;
    UT_Array<VEX_GeoCommandObjectRemove<PREC>> myVertexRemove;

    typedef UT_PageArray<
        /* DATA_T */ VEXint<PREC>,
        /* TSIZE */ 1,
        /* TABLEHARDENED (owns its data) */ true,
        /* PAGESHARDENED */ false,
        /* THEPAGEBITS (2^10 tuples/page) */ 10,
        /* INDEX_T */ exint
        >       BlockArray;
    BlockArray                          myNetPoints;
    BlockArray                          myNetPrims;
    BlockArray                          myNetVertices;

    exint                               myNumPrim, myNumPoint, myNumVertex;

private:
    UT_SharedString                             *myStrings;
    UT_Array< UT_Array<VEXint<PREC>> *>         myIntArrays;
    UT_Array< UT_Array<VEXfloat<PREC>> *>       myFloatArrays;
    UT_Array< UT_Array<VEXvec2<PREC>> *>        myV2Arrays;
    UT_Array< UT_Array<VEXvec3<PREC>> *>        myV3Arrays;
    UT_Array< UT_Array<VEXvec4<PREC>> *>        myV4Arrays;
    UT_Array< UT_Array<VEXmat2<PREC>> *>        myM2Arrays;
    UT_Array< UT_Array<VEXmat3<PREC>> *>        myM3Arrays;
    UT_Array< UT_Array<VEXmat4<PREC>> *>        myM4Arrays;
    UT_Array< UT_Array<const char *> *>         myCstArrays;
    UT_Array< UT_Array<UT_OptionsHolder> *>     myDictArrays;
};

VEX_EXTERN_TEMPLATE(VEX_AttribEdit<VEX_32, VEXint<VEX_32>, VEXint<VEX_32>>);
VEX_EXTERN_TEMPLATE(VEX_AttribEdit<VEX_32, UT_StringHolder, VEXint<VEX_32>>);
VEX_EXTERN_TEMPLATE(VEX_AttribEdit<VEX_32, UT_OptionsHolder, VEXint<VEX_32>>);
VEX_EXTERN_TEMPLATE(VEX_GeoEdgeGroupEdit<VEX_32>);
VEX_EXTERN_TEMPLATE(VEX_GeoCommandQueue<VEX_32>);

VEX_EXTERN_TEMPLATE(VEX_AttribEdit<VEX_64, VEXint<VEX_64>, VEXint<VEX_64>>);
VEX_EXTERN_TEMPLATE(VEX_AttribEdit<VEX_64, UT_StringHolder, VEXint<VEX_64>>);
VEX_EXTERN_TEMPLATE(VEX_AttribEdit<VEX_64, UT_OptionsHolder, VEXint<VEX_64>>);
VEX_EXTERN_TEMPLATE(VEX_GeoEdgeGroupEdit<VEX_64>);
VEX_EXTERN_TEMPLATE(VEX_GeoCommandQueue<VEX_64>);

#endif