-
Notifications
You must be signed in to change notification settings - Fork 4
/
overlapping_type.h
63 lines (58 loc) · 2.59 KB
/
overlapping_type.h
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
// BSD 3-Clause License
//
// Copyright (c) 2022, Woven Planet.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// * Neither the name of the copyright holder nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#pragma once
namespace maliput {
namespace math {
/// Holds the possible overlapping types between regions.
///
/// Given two sets `A` and `B` :
/// - `A` intersects `B` iff `A` and `B` have at least one point in common.
/// - `A` contains `B` iff `A` contains all the points of `B`.
/// - `A` disjoints `B` iff `A` and `B` have no points in common.
///
/// - Example of use:
/// @code {.cpp}
/// OverlappingType MyMethod();
/// ...
/// if(OverlappingType::kIntersected & MyMethod() == OverlappingType::kIntersected) {
/// // Do something.
/// }
/// @endcode
enum class OverlappingType : unsigned int {
kDisjointed = 0, ///< No overlapping between bounding regions
kIntersected = 1, ///< Bounding regions are intersected.
kContained = 3, ///< Bounding regions are contained.
};
// Union operator.
OverlappingType operator|(const OverlappingType& first, const OverlappingType& second);
// Intersection operator.
OverlappingType operator&(const OverlappingType& first, const OverlappingType& second);
} // namespace math
} // namespace maliput