dm.h

Go to the documentation of this file.

/*                          D M . H
 * BRL-CAD
 *
 * Copyright (c) 1993-2006 United States Government as represented by
 * the U.S. Army Research Laboratory.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this file; see the file named COPYING for more
 * information.
 */
/** @addtogroup libdm */
/*@{*/
/** @file dm.h
 *
 */
#ifndef SEEN_DM_H
#define SEEN_DM_H

#ifndef DM_EXPORT
#if defined(_WIN32) && !defined(__CYGWIN__) && defined(BRLCAD_DLL)
#  ifdef DM_EXPORT_DLL
#    define DM_EXPORT __declspec(dllexport)
#  else
#    define DM_EXPORT __declspec(dllimport)
#  endif
#else
#  define DM_EXPORT
#endif
#endif

#ifndef SEEN_BU_H
#  include <bu.h>
#endif

#ifdef USE_FBSERV
#  include "fbserv_obj.h"
#endif

#define DM_NULL (struct dm *)NULL
#define DM_MIN (-2048)
#define DM_MAX (2047)
#define X       0
#define Y       1
#define Z       2

#define DM_O(_m) offsetof(struct dm, _m)

#define GED_MAX 2047.0
#define GED_MIN -2048.0
#define GED_RANGE 4095.0
#define INV_GED 0.00048828125
#define INV_4096 0.000244140625

/*
 * Display coordinate conversion:
 *  GED is using -2048..+2048,
 *  X is 0..width,0..height
 */
#define DIVBY4096(x) (((double)(x))*INV_4096)
#define GED_TO_Xx(_dmp, x) ((int)((DIVBY4096(x)+0.5)*_dmp->dm_width))
#define GED_TO_Xy(_dmp, x) ((int)((0.5-DIVBY4096(x))*_dmp->dm_height))
#define Xx_TO_GED(_dmp, x) ((int)(((x)/(double)_dmp->dm_width - 0.5) * GED_RANGE))
#define Xy_TO_GED(_dmp, x) ((int)((0.5 - (x)/(double)_dmp->dm_height) * GED_RANGE))

#if IR_KNOBS
#define NOISE 16                /* Size of dead spot on knob */
#endif

/* the font used depends on the size of the window opened */
#define FONTBACK        "-adobe-courier-medium-r-normal--10-100-75-75-m-60-iso8859-1"
#define FONT5   "5x7"
#define FONT6   "6x10"
#define FONT7   "7x13"
#define FONT8   "8x13"
#define FONT9   "9x15"

/* Display Manager Types */
#define DM_TYPE_BAD     -1
#define DM_TYPE_NULL    0
#define DM_TYPE_PLOT    1
#define DM_TYPE_PS      2
#define DM_TYPE_X       3
#define DM_TYPE_OGL     4
#define DM_TYPE_GLX     5
#define DM_TYPE_PEX     6
#define DM_TYPE_WGL     7

/* Line Styles */
#define DM_SOLID_LINE 0
#define DM_DASHED_LINE 1

#define IS_DM_TYPE_NULL(_t) ((_t) == DM_TYPE_NULL)
#define IS_DM_TYPE_PLOT(_t) ((_t) == DM_TYPE_PLOT)
#define IS_DM_TYPE_PS(_t) ((_t) == DM_TYPE_PS)
#define IS_DM_TYPE_X(_t) ((_t) == DM_TYPE_X)
#define IS_DM_TYPE_OGL(_t) ((_t) == DM_TYPE_OGL)
#define IS_DM_TYPE_GLX(_t) ((_t) == DM_TYPE_GLX)
#define IS_DM_TYPE_PEX(_t) ((_t) == DM_TYPE_PEX)
#define IS_DM_TYPE_WGL(_t) ((_t) == DM_TYPE_WGL)

#define GET_DM(p,structure,w,hp) { \
        register struct structure *tp; \
        for(BU_LIST_FOR(tp, structure, hp)) { \
                if(w == tp->win) { \
                        (p) = tp; \
                        break; \
                } \
        } \
\
        if(BU_LIST_IS_HEAD(tp, hp)) \
                p = (struct structure *)NULL; \
}

/*  Colors */
#define DM_COLOR_HI     ((short)230)
#define DM_COLOR_LOW    ((short)0)
#define DM_BLACK_R      DM_COLOR_LOW
#define DM_BLACK_G      DM_COLOR_LOW
#define DM_BLACK_B      DM_COLOR_LOW
#define DM_RED_R        DM_COLOR_HI
#define DM_RED_G        DM_COLOR_LOW
#define DM_RED_B        DM_COLOR_LOW
#define DM_BLUE_R       DM_COLOR_LOW
#define DM_BLUE_G       DM_COLOR_LOW
#define DM_BLUE_B       DM_COLOR_HI
#define DM_YELLOW_R     DM_COLOR_HI
#define DM_YELLOW_G     DM_COLOR_HI
#define DM_YELLOW_B     DM_COLOR_LOW
#define DM_WHITE_R      DM_COLOR_HI
#define DM_WHITE_G      DM_COLOR_HI
#define DM_WHITE_B      DM_COLOR_HI
#define DM_BLACK        DM_BLACK_R, DM_BLACK_G, DM_BLACK_B
#define DM_RED          DM_RED_R, DM_RED_G, DM_RED_B
#define DM_BLUE         DM_BLUE_R, DM_BLUE_G, DM_BLUE_B
#define DM_YELLOW       DM_YELLOW_R, DM_YELLOW_G, DM_YELLOW_B
#define DM_WHITE        DM_WHITE_R, DM_WHITE_G, DM_WHITE_B
#define DM_COPY_COLOR(_dr,_dg,_db,_sr,_sg,_sb){\
        (_dr) = (_sr);\
        (_dg) = (_sg);\
        (_db) = (_sb); }
#define DM_SAME_COLOR(_dr,_dg,_db,_sr,_sg,_sb)(\
        (_dr) == (_sr) &&\
        (_dg) == (_sg) &&\
        (_db) == (_sb))

/* Command parameter to dmr_viewchange() */
#define DM_CHGV_REDO    0       /* Display has changed substantially */
#define DM_CHGV_ADD     1       /* Add an object to the display */
#define DM_CHGV_DEL     2       /* Delete an object from the display */
#define DM_CHGV_REPL    3       /* Replace an object */
#define DM_CHGV_ILLUM   4       /* Make new object the illuminated object */

/*
 * Definitions for dealing with the buttons and lights.
 * BV are for viewing, and BE are for editing functions.
 */
#define LIGHT_OFF       0
#define LIGHT_ON        1
#define LIGHT_RESET     2               /* all lights out */

struct dm_vars {
  genptr_t pub_vars;
  genptr_t priv_vars;
};

/**
 * Interface to a specific Display Manager
 */
struct dm {
  int (*dm_close)();
  int (*dm_drawBegin)();        /**< @brief formerly dmr_prolog */
  int (*dm_drawEnd)();          /**< @brief formerly dmr_epilog */
  int (*dm_normal)();
  int (*dm_loadMatrix)();
  int (*dm_drawString2D)();     /**< @brief formerly dmr_puts */
  int (*dm_drawLine2D)();       /**< @brief formerly dmr_2d_line */
  int (*dm_drawPoint2D)();
  int (*dm_drawVList)();        /**< @brief formerly dmr_object */
  int (*dm_setFGColor)(struct dm *dmp, unsigned char r, unsigned char g, unsigned char b, int strict, fastf_t transparency);
  int (*dm_setBGColor)(struct dm *, unsigned char, unsigned char, unsigned char);
  int (*dm_setLineAttr)();      /**< @brief currently - linewidth, (not-)dashed */
  int (*dm_configureWin)();
  int (*dm_setWinBounds)();
  int (*dm_setLight)();
  int (*dm_setTransparency)();
  int (*dm_setDepthMask)();
  int (*dm_setZBuffer)();
  int (*dm_debug)();            /**< @brief Set DM debug level */
  int (*dm_beginDList)();
  int (*dm_endDList)();
  int (*dm_drawDList)();
  int (*dm_freeDLists)();
  unsigned long dm_id;          /**< @brief window id */
  int dm_displaylist;           /**< @brief !0 means device has displaylist */
  int dm_stereo;                /**< @brief stereo flag */
  double dm_bound;              /**< @brief zoom-in limit */
  int dm_boundFlag;
  char *dm_name;                /**< @brief short name of device */
  char *dm_lname;               /**< @brief long name of device */
  int dm_type;                  /**< @brief display manager type */
  int dm_top;                   /**< @brief !0 means toplevel window */
  int dm_width;
  int dm_height;
  int dm_lineWidth;
  int dm_lineStyle;
  fastf_t dm_aspect;
  fastf_t *dm_vp;               /**< @brief XXX--ogl still depends on this--Viewscale pointer */
  struct dm_vars dm_vars;       /**< @brief display manager dependant variables */
  struct bu_vls dm_pathName;    /**< @brief full Tcl/Tk name of drawing window */
  struct bu_vls dm_tkName;      /**< @brief short Tcl/Tk name of drawing window */
  struct bu_vls dm_dName;       /**< @brief Display name */
  unsigned char dm_bg[3];       /**< @brief background color */
  unsigned char dm_fg[3];       /**< @brief foreground color */
  vect_t dm_clipmin;            /**< @brief minimum clipping vector */
  vect_t dm_clipmax;            /**< @brief maximum clipping vector */
  int dm_debugLevel;            /**< @brief !0 means debugging */
  int dm_perspective;           /**< @brief !0 means perspective on */
  int dm_light;                 /**< @brief !0 means lighting on */
  int dm_transparency;          /**< @brief !0 means transparency on */
  int dm_depthMask;             /**< @brief !0 means depth buffer is writable */
  int dm_zbuffer;               /**< @brief !0 means zbuffer on */
  int dm_zclip;                 /**< @brief !0 means zclipping */
  int dm_clearBufferAfter;      /**< @brief 1 means clear back buffer after drawing and swap */
  Tcl_Interp *dm_interp;        /**< @brief Tcl interpreter */
};

/**
 *                      D M _ O B J
 *@brief
 * A display manager object is used for interacting with a display manager.
 */
struct dm_obj {
  struct bu_list        l;
  struct bu_vls         dmo_name;               /**< @brief display manager object name/cmd */
  struct dm             *dmo_dmp;               /**< @brief display manager pointer */
#ifdef USE_FBSERV
  struct fbserv_obj     dmo_fbs;                /**< @brief fbserv object */
#endif
  struct bu_observer    dmo_observers;          /**< @brief fbserv observers */
  mat_t                 viewMat;
  int                   (*dmo_drawLabelsHook)();
  void                  *dmo_drawLabelsHookClientData;
};

#define DM_OPEN(_type,_argc,_argv) dm_open(_type,_argc,_argv)
#define DM_CLOSE(_dmp) _dmp->dm_close(_dmp)
#define DM_DRAW_BEGIN(_dmp) _dmp->dm_drawBegin(_dmp)
#define DM_DRAW_END(_dmp) _dmp->dm_drawEnd(_dmp)
#define DM_NORMAL(_dmp) _dmp->dm_normal(_dmp)
#define DM_LOADMATRIX(_dmp,_mat,_eye) _dmp->dm_loadMatrix(_dmp,_mat,_eye)
#define DM_DRAW_STRING_2D(_dmp,_str,_x,_y,_size,_use_aspect)\
     _dmp->dm_drawString2D(_dmp,_str,_x,_y,_size,_use_aspect)
#define DM_DRAW_LINE_2D(_dmp,_x1,_y1,_x2,_y2) _dmp->dm_drawLine2D(_dmp,_x1,_y1,_x2,_y2)
#define DM_DRAW_POINT_2D(_dmp,_x,_y) _dmp->dm_drawPoint2D(_dmp,_x,_y)
#define DM_DRAW_VLIST(_dmp,_vlist) _dmp->dm_drawVList(_dmp,_vlist)
#define DM_SET_FGCOLOR(_dmp,_r,_g,_b,_strict,_transparency) _dmp->dm_setFGColor(_dmp,_r,_g,_b,_strict,_transparency)
#define DM_SET_BGCOLOR(_dmp,_r,_g,_b) _dmp->dm_setBGColor(_dmp,_r,_g,_b)
#define DM_SET_LINE_ATTR(_dmp,_width,_dashed) _dmp->dm_setLineAttr(_dmp,_width,_dashed)
#define DM_CONFIGURE_WIN(_dmp) _dmp->dm_configureWin(_dmp)
#define DM_SET_WIN_BOUNDS(_dmp,_w) _dmp->dm_setWinBounds(_dmp,_w)
#define DM_SET_LIGHT(_dmp,_on) _dmp->dm_setLight(_dmp,_on)
#define DM_SET_TRANSPARENCY(_dmp,_on) _dmp->dm_setTransparency(_dmp,_on)
#define DM_SET_DEPTH_MASK(_dmp,_on) _dmp->dm_setDepthMask(_dmp,_on)
#define DM_SET_ZBUFFER(_dmp,_on) _dmp->dm_setZBuffer(_dmp,_on)
#define DM_DEBUG(_dmp,_lvl) _dmp->dm_debug(_dmp,_lvl)
#define DM_BEGINDLIST(_dmp,_list) _dmp->dm_beginDList(_dmp,_list)
#define DM_ENDDLIST(_dmp) _dmp->dm_endDList(_dmp)
#define DM_DRAWDLIST(_dmp,_list) _dmp->dm_drawDList(_dmp,_list)
#define DM_FREEDLISTS(_dmp,_list,_range) _dmp->dm_freeDLists(_dmp,_list,_range)

DM_EXPORT extern struct dm dm_Null;

#ifdef BRLCAD_DEBUG
DM_EXPORT BU_EXTERN(int Dm_d_Init,
                    ());
#else
DM_EXPORT BU_EXTERN(int Dm_Init,
                    ());
#endif
DM_EXPORT BU_EXTERN(struct dm *dm_open,
                    (Tcl_Interp *interp,
                     int type,
                     int argc,
                     char *argv[]));
DM_EXPORT BU_EXTERN(int dm_share_dlist,
                    (struct dm *dmp1,
                     struct dm *dmp2));
DM_EXPORT BU_EXTERN(fastf_t dm_Xx2Normal,
                    (struct dm *dmp,
                     register int x));
DM_EXPORT BU_EXTERN(int dm_Normal2Xx,
                    (struct dm *dmp,
                     register fastf_t f));
DM_EXPORT BU_EXTERN(fastf_t dm_Xy2Normal,
                    (struct dm *dmp,
                     register int y,
                     int use_aspect));
DM_EXPORT BU_EXTERN(int dm_Normal2Xy,
                    (struct dm *dmp,
                     register fastf_t f,
                     int use_aspect));
DM_EXPORT BU_EXTERN(void dm_fogHint,
                    (struct dm *dmp,
                     int fastfog));
DM_EXPORT BU_EXTERN(int dm_processOptions,
                    ());
DM_EXPORT BU_EXTERN(int dm_limit,
                    (int i));
DM_EXPORT BU_EXTERN(int dm_unlimit,
                    (int i));
DM_EXPORT BU_EXTERN(fastf_t dm_wrap,
                    (fastf_t f));
DM_EXPORT BU_EXTERN(void Nu_void,
                    ());
DM_EXPORT BU_EXTERN(struct dm *Nu_open,
                    ());
DM_EXPORT BU_EXTERN(int Nu_int0,
                    ());
DM_EXPORT BU_EXTERN(unsigned Nu_unsign,
                    ());

/* vers.c */
DM_EXPORT extern char dm_version[];

/* clip.c */
DM_EXPORT BU_EXTERN(int clip,
                    (fastf_t *,
                     fastf_t *,
                     fastf_t *,
                     fastf_t *));
DM_EXPORT BU_EXTERN(int vclip,
                    (fastf_t *,
                     fastf_t *,
                     register fastf_t *,
                     register fastf_t *));

/* axes.c */
DM_EXPORT BU_EXTERN(void dmo_drawAxes_cmd,
                    (struct dm *dmp,
                     fastf_t viewSize,
                     mat_t rmat,
                     point_t axesPos,
                     fastf_t axesSize,
                     int *axesColor,
                     int *labelColor,
                     int lineWidth,
                     int posOnly,
                     int threeColor,
                     int tickEnable,
                     int tickLen,
                     int majorTickLen,
                     fastf_t tickInterval,
                     int ticksPerMajor,
                     int *tickColor,
                     int *majorTickColor,
                     int tickThreshold));

#endif /* SEEN_DM_H */
/*@}*/
/*
 * Local Variables:
 * mode: C
 * tab-width: 8
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 * ex: shiftwidth=4 tabstop=8
 */

---