DD_Defines.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:        DD_Define.h
 *
 * COMMENTS:
 */

#ifndef __DD_Define__
#define __DD_Define__

enum DD_State {
    DD_STATE_START,
    DD_STATE_DRAG,
    DD_STATE_END,
    DD_STATE_CANCEL
};

//
// Some common drag-n-drop attributes
// which are supplied by the sender
//
// Strings are chose over enumerated types
// so custom drag-n-drop objects will have
// a smaller chance of name collision.
//

#define DD_MIMETYPE_NAMESPACE           "application/sidefx-houdini-"

#define DD_DATA_TEXT                    "text/plain"
#define DD_DATA_FILELIST                "text/uri-list"
#define DD_LABEL_TEXT                   "Text"
#define DD_DATA_JSON                    "application/json"

// the data parameter is a (void *)int to index between multiple choices
#define DD_DATA_PARM_PATH               DD_MIMETYPE_NAMESPACE "parm.path"
#define DD_LABEL_PARM_PATH              "Parameter Path"

#define DD_DATA_CHAN_PATH               DD_MIMETYPE_NAMESPACE "channel.path"
#define DD_DATA_FLAG_PATH               DD_MIMETYPE_NAMESPACE "node.flag.path"

// the node and track are separated by a space since track names may
// have slashes in them
#define DD_DATA_TRACK_PATH              DD_MIMETYPE_NAMESPACE "chop.track.path"

// the data parameter is a (void *)int to index between multiple choices
#define DD_DATA_OP_PATH                 DD_MIMETYPE_NAMESPACE "node.path"
#define DD_LABEL_OP_PATH                "Node Path"

#define DD_DATA_ITEM_PATH               DD_MIMETYPE_NAMESPACE "item.path"
#define DD_LABEL_ITEM_PATH              "Network Item Path"
#define DD_DATA_PERS_HANDLE_PATH        DD_MIMETYPE_NAMESPACE \
                                            "persistent.handle.path"

#define DD_DATA_APEX_NODE_ID            DD_MIMETYPE_NAMESPACE "apex.node.id"
#define DD_LABEL_APEX_NODE_ID           "APEX Node ID"

// returns the name of a take
#define DD_DATA_TAKE_NAME               DD_MIMETYPE_NAMESPACE "take.name"

// returns a pointer to an OP_GalleryEntry or the gallery entry name
#define DD_DATA_GALLERY_ENTRY           DD_MIMETYPE_NAMESPACE "gallery.entry"
#define DD_DATA_GALLERY_ENTRY_NAME      DD_MIMETYPE_NAMESPACE \
                                            "gallery.entry.name"
#define DD_LABEL_GALLERY_ENTRY_NAME     "Gallery Entry"

// returns a pointer to SHLF_Tool or the shelf tool name
#define DD_DATA_SHELF_TOOL              DD_MIMETYPE_NAMESPACE "shelf.tool"
#define DD_DATA_SHELF_TOOL_NAME         DD_MIMETYPE_NAMESPACE "shelf.tool.name"
#define DD_LABEL_SHELF_TOOL_NAME        "Shelf Tool"

// returns an entry in the asset catalog
#define DD_DATA_ASSET_GALLERY_ENTRY     DD_MIMETYPE_NAMESPACE "asset.catalog.entry"
#define DD_LABEL_ASSET_GALLERY_ENTRY    "Asset Catalog Entry"

// Returns the name of the node type
#define DD_DATA_ASSET_GUID              DD_MIMETYPE_NAMESPACE "asset.guid"
#define DD_LABEL_ASSET_GUID             "Asset Guid"
#define DD_DATA_ASSETTOOL_NAME          DD_MIMETYPE_NAMESPACE \
                                            "orbolt.node.type.name"
#define DD_LABEL_ASSETTOOL_NAME         "Asset Tool"
#define DD_DATA_FOLDER_GUID             DD_MIMETYPE_NAMESPACE "folder.guid"
#define DD_LABEL_FOLDER_GUID            "Folder Guid"

// returns a pointer to OPUI_ToolbarItem
#define DD_DATA_SHELF_TOOL_BUTTON       DD_MIMETYPE_NAMESPACE \
                                            "shelf.tool.button"

// returns a pointer to the OPUI_Toolbar or the shelf name
#define DD_DATA_SHELF_TOOLBAR           DD_MIMETYPE_NAMESPACE \
                                            "shelf.toolbar"
#define DD_DATA_SHELF_TOOLBAR_NAME      DD_MIMETYPE_NAMESPACE "shelf.name"
#define DD_LABEL_SHELF_TOOLBAR_NAME     "Shelf"

// returns a pointer to FUSE_DesktopNode or the name of the pane tab
#define DD_DATA_DESKTOP_NODE            DD_MIMETYPE_NAMESPACE "desktop.node"
#define DD_DATA_DESKTOP_NODE_NAME       DD_MIMETYPE_NAMESPACE "pane.tab.name"
#define DD_LABEL_DESKTOP_NODE_NAME      "Pane Tab"

#define DD_DATA_DOPDATA_PYTHON          DD_MIMETYPE_NAMESPACE "dop.data.python"
#define DD_LABEL_DOPDATA_PYTHON         "Dop Data as Python expression"
#define DD_DATA_DOPDATA_HSCRIPT_FLOAT   DD_MIMETYPE_NAMESPACE \
                                            "dop.data.hscript.float"
#define DD_LABEL_DOPDATA_HSCRIPT_FLOAT  "Dop Data as Hscript float"
#define DD_DATA_DOPDATA_HSCRIPT_STRING  DD_MIMETYPE_NAMESPACE \
                                            "dop.data.hscript.string"
#define DD_LABEL_DOPDATA_HSCRIPT_STRING "Dop Data as Hscript string"

// Returns a path to a primitive, which is essentially the SOP path
// ('/obj/foo/mysop') plus the primitive path name (can be partial) separated
// by a colon (e.g: '/obj/foo/mysop:/alembic/foo/prim')
#define DD_DATA_PRIM_PATH               DD_MIMETYPE_NAMESPACE "primitive.path"
#define DD_LABEL_PRIM_PATH              "Primitive Path"

// returns three elements separated by colons, corresponding to a
// multiparm instance:
// 1. The path to the node containing the multiparm
// 2. The multiparm's token
// 3. The index of the multiparm instance
#define DD_DATA_MULTIPARM_INSTANCE              DD_MIMETYPE_NAMESPACE "multiparm"
#define DD_LABEL_MULTIPARM_INSTANCE_NAME        "Multiparm Instance"

// Visualizder
#define DD_DATA_VISUALIZER              DD_MIMETYPE_NAMESPACE "visualizer"
#define DD_LABEL_VISUALIZER             "Visualizer"

// USD Primitives and collections
#define DD_DATA_USDPRIMPATH \
        DD_MIMETYPE_NAMESPACE "usd.primitive.path"
#define DD_DATA_USDPRIMPYTHON \
        DD_MIMETYPE_NAMESPACE "usd.primitive.python"
#define DD_LABEL_USDPRIMPYTHON "USD Primitive as Python expression"
#define DD_DATA_USDPROPERTYPATH \
        DD_MIMETYPE_NAMESPACE "usd.property.path"
#define DD_DATA_USDPROPERTYPYTHON \
        DD_MIMETYPE_NAMESPACE "usd.property.python"
#define DD_LABEL_USDPROPERTYPYTHON "USD Property as Python expression"
#define DD_DATA_OPPATH_AND_USDPRIMPATH \
        DD_MIMETYPE_NAMESPACE "node.and.usd.primitive.path"

//
// Some attributes which receivers can derive given the above
//

//
// parameter
//

#define DD_DATA_CHAN_VALUE      DD_MIMETYPE_NAMESPACE "chan.value"
#define DD_LABEL_CHAN_VALUE     "Current Channel Value"


#define DD_DATA_CHAN_EXPR       DD_MIMETYPE_NAMESPACE "chan.express"
#define DD_LABEL_CHAN_EXPR      "Channel Expression"

#define DD_DATA_CHAN_REF_ABS    DD_MIMETYPE_NAMESPACE "chan.ref.abs"
#define DD_LABEL_CHAN_REF_ABS   "Absolute Channel Reference"

#define DD_DATA_CHAN_REF_REL    DD_MIMETYPE_NAMESPACE "chan.ref.rel"
#define DD_LABEL_CHAN_REF_REL   "Relative Channel Reference"

#define DD_DATA_COPY_CHANNEL    DD_MIMETYPE_NAMESPACE "copy.channel"
#define DD_LABEL_COPY_CHANNEL   "Copy Channel"

#define DD_DATA_CHAN_GROUPS     DD_MIMETYPE_NAMESPACE "chgroups"
#define DD_LABEL_CHAN_GROUPS    "Channel Groups"

#define DD_DATA_SI_TREENODES    DD_MIMETYPE_NAMESPACE "si.tree.nodes"

//
// chop
//
//

#define DD_DATA_TRACK_VALUE     DD_MIMETYPE_NAMESPACE "chop.value"
#define DD_LABEL_TRACK_VALUE    "Current CHOP Value"

#define DD_DATA_TRACK_REF_ABS   DD_MIMETYPE_NAMESPACE "chop.ref.abs"
#define DD_LABEL_TRACK_REF_ABS  "CHOP Reference"

#define DD_DATA_TRACK_REF_REL   DD_MIMETYPE_NAMESPACE "chop.ref.rel"
#define DD_LABEL_TRACK_REF_REL  "Relative CHOP Reference"

#define DD_DATA_TRACK_EXPORT    DD_MIMETYPE_NAMESPACE "chop.export"
#define DD_LABEL_TRACK_EXPORT   "Export CHOP"

//
// top
//
//

#define DD_DATA_WORKITEM_ID     DD_MIMETYPE_NAMESPACE "workitem.id"
#define DD_LABEL_WORKITEM_ID    "Work Item ID"

#endif