aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lipi-toolkit/3rdparty/lipi-toolkit/src/include/LTKScreenContext.h
blob: 0837425621f818627e59a82d4b1320c5dd53d3b7 (plain)
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
/******************************************************************************
* Copyright (c) 2006 Hewlett-Packard Development Company, L.P.
* Permission is hereby granted, free of charge, to any person obtaining a copy 
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights 
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
* copies of the Software, and to permit persons to whom the Software is 
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
* SOFTWARE
********************************************************************************/

/******************************************************************************
 * SVN MACROS
 *
 * $LastChangedDate: 2008-07-10 15:23:21 +0530 (Thu, 10 Jul 2008) $
 * $Revision: 556 $
 * $Author: sharmnid $
 *
 ************************************************************************/

/************************************************************************
 * FILE DESCR: Definition of LTKScreenContext which holds the co-ordinates of 
 *             the writing area provided for the set of traces being sent for
 *             recognition
 *
 * CONTENTS:   
 *
 * AUTHOR:     Balaji Raghavan.
 *
 * DATE:       Dec 23, 2004
 * CHANGE HISTORY:
 * Author		Date			Description of change
 * Deepu      01-MAR-2005       Added hLines and vLines to the class
 *                              Also incorporated the accessor functions
 ************************************************************************/

#ifndef __LTKSCREENCONTEXT_H
#define __LTKSCREENCONTEXT_H

#include "LTKInc.h"
#include "LTKTypes.h"

 
 /**
 * @class LTKScreenContext
 * <p> This class contains the co-ordinates of the writing area. </p>
 */


class LTKScreenContext
{
private:

	float m_bboxLeft;			//	leftmost x-coord of the writing area

	float m_bboxBottom;			//	bottommost y-coord of the writing area

	float m_bboxRight;			//	rightmost x-coord of the writing area

	float m_bboxTop;			//	topmost y-coord of the writing area

	floatVector m_hLines;		//	Vector of horizontal reference lines

	floatVector m_vLines;		//	Vector of vertical reference lines


public:

	/**
	 * @name Constructors and Destructor
	 */
	// @{

	/**
	 * Default Constructor
	 */

	LTKScreenContext ();

	/**
	 * This constrcutor takes various paramaters about a writing area.
	 * @param bboxLeft Gets the left x co-ordinate of the writing area
	 * @param bboxBotton Gets the bottom y co-ordinate of the writing area
	 * @param bboxRight Gets the right x co-ordinate of the writing area
	 * @param bboxTop Gets the top y co-ordinate of the writing area
	 */

	LTKScreenContext(float bboxLeft, float bboxBotton, float bboxRight, 
		             float bboxTop);

	/** Destructor */

	~LTKScreenContext ();

	// @}

	/**
	 * @name Getter Functions
	 */
	// @{

	/**
	 * This function returns the bottom left x co-ordinate of the writing area
	 * @param void
	 *
	 * @return Left x co-ordinate of the writing area.
	 */

	float getBboxLeft() const;

	/**
	 * This function returns the bottom left y co-ordinate of the writing area
	 * @param void
	 *
	 * @return Bottom y co-ordinate of the writing area.
	 */

	float getBboxBottom() const;

	/**
	 * This function returns the top right x co-ordinate of the writing area
	 * @param void
	 *
	 * @return Right x co-ordinate of the writing area.
	 */

	float getBboxRight() const;

	/**
	 * This function returns the top right y co-ordinate of the writing area
	 * @param void
	 *
	 * @return Top y co-ordinate of the writing area.
	 */

	float getBboxTop() const;

	/**
	 * This function returns the horizontal lines
	 * @param void
	 *
	 * @return const reference to vector of ordinates of horizontal lines
	 */

	const floatVector& getAllHLines() const;

	/**
	 * This function returns the vertical lines
	 * @param void
	 *
	 * @return const reference to vector of abscissae of vertical lines
	 */

	const floatVector& getAllVLines() const;

	// @}

	/**
	 * @name Setter Functions
	 */
	// @{

	/**
	 * This function adds a horizontal line 
	 * in the screen context
	 * @param ordinate of the horizontal line 
	 *
	 * @return SUCCESS on successful set operation
	 */

	int addHLine(float ordinate);

	/**
	 * This function adds a vertical line 
	 * in the screen context
	 * @param abscissa of the horizontal line 
	 *
	 * @return SUCCESS on successful set operation
	 */

	int addVLine(float abscissa);
	
	/**
	 * This function sets the bottom left x co-ordinate of the writing area
	 * @param bboxLeft Left x co-ordinate of the writing area
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setBboxLeft(float bboxLeft);

	/**
	 * This function sets the bottom left y co-ordinate of the writing area
	 * @param bboxBottom Bottom y co-ordinate of the writing area
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setBboxBottom(float bboxBottom);

	/**
	 * This function sets the top right x co-ordinate of the writing area
	 * @param bboxRight Right x co-ordinate of the writing area
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setBboxRight(float bboxRight);

	/**
	 * This function sets the top right y co-ordinate of the writing area
	 * @param bboxTop Top y co-ordinate of the writing area
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setBboxTop(float bboxTop);

	// @}

};

#endif

//#ifndef __LTKSCREENCONTEXT_H
//#define __LTKSCREENCONTEXT_H