referencia_mapscript

REFERENCIA DE LAS CLASES, METODOS Y  PROPIEDADES DE PHP/MAPSCRIPT 4.0 Notas muy importantes: •

•

Los nombres de constantes y variables miembro de una clase son sensibles a la escritura en PHP. Muchas funciones de Mapscript(todas aquellas que acceden archivos en el fondo como ms_newMapObj(), drawMap(), etc) afectarán el valor del Directorio de Trabajo Actual(DTA) en el ambiente de PHP.

Constantes:

Las siguientes constantes de Mapserver están disponibles:  Valores Booleanos: MS_TRUE, MS_FALSE, MS_ON, MS_OFF, MS_YES, MS_NO Unidades del Mapa: MS_INCHES, MS_FEET, MS_MILES, MS_METERS, MS_KILOMETERS, MS_DD, MS_PIXELS Tipos de Capas: MS_LAYER_POINT, MS_LAYER_LINE, MS_LAYER_POLYGON, MS_LAYER_RASTER, MS_LAYER_ANNOTATION, MS_LAYER_QUERY, MS_LAYER_CIRCLE Estado de Capa/Leyenda/Barra escala/Clase: MS_ON, MS_OFF, MS_DEFAULT, MS_EMBED, MS_DELETE Tipos de Fuente: MS_TRUETYPE, MS_BITMAP Posiciones de Etiqueta: MS_UL, MS_LR, MS_UR, MS_LL, MS_CR, MS_CL, MS_UC, MS_LC, MS_CC, MS_AUTO, MS_XY  Estilos de Fuente Bitmap: MS_TINY , MS_SMALL, MS_MEDIUM, MS_LARGE, MS_GIANT

Tipos de Figuras: MS_SHAPE_POINT, MS_SHAPE_NULL

MS_SHAPE_LINE,

MS_SHAPE_POLYGON,

Tipos de Archivos Shape: MS_SHP_POINT, MS_SHP_ARC, MS_SHP_POLYGON, MS_SHP_MULTIPOINT Tipos de Consulta/Unión: MS_SINGLE, MS_MULTIPLE Estilos del Mapa de Consulta: MS_NORMAL, MS_HILITE, MS_SELECTED Tipos de Conexión: MS_INLINE, MS_SHAPEFILE, MS_TILED_SHAPEFILE, MS_SDE, MS_OGR, MS_TILED_OGR, MS_POSTGIS, MS_WMS, MS_ORACLESPATIAL Tipos de Imagen de Salida: MS_GIF, MS_PNG, MS_JPEG, MS_WBMP Funciones:

string ms_GetVersion() Retorna la versión del Mapserver y opciones en una cadena. Esta cadena puede ser parseada para encontrar cuales módulos fueron compilados, etc... array ms_TokenizeMap(string nombre_archivo_mapa) Preparsea un Mapfile a través del Parser del Mapserver y retorna un arreglo con un ítem por cada token del Mapfile. Las cadenas, expresiones lógicas, expresiones regex y comentarios son retornados como tokens individuales. Clase MapObj:

Constructor: mapObj ms_newMapObj(string nom_archivo_mapa [, string

nueva_ruta_mapa])

Retorna un nuevo objeto para tratar con un archivo de mapa de Mapserver. Por defecto, las rutas de SYMBOLSET, FONTSET, y otras en el Mapfile son relativas a la localización del Mapfile. Si se establece nueva_ruta_mapa entonces este

directorio será usado como ruta base para todas las rutas relativas dentro del Mapfile. Miembros: int numlayers (solo-lectura) string name int status int width int height int transparent int interlace int imagetype int imagequality int resolution (Píxeles por pulgada, por defecto 72) rectObj extent; double cellsize int units (tipo de unidades del mapa) double scale (solo-lectura, establecidas por drawMap()) string shapepath int keysizex int keysizey int keyspacingx int keyspacingy webObj web referenceMapObj reference colorObj imagecolor scalebarObj scalebar legendObj legend string symbolsetfilename (solo-lectura, establecida por setSymbolSet()) string fontsetfilename (solo-lectura, establecida por setFontSet()) Métodos: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores. int addColor(int r, int v, int a)  Adiciona un color a la paleta del mapa. Retorna el índice del color. int getsymbolbyname(string symbol_name) Retorna el índice del símbolo usando el nombre.

void preparequery() Calcula la escala del mapa y la asigna al Map->scale, imageObj prepareImage() Retorna un manejador a un objeto de imagen blanco. imageObj draw() Dibuja el mapa y retorna un manejador a un objeto de imagen. imageObj drawQuery() Dibuja el mapa consultado y retorna un manejador a un objeto de imagen. imageObj drawLegend() Dibuja la leyenda del mapa retorna un manejador a un objeto de imagen. imageObj drawReferenceMap() Dibuja el mapa de referencia y retorna un manejador a un objeto de imagen. imageObj drawScaleBar() Dibuja la barra de escala y retorna un manejador a un objeto de imagen. int embedlegend(imageObj image) Embebe una leyenda. Actualmente la leyenda es adicionada solamente al cache de etiquetas, así que se debe invocar drawLabelCache() para actualizar la generación.(A menos que el atributo postlabelcache este establecido, en tal caso es dibujado correctamente.) int embedScalebar(imageObj imagen) Embebe una barra de escala. Actualmente la leyenda es adicionada solamente al cache de etiquetas, así que se debe invocar drawLabelCache() para actualizar la generación.(A menos que el atributo postlabelcache este establecido, en tal caso es dibujado correctamente.) int drawLabelCache(imageObj imagen) Dibuja las etiquetas para un mapa. Retorna –1 si hay error. layerObj getLayer(int index) Retorna un objeto layerObj del mapa dado un valor de índice(0 = primer capa). layerObj getLayerByName(string nombre_capa) Retorna un objeto layerObj del mapa dado un nombre de capa. colorObj getcolorbyindex(int iCloIndex) Retorna un objeto colorObj correspondiente al índice del color en la paleta.

void setextent(double minx, double miny, double maxx, double maxy) Establece la extensión del mapa usando la extensión georeferenciada pasada como argumento. void zoompoint(int nZoomFactor, pointObj oPixelPos, int nImageWidth, int nImageHeight, rectObj oGeorefExt) Realiza un Zoom a una posicio XY. Los parámetros son: - Zoom factor : Valores positivos hacen un acercamiento, valores negativos un alejamiento. Con un factor = 1 se recentra el mapa y con 0 se realiza un pan. - PíxelPos (pointObj) : Coordenadas X,Y del click teniendo (0,0) la esquina superior izquierda. - Width : Ancho en píxel de la imagen actual. - Height : Alto en píxel de la imagen actual. - Georef extent (rectObj) : Extensión Actual georeferenciada. - MaxGeoref extent (rectObj) : (opcional) Máxima extensión. Si se introduce entonces será imposible realizar un Zoom/Pan fuera de este rango. void zoomrectange(rectObj oPixelExt, int nImageWidth, int nImageHeight rectObj oGeorefExt) Establece la extensión del mapa a una extensión dada. Los parámetros son: - PixelExt, con (0,0) como la esquina superior izquierda. - Width : Ancho en píxel de la imagen actual. - Height : Alto en píxel de la imagen actual. - Georef extent (rectObj) : La extensión actual georeferenciada. void zoomscale(int nScale, pointObj oPixelPos, int nImageWidth, int nImageHeight, rectObj oGeorefExt)  Acerca o Aleja a una posicion XY luego el mapa se mostrará a una escala especificada Los parámetros son: - Scale : Escala a la que el mapa será mostrado. - PíxelPos (pointObj) : Coordenadas X,Y del click teniendo (0,0) la esquina superior izquierda. - Width : Ancho en píxel de la imagen actual. - Height : Alto en píxel de la imagen actual.

- Georef extent (rectObj) : Extensión Actual georeferenciada. - MaxGeoref extent (rectObj) : (opcional) Máxima extensión georeferenciada. Si se provee entonces será imposible realizar un zomm/pan fuera de estas extensiones. int queryByPoint(pointObj point, int mode, double buffer) Consulta todas las capas seleccionadas en el mapa en la ubicación del punto especificado en coordenadas de mapa georeferenciadas.(No en píxeles). La consulta se realiza sobre todos las figuras que hacen parte de una clase(CLASS) la cual contiene un valor de TEMPLATE o que coincide con cualquier clase en una capa que contenga un valor LAYER TEMPLATE. Se utiliza el modo MS_SINGLE o MS_MÚLTIPLE dependiendo del número de resultados que se desea obtener. Pasando como valor del buffer <=0 activa la tolerancia en el archivo de mapa(en píxeles) pero también se puede usar una constante (especificada en unidades de tierra). Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int queryByRect(rectObj rect) Consulta todas las capas en el mapa usando un rectangulo especificado en coordenadas de mapa georeferenciadas (no píxeles). La consulta se realiza sobre todos las figuras que hacen parte de una clase(CLASS) la cual contiene un valor de TEMPLATE o que coincide con cualquier clase en una capa que contenga un valor LAYER TEMPLATE. Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int queryByShape(shapeObj shape) Consulta todas las capas seleccionadas en el mapa basado en una simple figura, la figura debe ser un polígono a este punto. Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int queryByFeatures(int slayer) Realiza una consulta basada en un conjunto de resultados de una capa.  Actualmente los resultados DEBEN estar basados en una capa tipo polígono. Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si

algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int save(string nombre_archivo) Guarda el estado del objeto de mapa actual a un archivo. Retorna –1 si hay error. char getProjection() Retorna una representación en cadena de la proyección. Si no se establece ninguna proyección, se retorna MS_FALSE. int setProjection(string proj_params, boolean bSetUnitsAndExtents) Establece la proyección del mapa y el sistema de coordenadas. Los parámetros están dados como una cadena simple delimitado por comas. El argumento: bSetUnitsAndExtents es usado para actualizar automáticamente las unidades del mapa y extensiones basado en una nueva proyección. Los posibles valores son MS_TRUE y MS_FALSE. El valor por defecto es MS_FALSE. int getMetaData(string nombre) Trae la entrada de los metadatos por medio de un nombre(Almacenado en el objeto WEB del Mapfile). Retorna “” si no existe una entrada con ese nombre. La búsqueda es sensible a la escritura. int setMetaData(string nombre, string valor) Establece la entrada de un metadato para el mapa. (Almacenado en el objeto WEB del Mapfile). Retorna MS_SUCCESS/MS_FAILURE según el caso. array getLayersIndexByGroup(string nombre_grupo) Retorna un arreglo conteniendo todos los índices de las capas dados en un nombre de grupo. array getAllGroupNames() Retorna un arreglo conteniendo todos los nombres de grupo usados en las capas. array getAllLayerNames() Retorna un arreglo conteniendo todos los nombres de las capas. boolean moveLayerUp(int indice_capa) Mueve una capa una posición arriba en la estructura jerárquica del Mapfile. boolean moveLayerDown(int indice_capa) Mueve una capa una posición abajo en la estructura jerárquica del Mapfile.

array getlayersdrawingorder() Retorna un arreglo conteniendo los índices de las capas en el orden en que aparecen en el Mapfile. boolean setlayersdrawingorder(array indice_capa) Establece el orden del arreglo de capas. El argumento pasado debe ser un arreglo valido con todos los índices de las capas. Retorna TRUE si tuvo éxito o sin retorna FALSE. char *processtemplate(array params, boolean generateimages) Procesa el archivo de plantilla especificado en el objeto web y retorna el resultado en un buffer. El procesado consiste en abrir el archivo de plantilla y reemplazar todas las etiquetas encontradas. Solo las etiquetas que tengan un elemento equivalente en el objeto de mapa son reemplazadas(ej. [scale]). Existen dos excepciones a la afirmación anterior: - Las etiquetas [img], [scalebar], [ref], [legend] serían reemplazadas con la url apropiada si el parámetro generateimages se establece a MS_TRUE.(Nota: las imágenes correspondientes a objetos diferentes son generados si los objetos se establecen a MS_ON en el archivo de mapa). - Los usuarios pueden usar el parámetro params para especificar las etiquetas y sus valores. Por ejemplo si el usuario tiene una etiqueta específica llamada [my_etiq] y la quiere reemplazar por “valor de la etiqueta” tendría que hacer: tmparray["my_etiq"] = “valor de la etiqueta”; $map->processtemplate($tmparray, MS_FALSE); char *processquerytemplate(array params) Procesa archivos de plantilla para consultas y retorna el resultado en un buffer.  Véase también: función processtemplate char *processlegendtemplate(array params) Procesa archivos de plantilla para leyendas y retorna el resultado en un buffer.  Véase también: función processtemplate int setSymbolSet(string nombre_archivo) Carga y establece dinámicamente un archivo de símbolos. int getNumSymbols() Retorna el número de símbolos de un mapa. int setFontSet(string fileName) Carga y establece un nuevo fonset.

Clase LayerObj:

Constructor: Los objetos Layer pueden ser retornados por la clase MaoObj, o puede ser creado usando: layerObj ms_newLayerObj(MapObj mapa) Miembros: int numclasses (solo-lectura) int index (solo-lectura) int status (MS_ON, MS_OFF, MS_DEFAULT o MS_DELETE) string classitem string name string group string data int type double tolerance int toleranceunits double symbolscale double minscale double maxscale double labelminscale double labelmaxscale int maxfeatures int offsite int annotate int transform int labelcache int postlabelcache string labelitem string labelsizeitem string labelangleitem string tileitem string tileindex string header string footer string connection int connectiontype string filteritem string template

Métodos: int set(string nombre_propiedad, nuevo_valor) Establece la propiedad especificada del objeto a un nuevo valor. Retorna –1 si hay error. int draw(imageObj imagen) Dibuja una capa simple, adiciona etiquetas. Retorna –1 si hay error. int drawQuery(imageObj imagen) Dibuja una consulta en el mapa para una capa simple. classObj getClass(int classIndex) Retorna un objeto classObj de una capa dada como un valor de índice(0=primera clase) int queryByPoint(pointObj point, int mode, double buffer) Consulta todas las capas seleccionadas en el mapa en la ubicación del punto especificado en coordenadas de mapa georeferenciadas.(No en píxeles). La consulta se realiza sobre todos las figuras que hacen parte de una clase(CLASS) la cual contiene un valor de TEMPLATE o que coincide con cualquier clase en una capa que contenga un valor LAYER TEMPLATE. Se utiliza el modo MS_SINGLE o MS_MÚLTIPLE dependiendo del número de resultados que se desea obtener. Pasando como valor del buffer <=0 activa la tolerancia en el archivo de mapa(en píxeles) pero también se puede usar una constante (especificada en unidades de tierra). Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int queryByRect(rectObj rect) Consulta todas las capas en el mapa usando un rectangulo especificado en coordenadas de mapa georeferenciadas (no píxeles). La consulta se realiza sobre todos las figuras que hacen parte de una clase(CLASS) la cual contiene un valor de TEMPLATE o que coincide con cualquier clase en una capa que contenga un valor LAYER TEMPLATE. Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ).

int queryByShape(shapeObj shape) Consulta todas las capas seleccionadas en el mapa basado en una simple figura, la figura debe ser un polígono a este punto. Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int queryByFeatures(int slayer) Realiza una consulta basada en un conjunto de resultados de una capa.  Actualmente los resultados DEBEN estar basados en una capa tipo polígono. Retorna MS_SUCCESS si encontró figuras o MS_FAILURE si no encontró nada o si algún otro error ocurrió(Cabe destacar que el mensaje de error en el caso de que no encuentre nada puede ser evitado en PHP usando el operador de control ‘@’ ). int setFilter(string expresion) Establece la expresión de filtro de una capa. char getProjection() Retorna una representación de cadena de la proyección. Si no se se estableció ninguna, se retorna MS_FALSE. int setProjection(string proj_params) Establece la proyección del mapa y el sistema de coordenadas. Los parámetros están dados como una cadena simple delimitado por comas. int getNumResult() Retorna el número de resultados de esta capa en la última consulta. resultCacheMemberObj getResult(int index) Retorna un objeto resultCacheMemberObj como índice de un objeto de capa con el índice en el rango numero_resultados-1. Retorna un objeto valido o FALSE(0) si el índice es invalido. int open(string ruta_shape)  Abre la capa para usar con getShape(). Retorna MS_SUCCESS/MS_FAILURE. void close() Cierra la capa previamente abierta con la función open(). shapeObj getShape(int tileindex, int shapeindex) Devuelve un objeto shapeObj de una capa por un índice. El tileindex es usado para archivos shape recortados(se obtiene de el objeto resultCacheMemberObj

retornado por la función getResult() por ejemplo). Simplemente se pasa el tileindex = -1 para otras fuentes de datos. int addFeature(shapeObj shape)  Adiciona una nueva figura en una cpa. Retorna –1 si hay error. int getMetaData(string nombre) Trae la entrada de los metadatos por medio de un nombre(Almacenado en el objeto WEB del Mapfile). Retorna “” si no existe una entrada con ese nombre. La búsqueda es sensible a la escritura. int setMetaData(string nombre, string valor) Establece la entrada de un metadato para el mapa. (Almacenado en el objeto WEB del Mapfile). Retorna MS_SUCCESS/MS_FAILURE según el caso. int getWMSFeatureInfoURL(int clickX, int clickY, int featureCount, string infoFormat) Retorna una URL GetFeatureInfo de WMS(trabaja sólo para capas WMS). Los parámetros ClickX y ClickY son las coordenadas de localización de la consulta en píxeles con (0,0) como la esquina superior izquierda de la imagen, featureCount es el número de resultados ha devolver y infoFormat es el formato en el cual el resultado debería ser consultado. Depende de las capacidades del servidor remoto. Los servidores WMS Mapserver soportan solo “MIME” (y debería soportar “GML.1 pronto”). Retorna “” y muestra un mensaje de advertencia si la capa no es una capa WMS o si no es consultable. char ** getItems() Retorna una lista de ítems. Debe llamarse primero la función open(). Clase ClassObj:

Constructor: Los objetos classObj pueden ser retornados por la clase LayerObj, o pueden ser creados usando: classObj ms_newClassObj(layerObj capa) Miembros: string name int type int status int color

(MS_ON, MS_OFF o MS_DELETE)

int backgroundcolor int outlinecolor int overlaycolor int overlaybackgroundcolor int overlayoutlinecolor int symbol string symbolname int size int minsize int maxsize int overlaysymbol string overlaysymbolname int overlaysize int overlayminsize int overlaymaxsize labelObj label Métodos: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores. int setexpression(string expresion) Establece una cadena de expresión para el objeto clase. int settext(string texto) Establece la cadena de texto para el objeto clase. int drawLegendIcon(int width, int height, imageObj im, int dstX, int dstY) Dibuja el icono de la leyenda en un objeto imagen a una distancia en X y Y, según los parámetros dstX y dstY. Retorna MS_SUCCESS/MS_FAILURE según el caso. imageObj createLegendIcon(int width, int height) Dibuja el icono de la legenda y retorna un nuevo objeto de imagen. Clase ImageObj:

Constructor: Las instancias de la clase ImageObj son siempre creadas por los métodos de la clase Map.

Miembros: int width (solo-lectura) int height (solo-lectura) string imagepath string imageurl Métodos: void free() Destruye los recursos utilizados por un objeto de imagen. int saveImage(string filename, int type, int transparent, int interlace, int quality) Escribe el objeto imagen a un archivo específico. Pasando un nombre de archivo vacío. La salida se envía a stdout. En este caso la función PHP header() debería ser usada para establecer el tipo de contenido del documento antes de llamar saveImage(). El parámetro type puede ser MS_GIF, MS_PNG, MS_JPEG o MS_WBMP(dependiendo de que versión fue usada para compilar Mapscript). El parámetro quality debería ser un valor en el rango 0-95, valores más altos implica una mayor calidad de la imagen y grandes tamaños de los archivos. Si la calidad es negativa, entonces el valor de la calidad por defecto de la IJG JPEG es usado. (El valor de calidad es ignorado para todos los otros formatos menos JPEG). La función retorna –1 si hay error. Si tuvo éxito, retorna 0 si ha escrito a un archivo externo, o el número de bytes escritos si la salida es enviada a stdout. string saveWebImage(int type, int transparent, int interlace, int quality) Escribe una imagen a un archivo temporal. Retorna la URL de la imagen. El parámetro type puede ser MS_GIF, MS_PNG, MS_JPEG o MS_WBMP(dependiendo de que versión fue usada para compilar Mapscript). El parámetro quality debería ser un valor en el rango 0-95, valores más altos implica una mayor calidad de la imagen y grandes tamaños de los archivos. Si la calidad es negativa, entonces el valor de la calidad por defecto de la IJG JPEG es usado. (El valor de calidad es ignorado para todos los otros formatos menos JPEG). void pasteImage(imageObj srcImg, int transparentColorIndex [, int dstX, dstY]) Copia la imagen que se encuentra en la ruta srcImg en la parte superior del objeto imageObj actual. El parámetro transparentColorIndex es el color de srcImg que se debería considerar transparente(esos píxeles no serán copiados).Pasando –1 no se pondrá ningún color como transparente. Si se adiciona los parámetros opcionales dstx y dsty, entonces se define la posición donde se debería copiar la imagen(dstx,dsty = coordenadas de la esquina superior izquierda)

Clase LabelObj:

Constructor: Las instancias del la clase LabelObj están siempre embebidas dentro de otras clases. Miembros: string font int type int color int outlinecolor int shadowcolor int shadowsizex int shadowsizey int backgroundcolor int backgroundshadowcolor int backgroundshadowsizex int backgroundshadowsizey int size int minsize int maxsize int position int offsetx int offsety double angle int autoangle int buffer int antialias int wrap int minfeaturesize int autominfeaturesize int mindistance int partials int force Métodos: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores.

Clase webObj:

Constructor: Las instancias del la clase webObj están siempre embebidas dentro de la clase mapObj. Miembros: string log; string imagepath string template string imageurl string header string footer string empty (solo-lectura) string error (solo-lectura) string mintemplate string maxtemplate double minscale double maxscale rectObj extent (solo-lectura) Método: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores. Clase referenceMapObj:

Constructor: Las instancias del la clase referenceMapObj están siempre embebidas dentro de la clase mapObj. Miembros: string image int width int height int status rectObj extent (solo-lectura) ColorObj color (solo-lectura) ColorObj outlinecolor (solo-lectura)

Método: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores. Clase ColorObj:

Constructor: Las instancias del la clase ColorObj están siempre embebidas dentro de otras clases. Miembros: int int int

red green blue

Método: void setRGB(int rojo, int verde, int azul) Establece los valores para los colores rojo, verde y azul. Clase PointObj:

Constructor: PointObj ms_newPointObj() Miembros: double x double y double m (usado para medida de archivos shape. Se coloca a 0 para otros tipos) Métodos: int setXY(double x, double y, double m) Establece los valores de las coordenadas X y Y. Nota: el tercer parámetro m es usado para medida de archivos shape. No es necesario.

int draw(mapObj map, layerObj layer, imageObj img, int class_index, string text) Dibuja el punto individual usando una capa. El parámetro class_index es usado para clasificar el punto basado en las clases definidas por la capa. El parámetro cadena text es usado para anotar el punto. Retorna MS_SUCCESS/MS_FAILURE según el caso. double distanceToPoint(pointObj poPoint) Calcula la distancia entre dos puntos. double distanceToLine(pointObject p1, pointObject p2) Calcula la distancia entre un punto y una línea definida por los dos puntos pasados como argumentos. double distanceToShape(shapeObj shape) Calcula la distancia mínima entre un punto y una figura. projectionObj project(projectionObj in, projectionObj out) Proyecta el punto dentro de la proyección “in”(1° argumento) a la proyección  “out”(2° argumento). void free() Descarga todos los recursos usados por el objeto. Clase LineObj:

Constructor: LineObj ms_newLineObj() Miembros: int

numpoints (solo-lectura)

Métodos: int add(pointObj point)  Adiciona un punto al final de la línea. int addXY(double x, double y, double m)  Adiciona un punto al final de la línea. Nota: el 3er argumento m es usado para medir distancias en archivos shape. No es necesario.

PointObj point(int i) Retorna una referencia al punto número “i”. La referencia es válida sólo durante la vida del objeto lineObj que contiene el punto. projectionObj project(projectionObj in, projectionObj out) Proyecta el punto dentro de la proyección “in”(1° argumento) a la proyección  “out”(2° argumento). void free() Descarga todos los recursos usados por el objeto. Clase RectObj:

Constructor: Los objetos rectObj algunas veces están embebidos dentro de otros objetos. Los nuevos pueden sin embargo ser creados con: RectObj ms_newRectObj() Miembros: double minx double miny double maxx double maxy Métodos: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores. void setextent(double minx, double miny, double maxx, double maxy) Establece la extensión del rectángulo. int draw(mapObj map, layerObj layer, imageObj img, int class_index, string text) Dibuja el rectangulo individual usando una capa. El parámetro class_index es usado para clasificar el rectángulo basandose en las clases definidas por la capa. El parámetro cadena text es usado para rotular el polígono. Retorna MS_SUCCESS/MS_FAILURE según el caso.

double fit(int width, int height)  Ajusta la extensión del rectangulo para cuadrar con los parámetros width/height especificados. projectionObj project(projectionObj in, projectionObj out) Proyecta el punto dentro de la proyección “in”(1° argumento) a la proyección  “out”(2° argumento). void free() Descarga todos los recursos usados por el objeto. Clase ResultCacheMemberObj:

Constructor: Las instancias del objeto ResultCacheMemberObj son obtenidas siempre a través del método getResult() del objeto layerObj. Miembros: int int int

shapeindex (solo-lectura) tileindex (solo-lectura) classindex (solo-lectura)

Clase ProjectionObj:

Constructor: ProjectionObj ms_newprojectionobj(string projectionstring) Crea un nuevo objeto de proyección basado en la cadena de proyección pasada como argumento. Ejemplo: La sentencia $projInObj = ms_newprojectionobj("proj=latlong") creará una clase de proyección geográfica. Ejemplo de uso, el siguiente ejemplo convertirá un punto en coordenadas lat/long a una proyección LCC: $projInObj = ms_newprojectionobj("proj=latlong"); $projOutObj = ms_newprojectionobj("proj=lcc,ellps=GRS80,lat_0= 49,lon_0=-95,lat_1=49,lat_2=77"); $poPoint = ms_newpointobj(); $poPoint->setXY(-92.0, 62.0);

$poPoint = $poPoint->project($projInObj, $projOutObj); Clase scalebarObj:

Constructor: Las instancias del objeto scalebarObj son embebidas siempre dentro de la clase mapObj. Miembros: int height; int width; int style; int intervals; int color; int backgroundcolor; int outlinecolor; int units; int status; //MS_ON, MS_OFF, MS_EMBED int position; //Para barras de escalas embebidas, MS_UL, MS_UC, ... int transparent; int interlace; int postlabelcache; labelObj label; colorObj imagecolor; Métodos: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores. int setimagecolor(int rojo, int verde, int azul) Establece la propiedad imagecolor(fondo) del objeto. Retorna false cuando hay error. Clase LegendObj:

Constructor: Las instancias del objeto legendObj son embebidas siempre dentro de la clase mapObj.

Miembros: int height; int width; int keysizex; int keysizey; int keyspacingx; int keyspacingy; int outlinecolor; //Color de la línea externa de la caja, -1 para no colocarla. int status; //MS_ON, MS_OFF, MS_EMBED int position; //Para leyendas embebidas, MS_UL, MS_UC, ... int transparent; int interlace; int postlabelcache; //MS_TRUE, MS_FALSE labelObj label; colorObj imagecolor; string template Métodos: int set(string nombre_propiedad, nuevo_valor) Establece una propiedad del objeto MAP a un nuevo valor. Retorna –1 si hay errores.