MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
lti_navigator.h
Go to the documentation of this file.
1 //
2 // This code is property of Celartem, Inc dba Extensis.
3 // Copyright (c) 1995-2023. All rights reserved.
4 // Use permitted only under license from Extensis.
5 //
6 /* PUBLIC */
7 
8 #ifndef LTI_NAVIGATOR_H
9 #define LTI_NAVIGATOR_H
10 
11 // lt_lib_mrsid_core
12 #include "lti_scene.h"
13 #include "lti_geoCoord.h"
14 
15 
16 LT_BEGIN_LIZARDTECH_NAMESPACE
17 
18 
25 class LTINavigator : public LTIScene
26 {
27  LT_DISALLOW_COPY_CONSTRUCTOR(LTINavigator);
28 public:
34  typedef enum
35  {
36  STYLE_LAX = 1,
38  STYLE_CLIP = 3
39  } Style;
40 
41 public:
50  LTINavigator(const LTIImage& image);
51 
60  LTINavigator(const LTIImage& image,
61  const LTIScene& scene);
62 
67 
73  const LTIImage& getImage() const;
74 
84  bool isSceneValid() const;
85 
97  LT_STATUS moveBy(double xDelta, double yDelta, Style style);
98 
110  LT_STATUS moveTo(double x, double y, Style style);
111 
126  LT_STATUS zoomBy(double delta, Style style);
127 
141  LT_STATUS zoomTo(double mag, Style style);
142 
160  LT_STATUS bestFit(double maxWidth, double maxHeight, LTIScene& newScene);
161 
168  void roundScene();
169 
178  bool clipToImage();
179 
188  bool clipToScene(const LTIScene& scene);
189 
199  LT_STATUS setScene(const LTIScene& scene, Style style);
200 
201 
211 
212 
222 
223 
234  const LTIScene& getScene() const;
235 
244 
249 
263  LT_STATUS setSceneAsULWH(double upperLeftX, double upperLeftY,
264  double width, double height,
265  double magnification);
266 
280  LT_STATUS setSceneAsULLR(double upperLeftX, double upperLeftY,
281  double lowerRightX, double lowerRightY,
282  double magnification);
283 
297  LT_STATUS setSceneAsCWH(double centerX, double centerY,
298  double width, double height,
299  double magnification);
307 
322  LT_STATUS setSceneAsGeoULWH(double upperLeftX, double upperLeftY,
323  double width, double height,
324  double magnification);
325 
340  LT_STATUS setSceneAsGeoULLR(double upperLeftX, double upperLeftY,
341  double lowerRightX, double lowerRightY,
342  double magnification);
343 
358  LT_STATUS setSceneAsGeoCWH(double centerX, double centerY,
359  double width, double height,
360  double magnification);
363 protected:
365 };
366 
367 
368 LT_END_LIZARDTECH_NAMESPACE
369 
370 
371 #endif // LTI_NAVIGATOR_H
lt_uint32 LT_STATUS
An integral status code.
Definition: lt_status.h:30
represents a geographic coordinate
Definition: lti_geoCoord.h:28
abstract class representing an image
Definition: lti_image.h:28
provides LTIScene movement control
Definition: lti_navigator.h:26
LT_STATUS bestFit(double maxWidth, double maxHeight, LTIScene &newScene)
return scene large enough to fit window
LTINavigator(const LTIImage &image, const LTIScene &scene)
constructor
LT_STATUS moveBy(double xDelta, double yDelta, Style style)
move by specified amount
LTINavigator(const LTIImage &image)
default constructor
LT_STATUS setSceneAsGeoCWH(double centerX, double centerY, double width, double height, double magnification)
set scene to given position
LT_STATUS setSceneAsULLR(double upperLeftX, double upperLeftY, double lowerRightX, double lowerRightY, double magnification)
set scene to given position
void roundScene()
round scene to integral values
LT_STATUS zoomBy(double delta, Style style)
zoom by specified amount
LTIGeoCoord getGeoCoord() const
returns the geographic coordinates of scene
LT_STATUS setSceneAsGeoULWH(double upperLeftX, double upperLeftY, double width, double height, double magnification)
set scene to given position
~LTINavigator()
destructor
LT_STATUS setSceneToFull()
set scene to full image
LT_STATUS setSceneAsGeoULLR(double upperLeftX, double upperLeftY, double lowerRightX, double lowerRightY, double magnification)
set scene to given position
LT_STATUS setSceneToIcon()
set scene to "icon"
bool isSceneValid() const
is current scene is legal for the image
bool clipToImage()
clip scene to fit image
LT_STATUS setSceneAsCWH(double centerX, double centerY, double width, double height, double magnification)
sets scene to the given position
const LTIScene & getScene() const
get current scene
bool clipToScene(const LTIScene &scene)
clip scene to fit given scene
LT_STATUS setScene(const LTIScene &scene, Style style)
reset scene
Style
Styles for scene-setting operations.
Definition: lti_navigator.h:35
@ STYLE_CLIP
if invalid scene, clip scene to image and return success
Definition: lti_navigator.h:38
@ STYLE_STRICT
if invalid scene, return an error code
Definition: lti_navigator.h:37
@ STYLE_LAX
if invalid scene, return success anyway
Definition: lti_navigator.h:36
LT_STATUS setSceneAsULWH(double upperLeftX, double upperLeftY, double width, double height, double magnification)
set scene to given position
const LTIImage & m_image
set scene to given position
LT_STATUS moveTo(double x, double y, Style style)
move to specified amount
LT_STATUS zoomTo(double mag, Style style)
zoom to specified scale
const LTIImage & getImage() const
Returns the image the navigator is attached to.
representation of a scene
Definition: lti_scene.h:60

Extensis