ScummVM API documentation
AlphaImage.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 /*
23  * This code is based on the CRAB engine
24  *
25  * Copyright (c) Arvind Raja Yadav
26  *
27  * Licensed under MIT
28  *
29  */
30 
31 #ifndef CRAB_ALPHAIMAGE_H
32 #define CRAB_ALPHAIMAGE_H
33 
34 #include "crab/image/ImageManager.h"
35 #include "crab/ui/element.h"
36 
37 namespace Crab {
38 
39 namespace pyrodactyl {
40 namespace ui {
41 class AlphaImage {
42  // The image used - we don't use the image manager
43  // because we don't change the alpha for those images
44  ImageKey _img;
45 
46  // The information for drawing the image
47  Element _pos;
48 
49  // The information related to alpha modulation of the image
50  struct AlphaVal {
51  int _cur, _min, _max;
52 
53  // Are we increasing or decreasing the alpha
54  bool _inc;
55 
56  // By how much do we change the alpha every update
57  int _change;
58 
59  AlphaVal() {
60  _cur = 255;
61  _min = 255;
62  _max = 255;
63  _inc = true;
64  _change = 0;
65  }
66  } alpha;
67 
68 public:
69  AlphaImage() {
70  _img = 0;
71  }
72 
73  AlphaImage(rapidxml::xml_node<char> *node) : AlphaImage() {
74  load(node);
75  }
76 
77  ~AlphaImage() {}
78 
79  void load(rapidxml::xml_node<char> *node, const bool &echo = true);
80 
81  void draw(const int &xOffset = 0, const int &yOffset = 0);
82 
83  // This is used to vary the alpha
84  void internalEvents();
85 
86  void setUI() {
87  _pos.setUI();
88  }
89 };
90 } // End of namespace ui
91 } // End of namespace pyrodactyl
92 
93 } // End of namespace Crab
94 
95 #endif // CRAB_ALPHAIMAGE_H
Definition: element.h:42
Definition: AlphaImage.h:41
Definition: moveeffect.h:37