mi32/mstyle.h

Go to the documentation of this file.

/************************************************************************
*
* mi32/mstyle.h - CartoScript functions
*
* Line Style Toolkit 
* \if NODOC
* $Id: mstyle.h_v 1.24 2004/02/12 21:57:26 dwilliss Exp $
* $Log: mstyle.h_v $
* Revision 1.24  2004/02/12 21:57:26  dwilliss
* Don't include deprecated include file that we didn't even need
*
* Revision 1.23  2003/09/15 13:49:56  fileserver!dwilliss
* Doxygen
*
* Revision 1.22  2003/08/11 16:31:32  dwilliss
* Took out the last 4 functions that shouldn't be called by anything but
* the cartoscript module
*
* Revision 1.21  2003/08/11 14:40:06  dwilliss
* Most of the functions are now private to the SML module that implements
* cartoscript since it was the only thing that ever called them.  Their
* prototypes are no longer here.
*
* Revision 1.20  2003/06/16 16:36:15  scowan
* Added forward declaration.
*
* Revision 1.19  2003/06/14 02:10:10  scowan
* Chagned use of dregion to a trans2d mapgen.
*
* Revision 1.18  2002/04/26 22:19:27  dwilliss
* MstyleInit should take CONST pointer for poitns
*
* Revision 1.17  2000/06/27 20:08:17  sparsons
* Genitor documentation.
*
* Revision 1.16  1999/10/21 23:15:46  scowan
* More const stuff.
*
* Revision 1.15  1999/09/27 19:13:14  dwilliss
* Added prototypes for UC versions of text drawing functions
*
* Revision 1.14  1999/04/08 19:06:27  mju
* Add inclusion guards.
*
 * Revision 1.13  1999/01/05  20:39:46  scowan
 * *** empty log message ***
 *
* Revision 1.12  1998/04/28 19:54:18  dfrolov
* move position declaration from lbplace.c
*
 * Revision 1.11  1998/04/28  17:38:52  dfrolov
 * add new functions to the label optimization toolkit
 *
 * Revision 1.10  1998/03/20  20:50:22  dwilliss
 * Added extern "C" stuff
 *
 * Revision 1.9  1997/10/17  15:33:44  dfrolov
 * add new functions
 *
 * Revision 1.8  1997/10/08  18:29:09  dfrolov
 * add MstyleScaleOffset function
 *
 * Revision 1.7  1997/10/01  22:02:40  dfrolov
 * change declaration of MlineInit()
 *
 * Revision 1.6  1997/10/01  21:34:35  dfrolov
 * add more function prototypes
 *
 * Revision 1.5  1997/08/27  15:18:49  dfrolov
 * *** empty log message ***
 *
 * Revision 1.4  1997/08/25  20:15:37  dfrolov
 * add MlabelPlace... functions
 *
 * Revision 1.3  1997/08/12  21:22:35  dfrolov
 * add some more functions
 *
 * Revision 1.2  1997/08/10  21:28:19  dfrolov
 * some changes in function calls
 *
 * Revision 1.1  1997/08/03  22:05:25  dfrolov
 * Initial revision
 *
* \endif
*************************************************************************/

#ifndef  INC_MI32_MSTYLE_H
#define  INC_MI32_MSTYLE_H

#ifndef GENERATING_DOXYGEN_OUTPUT
class TRANS2D_MAPGEN;
#endif 

#define MLINE_FEATURE_NEXTVERTEX    1
#define MLINE_FEATURE_PREVVERTEX    2
#define MLINE_FEATURE_LINEEND       3
#define MLINE_FEATURE_LINEBEGIN     4

typedef void *MLINEHANDLE;
typedef void *LABELHANDLE;

/*************************************************************************

   Label positions relative to center point (+):

   [2] [1]      [6]
      +       [7]+[5] , position 9 - 16 are similar to 1- 8 but shifted 0.25 width/height
   [4] [3]      [8]

   Position 17 is right in the center of the rectangle

*************************************************************************/

#define POSITION_DELETE 0
#define POSITION_1      1
#define POSITION_2      2
#define POSITION_3      3
#define POSITION_4      4
#define POSITION_5      5
#define POSITION_6      6
#define POSITION_7      7
#define POSITION_8      8
#define POSITION_9      9
#define POSITION_10     10
#define POSITION_11     11
#define POSITION_12     12
#define POSITION_13     13
#define POSITION_14     14
#define POSITION_15     15
#define POSITION_16     16
#define POSITION_17     17
#define POSITION_LAST   POSITION_17

#define POSITION_CENTER       POSITION_17
#define POSITION_LEFTBOTTOM   POSITION_1
#define POSITION_RIGHTBOTTOM  POSITION_2
#define POSITION_LEFTUP       POSITION_3
#define POSITION_RIGHTUP      POSITION_4
#define POSITION_CENTERLEFT   POSITION_5
#define POSITION_CENTERBOTTOM POSITION_6
#define POSITION_CENTERRIGHT  POSITION_7
#define POSITION_CENTERUP     POSITION_8

#if defined(__cplusplus)
extern "C" {
#endif


// Label placement optimization routines

int MlabelPlaceInit (
   LABELHANDLE *handle,                
   const DRECT2D *space,               
   INT32 NumLabelsInit                 
   );

int MlabelPlaceAddRect (
   LABELHANDLE handle,                 
   DRECT2D *Label,                     
   INT32 ElemNum,                      
   DOUBLE Rank                         
   );

int MlabelPlaceAddRectAtAnchor (
   LABELHANDLE handle,                 
   DRECT2D *Label,                     
   INT32 ElemNum,                      
   DOUBLE Rank,                        
   DPOINT2D *Anchor                    
   );

int MlabelPlaceAddRectAtPosition (
   LABELHANDLE handle,                 
   DRECT2D *Label,                     
   INT32 ElemNum,                      
   DOUBLE Rank,                        
   int PosIndex                        
   );

int MlabelPlaceOptimize (
   LABELHANDLE handle,                 
   int DoOptimize,                     
   int DoDelete,                       
   INT32 *NumObscured                  
   );

int MlabelPlaceGetLabelPosition (
   LABELHANDLE handle,                 
   INT32 ElemNum,                      
   DRECT2D *rect                       
   );

int MlabelPlaceFree (
   LABELHANDLE handle                  
   );

int MlabelPlaceGetPositionFactors (
   LABELHANDLE handle,                 
   DOUBLE *PosWeight,                  


   UINT8 startentry,                   
   UINT8 numentries                    
   );

int MlabelPlaceSetPositionFactors (
   LABELHANDLE handle,                 
   DOUBLE *PosWeight,                  


   UINT8 startentry,                   
   UINT8 numentries                    
   );


#if defined(__cplusplus)
}                       
#endif

#endif   

---