DM/DM_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.
 *
 * Produced by:
 *      Cristin Barghiel
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        Direct manipulation library (C++)
 *
 * COMMENTS:
 *      Definitions for DM.
 *
 */

#ifndef __DM_Defines_H__
#define __DM_Defines_H__

#include <UT/UT_RefArray.h>
#include <GU/GU_SelectType.h>
#include <BM/BM_KeyBindings.h>

//------------------------------ Drawing ----------------------------------

// Draw all the points or primitives, or just the selected:
#define DM_DRAW_SELECTED        0x01
#define DM_DRAW_NONSELECTED     0x02
#define DM_DRAW_ALL             (DM_DRAW_SELECTED | DM_DRAW_NONSELECTED)

//------------------------------ Picking ----------------------------------

// Make sure these are >= GU_PICK_OTHER and keep them exclusive!
#define DM_PICK_HANDLEPOINT     0x00002000
#define DM_PICK_HANDLEEDGE      0x00004000
#define DM_PICK_FLOORPOINT      0x00008000
#define DM_PICK_FLOOREDGE       0x00010000
#define DM_PICK_UVTILEPOINT     0x00020000
#define DM_PICK_UVTILEEDGE      0x00040000

#define DM_PICKED_NOTHING       0
#define DM_PICKED_POINT         1
#define DM_PICKED_EDGE          2
#define DM_PICKED_NORMAL        3

//---------------------------- Selection Styles ------------------------------

enum DM_SelectionStyle
{
    DM_STYLE_UNKNOWN = -1,
    DM_STYLE_BOX_PICK = 0,
    DM_STYLE_LASSO_PICK,
    DM_STYLE_BRUSH_PICK,
    DM_STYLE_NUM_ENTRIES    // sentinel
};

//---------------------------- Handle Pick Ids -------------------------------
#define DM_X_AXIS               'X'
#define DM_Y_AXIS               'Y'
#define DM_Z_AXIS               'Z'
#define DM_x_AXIS               'x'
#define DM_y_AXIS               'y'
#define DM_z_AXIS               'z'

//----------------------------- Miscellaneous --------------------------------

#define DM_ROTATE_BY            45      // degrees to rotate by

// the information that goes in the float-array of UI_Value AFTER the screen
// co-ordinates are changed to 3D co-ordinates (includes information gathered
// by snapping)
enum DM_VALUE_3D
{
    //_Index:___________//_Array contents:_
    DM_VALUE_X = 0,     // x coordinate
    DM_VALUE_Y,         // y coordinate
    DM_VALUE_Z,         // z coordinate
    DM_VALUE_W,         // w coordinate
    DM_VALUE_PID,       // point # (for point) or prim # (for anything else)
    DM_VALUE_TYPE,      // point, edge, primitive, etc. -- use GU_PICK_...
    DM_VALUE_E1,        // pt1 for edge, u for breakpoint, -1 for other
    DM_VALUE_E2,        // pt2 for edge, v for surface breakpoint, -1 for other
    DM_VALUE_OPID,      // node to whom the geo detail belongs
    DM_VALUE_GEOIDX,    // index within the GUI_DetailLook
    DM_VALUE_NORMALFLAG,// whether the normal is in use
    DM_VALUE_NX,        // x component of the normal
    DM_VALUE_NY,        // y component of the normal    
    DM_VALUE_NZ,        // z component of the normal


    DM_VALUE_DIMENSION  // keeps track of # of entries; should always be last!
};


/// symbol font defines used by several derived classes:
#define DM_SYMBOL_PIVOT_OBSCURE         1  ///< square
#define DM_SYMBOL_CV                    8
#define DM_SYMBOL_POINT                 9  ///< filled circle / bullet
#define DM_SYMBOL_LINE_ORIGIN           10 ///< filled square (arrow tail, xsection)

enum {
    DM_OBJ_GEO                  = 0x00000001,
    DM_OBJ_CAM                  = 0x00000002,
    DM_OBJ_LIGHT                = 0x00000004,
    DM_OBJ_BONE                 = 0x00000008,
    DM_OBJ_NULL                 = 0x00000010,
    DM_OBJ_BLEND                = 0x00000020,
    DM_OBJ_OTHER                = 0x00000040,
    DM_OBJ_ALL                  = 0x0000007F
};

enum {
    DM_UVSEL_ALLOW_FRONT_AND_BACK = 0,
    DM_UVSEL_ALLOW_FRONT,
    DM_UVSEL_ALLOW_BACK,
    DM_UVSEL_ALLOW_NUM
};

enum {
    DM_SEL_CONNECTIVITY_VIEWPORT = 0,
    DM_SEL_CONNECTIVITY_3D,
    DM_SEL_CONNECTIVITY_UV,
    DM_SEL_CONNECTIVITY_NUM_ENTRIES
};

enum {
    DM_CLIPPLANE_TOP    = 0,
    DM_CLIPPLANE_BOTTOM,
    DM_CLIPPLANE_LEFT,
    DM_CLIPPLANE_RIGHT,
    DM_CLIPPLANE_FRONT,
    DM_CLIPPLANE_BACK,
    DM_NUM_CLIPPLANES
};

// This enum must be kept in sync with the selection_mode.val radio strip 
// in $FUSE/ViewExtra.ui!
enum DM_SelectMode
{
    DM_SELECTMODE_INVALID = -1,
    DM_SELECTMODE_OBJECT = 0,
    DM_SELECTMODE_GEOMETRY,
    DM_SELECTMODE_PARTICLE,
    DM_SELECTMODE_DYNAMICS,
    DM_NUM_SELECTMODES  // sentinel
};

// This enum must be kept in sync with the geometry_type.val radio strip 
// in $FUSE/ViewExtra.ui!
enum DM_GeometryType
{
    DM_GEOTYPE_INVALID = -1,
    DM_GEOTYPE_POINTS = 0,
    DM_GEOTYPE_EDGES,
    DM_GEOTYPE_PRIMITIVES,
    DM_GEOTYPE_VERTICES,
    DM_GEOTYPE_BREAKPOINTS,
    DM_GEOTYPE_POINTGROUPS,
    DM_GEOTYPE_PRIMITIVEGROUPS,
    DM_NUM_GEOTYPES     // sentinel
};

enum DM_PopSelectMode
{
    DM_POPSELECTMODE_PARTICLES = 0,
    DM_POPSELECTMODE_NODES,
    DM_NUM_POPSELECTMODES       // sentinel
};

enum DM_DopSelectMode
{
    DM_DOPSELECTMODE_DETAILS = 0,
    DM_DOPSELECTMODE_POINTS,
    DM_NUM_DOPSELECTMODES       // sentinel
};

typedef UT_RefArray<DM_GeometryType> DM_GeometryTypeArray;

#define DM_PRIMARY_BUTTON       UI_LEFT_BUTTON
#define DM_SECONDARY_BUTTON     UI_MIDDLE_BUTTON
#define DM_TERTIARY_BUTTON      UI_RIGHT_BUTTON

#define DM_SELECTDRAG_BUTTON    UI_LEFT_BUTTON
#define DM_SAFESELECT_BUTTON    UI_MIDDLE_BUTTON
#define DM_FINISH_BUTTON        UI_RIGHT_BUTTON


#define DM_VIEW_MEMORY_NAME     "View"
#define DM_SNAPSHOT_MEMORY_NAME "Snapshot"

#define DM_LABEL_HOFFSET        0.02
#define DM_LABEL_VOFFSET        0.005

#endif

---