1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
|
#if !defined( ZOOMMAP_INCLUDED ) /* Include this file only once */
#define ZOOMMAP_INCLUDED
/*
*+
* Name:
* zoommap.h
* Type:
* C include file.
* Purpose:
* Define the interface to the ZoomMap class.
* Invocation:
* #include "zoommap.h"
* Description:
* This include file defines the interface to the ZoomMap class and
* provides the type definitions, function prototypes and macros,
* etc. needed to use this class.
*
* The ZoomMap class implements Mappings which perform a "zoom"
* transformation by multiplying all coordinate values by the same
* scale factor (the inverse transformation is performed by
* dividing by this scale factor).
* Inheritance:
* The ZoomMap class inherits from the Mapping class.
* Attributes Over-Ridden:
* None.
* New Attributes Defined:
* Zoom (double)
* The ZoomMap scale factor, by which coordinate values are
* multiplied (by the forward transformation) or divided (by the
* inverse transformation). This factor is set when a ZoomMap is
* created, but may later be modified. It may not be set to
* zero. The default value (if cleared) is one.
*
* Note that if the ZoomMap is inverted (by using astInvert or
* setting a non-zero value for its Invert attribute), then the
* reciprocal of this Zoom value will, in effect, be used.
* Methods Over-Ridden:
* Public:
* None.
*
* Protected:
* astClearAttrib
* Clear an attribute value for a ZoomMap.
* astGetAttrib
* Get an attribute value for a ZoomMap.
* astSetAttrib
* Set an attribute value for a ZoomMap.
* astTestAttrib
* Test if an attribute value has been set for a ZoomMap.
* astTransform
* Apply a ZoomMap to transform a set of points.
* New Methods Defined:
* Public:
* None.
*
* Protected:
* astClearZoom
* Clear the Zoom attribute value for a ZoomMap.
* astGetZoom
* Get the Zoom attribute value for a ZoomMap.
* astSetZoom
* Set the Zoom attribute value for a ZoomMap.
* astTestZoom
* Test if a Zoom attribute value has been set for a ZoomMap.
* Other Class Functions:
* Public:
* astIsAZoomMap
* Test class membership.
* astZoomMap
* Create a ZoomMap.
*
* Protected:
* astCheckZoomMap
* Validate class membership.
* astInitZoomMap
* Initialise a ZoomMap.
* astInitZoomMapVtab
* Initialise the virtual function table for the ZoomMap class.
* astLoadZoomMap
* Load a ZoomMap.
* Macros:
* None.
* Type Definitions:
* Public:
* AstZoomMap
* ZoomMap object type.
*
* Protected:
* AstZoomMapVtab
* ZoomMap virtual function table type.
* Feature Test Macros:
* astCLASS
* If the astCLASS macro is undefined, only public symbols are
* made available, otherwise protected symbols (for use in other
* class implementations) are defined. This macro also affects
* the reporting of error context information, which is only
* provided for external calls to the AST library.
* Copyright:
* Copyright (C) 1997-2006 Council for the Central Laboratory of the
* Research Councils
* Licence:
* This program 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 3 of the License, or (at your option) any later
* version.
*
* This program 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
* Authors:
* RFWS: R.F. Warren-Smith (Starlink)
* History:
* 30-JAN-1996 (RFWS):
* Original version.
* 18-JUL-1996 (RFWS):
* Updated to provide an external interface.
* 10-SEP-1996 (RFWS):
* Added I/O facilities.
* 8-JAN-2003 (DSB):
* Added protected astInitZoomMapVtab method.
*-
*/
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "mapping.h" /* Coordinate mappings (parent class) */
#if defined(astCLASS) /* Protected */
#include "channel.h" /* I/O channels */
#endif
/* C header files. */
/* --------------- */
#if defined(astCLASS) /* Protected */
#include <stddef.h>
#endif
/* Macros */
/* ====== */
/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
#ifndef __GNUC__
# define __attribute__(x) /*NOTHING*/
#endif
/* Type Definitions. */
/* ================= */
/* ZoomMap structure. */
/* ------------------ */
/* This structure contains all information that is unique to each object in
the class (e.g. its instance variables). */
typedef struct AstZoomMap {
/* Attributes inherited from the parent class. */
AstMapping mapping; /* Parent class structure */
/* Attributes specific to objects in this class. */
double zoom; /* Zoom factor */
} AstZoomMap;
/* Virtual function table. */
/* ----------------------- */
/* This table contains all information that is the same for all
objects in the class (e.g. pointers to its virtual functions). */
#if defined(astCLASS) /* Protected */
typedef struct AstZoomMapVtab {
/* Properties (e.g. methods) inherited from the parent class. */
AstMappingVtab mapping_vtab; /* Parent class virtual function table */
/* A Unique identifier to determine class membership. */
AstClassIdentifier id;
/* Properties (e.g. methods) specific to this class. */
double (*GetZoom)( AstZoomMap *, int * );
int (* TestZoom)( AstZoomMap *, int * );
void (* ClearZoom)( AstZoomMap *, int * );
void (* SetZoom)( AstZoomMap *, double, int * );
} AstZoomMapVtab;
#if defined(THREAD_SAFE)
/* Define a structure holding all data items that are global within this
class. */
typedef struct AstZoomMapGlobals {
AstZoomMapVtab Class_Vtab;
int Class_Init;
char GetAttrib_Buff[ 101 ];
} AstZoomMapGlobals;
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(ZoomMap) /* Check class membership */
astPROTO_ISA(ZoomMap) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected. */
AstZoomMap *astZoomMap_( int, double, const char *, int *, ...);
#else
AstZoomMap *astZoomMapId_( int, double, const char *, ... )__attribute__((format(printf,3,4)));
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstZoomMap *astInitZoomMap_( void *, size_t, int, AstZoomMapVtab *,
const char *, int, double, int * );
/* Vtab initialiser. */
void astInitZoomMapVtab_( AstZoomMapVtab *, const char *, int * );
/* Loader. */
AstZoomMap *astLoadZoomMap_( void *, size_t, AstZoomMapVtab *,
const char *, AstChannel *, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitZoomMapGlobals_( AstZoomMapGlobals * );
#endif
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
# if defined(astCLASS) /* Protected */
double astGetZoom_( AstZoomMap *, int * );
int astTestZoom_( AstZoomMap *, int * );
void astClearZoom_( AstZoomMap *, int * );
void astSetZoom_( AstZoomMap *, double, int * );
#endif
/* Function interfaces. */
/* ==================== */
/* These macros are wrap-ups for the functions defined by this class
to make them easier to invoke (e.g. to avoid type mis-matches when
passing pointers to objects from derived classes). */
/* Interfaces to standard class functions. */
/* --------------------------------------- */
/* Some of these functions provide validation, so we cannot use them
to validate their own arguments. We must use a cast when passing
object pointers (so that they can accept objects from derived
classes). */
/* Check class membership. */
#define astCheckZoomMap(this) astINVOKE_CHECK(ZoomMap,this,0)
#define astVerifyZoomMap(this) astINVOKE_CHECK(ZoomMap,this,1)
/* Test class membership. */
#define astIsAZoomMap(this) astINVOKE_ISA(ZoomMap,this)
/* Constructor. */
#if defined(astCLASS) /* Protected. */
#define astZoomMap astINVOKE(F,astZoomMap_)
#else
#define astZoomMap astINVOKE(F,astZoomMapId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitZoomMap(mem,size,init,vtab,name,ncoord,zoom) \
astINVOKE(O,astInitZoomMap_(mem,size,init,vtab,name,ncoord,zoom,STATUS_PTR))
/* Vtab Initialiser. */
#define astInitZoomMapVtab(vtab,name) astINVOKE(V,astInitZoomMapVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadZoomMap(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadZoomMap_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif
/* Interfaces to public member functions. */
/* -------------------------------------- */
/* Here we make use of astCheckZoomMap to validate ZoomMap pointers
before use. This provides a contextual error report if a pointer
to the wrong sort of Object is supplied. */
#if defined(astCLASS) /* Protected */
#define astClearZoom(this) astINVOKE(V,astClearZoom_(astCheckZoomMap(this),STATUS_PTR))
#define astGetZoom(this) astINVOKE(V,astGetZoom_(astCheckZoomMap(this),STATUS_PTR))
#define astSetZoom(this,value) \
astINVOKE(V,astSetZoom_(astCheckZoomMap(this),value,STATUS_PTR))
#define astTestZoom(this) astINVOKE(V,astTestZoom_(astCheckZoomMap(this),STATUS_PTR))
#endif
#endif
|