guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
clip.cpp
1/*
2 Copyright (c) 2026 ETIB Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of
5 this software and associated documentation files (the "Software"), to deal in
6 the Software without restriction, including without limitation the rights to
7 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8 of the Software, and to permit persons to whom the Software is furnished to do
9 so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22
23#include "guillaume/components/clip.hpp"
24
26{
27 float Clip::getMargin(void) const
28 {
29 return _margin;
30 }
31
32 Clip &Clip::setMargin(float margin)
33 {
34 if (_margin == margin) {
35 return *this;
36 }
37 _margin = margin;
38 setHasChanged(true);
39 return *this;
40 }
41
42 bool Clip::isEnabled(void) const
43 {
44 return _enabled;
45 }
46
47 Clip &Clip::setEnabled(bool enabled)
48 {
49 if (_enabled == enabled) {
50 return *this;
51 }
52 _enabled = enabled;
53 setHasChanged(true);
54 return *this;
55 }
56
57 const Clip::Rect &Clip::getRect(void) const
58 {
59 return _rect;
60 }
61
62 Clip &Clip::setRect(const Rect &rect)
63 {
64 if (_rect == rect) {
65 return *this;
66 }
67 _rect = rect;
68 setHasChanged(true);
69 return *this;
70 }
71} // namespace guillaume::components
Clip & setEnabled(bool enabled)
Turn clipping on or off without removing the component.
Definition clip.cpp:47
float getMargin(void) const
Get the inset between the bound and the clip rectangle.
Definition clip.cpp:27
const Rect & getRect(void) const
Get the rectangle computed by systems::Clip.
Definition clip.cpp:57
bool isEnabled(void) const
Check whether systems::Clip processes this entity.
Definition clip.cpp:42
Clip & setMargin(float margin)
Set the inset between the bound and the clip rectangle.
Definition clip.cpp:32
Clip & setRect(const Rect &rect)
Store the computed rectangle. Called by systems::Clip; a value set by hand is replaced on the next fr...
Definition clip.cpp:62
Clip(void)=default
Default constructor for the Clip component.
void setHasChanged(bool hasChanged)
Raise or lower the changed flag.
Definition component.cpp:32
State. Every class here is plain data attached to an entity.
The clip rectangle, in the same coordinates as the position of a components::Transform.
Definition clip.hpp:59