Crazy Eddie's GUI System  ${CEGUI_VERSION}
InventoryBase.h
1 /***********************************************************************
2  created: Fri Apr 22 2011
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2011 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _InventoryBase_h_
28 #define _InventoryBase_h_
29 
30 #include "BoolArray2D.h"
31 #include <CEGUI/Rect.h>
32 
33 // Start of CEGUI namespace section
34 namespace CEGUI
35 {
36 // common base class for the grid based inventory components.
38 {
39 public:
40  // returns the pixel size of a single square in the content grid.
41  virtual Sizef squarePixelSize() const;
42 
43  // set the size of the content grid and initialise it.
44  virtual void setContentSize(int width, int height);
45 
46  // return the width of the content grid, in grid squares.
47  int contentWidth() const;
48 
49  // return the height of the content grid, in grid squares.
50  int contentHeight() const;
51 
52  // return the grid x co-ordinate that corresponds to the given screen
53  // pixel co-ordinate.
54  int gridXLocationFromPixelPosition(float x_pixel_location) const;
55 
56  // return the grid y co-ordinate that corresponds to the given screen
57  // pixel co-ordinate.
58  int gridYLocationFromPixelPosition(float y_pixel_location) const;
59 
60 protected:
61  // return the screen rect where the content grid is rendered.
62  virtual Rectf gridBasePixelRect() const = 0;
63 
64  // array holding the content grid data.
65  BoolArray2D d_content;
66 };
67 
68 } // End of CEGUI namespace section
69 
70 #endif // end of guard _InventoryBase_h_
71 
Main namespace for Crazy Eddie's GUI Library.
Definition: cegui/include/CEGUI/Affector.h:42
Definition: InventoryBase.h:37
Definition: BoolArray2D.h:35