1/* graphene-box.h: An axis aligned bounding box
2 *
3 * SPDX-License-Identifier: MIT
4 *
5 * Copyright 2014 Emmanuele Bassi
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25
26#pragma once
27
28#if !defined(GRAPHENE_H_INSIDE) && !defined(GRAPHENE_COMPILATION)
29#error "Only graphene.h can be included directly."
30#endif
31
32#include "graphene-types.h"
33#include "graphene-vec3.h"
34
35GRAPHENE_BEGIN_DECLS
36
37/**
38 * graphene_box_t:
39 *
40 * A 3D box, described as the volume between a minimum and
41 * a maximum vertices.
42 *
43 * Since: 1.2
44 */
45struct _graphene_box_t
46{
47 /*< private >*/
48 GRAPHENE_PRIVATE_FIELD (graphene_vec3_t, min);
49 GRAPHENE_PRIVATE_FIELD (graphene_vec3_t, max);
50};
51
52GRAPHENE_AVAILABLE_IN_1_2
53graphene_box_t * graphene_box_alloc (void);
54GRAPHENE_AVAILABLE_IN_1_2
55void graphene_box_free (graphene_box_t *box);
56
57GRAPHENE_AVAILABLE_IN_1_2
58graphene_box_t * graphene_box_init (graphene_box_t *box,
59 const graphene_point3d_t *min,
60 const graphene_point3d_t *max);
61GRAPHENE_AVAILABLE_IN_1_2
62graphene_box_t * graphene_box_init_from_points (graphene_box_t *box,
63 unsigned int n_points,
64 const graphene_point3d_t *points);
65GRAPHENE_AVAILABLE_IN_1_2
66graphene_box_t * graphene_box_init_from_vectors (graphene_box_t *box,
67 unsigned int n_vectors,
68 const graphene_vec3_t *vectors);
69GRAPHENE_AVAILABLE_IN_1_2
70graphene_box_t * graphene_box_init_from_box (graphene_box_t *box,
71 const graphene_box_t *src);
72GRAPHENE_AVAILABLE_IN_1_2
73graphene_box_t * graphene_box_init_from_vec3 (graphene_box_t *box,
74 const graphene_vec3_t *min,
75 const graphene_vec3_t *max);
76
77GRAPHENE_AVAILABLE_IN_1_2
78void graphene_box_expand (const graphene_box_t *box,
79 const graphene_point3d_t *point,
80 graphene_box_t *res);
81GRAPHENE_AVAILABLE_IN_1_2
82void graphene_box_expand_vec3 (const graphene_box_t *box,
83 const graphene_vec3_t *vec,
84 graphene_box_t *res);
85GRAPHENE_AVAILABLE_IN_1_2
86void graphene_box_expand_scalar (const graphene_box_t *box,
87 float scalar,
88 graphene_box_t *res);
89GRAPHENE_AVAILABLE_IN_1_2
90void graphene_box_union (const graphene_box_t *a,
91 const graphene_box_t *b,
92 graphene_box_t *res);
93GRAPHENE_AVAILABLE_IN_1_2
94bool graphene_box_intersection (const graphene_box_t *a,
95 const graphene_box_t *b,
96 graphene_box_t *res);
97
98GRAPHENE_AVAILABLE_IN_1_2
99float graphene_box_get_width (const graphene_box_t *box);
100GRAPHENE_AVAILABLE_IN_1_2
101float graphene_box_get_height (const graphene_box_t *box);
102GRAPHENE_AVAILABLE_IN_1_2
103float graphene_box_get_depth (const graphene_box_t *box);
104GRAPHENE_AVAILABLE_IN_1_2
105void graphene_box_get_size (const graphene_box_t *box,
106 graphene_vec3_t *size);
107GRAPHENE_AVAILABLE_IN_1_2
108void graphene_box_get_center (const graphene_box_t *box,
109 graphene_point3d_t *center);
110GRAPHENE_AVAILABLE_IN_1_2
111void graphene_box_get_min (const graphene_box_t *box,
112 graphene_point3d_t *min);
113GRAPHENE_AVAILABLE_IN_1_2
114void graphene_box_get_max (const graphene_box_t *box,
115 graphene_point3d_t *max);
116GRAPHENE_AVAILABLE_IN_1_2
117void graphene_box_get_vertices (const graphene_box_t *box,
118 graphene_vec3_t vertices[]);
119GRAPHENE_AVAILABLE_IN_1_2
120void graphene_box_get_bounding_sphere (const graphene_box_t *box,
121 graphene_sphere_t *sphere);
122
123GRAPHENE_AVAILABLE_IN_1_2
124bool graphene_box_contains_point (const graphene_box_t *box,
125 const graphene_point3d_t *point);
126GRAPHENE_AVAILABLE_IN_1_2
127bool graphene_box_contains_box (const graphene_box_t *a,
128 const graphene_box_t *b);
129
130GRAPHENE_AVAILABLE_IN_1_2
131bool graphene_box_equal (const graphene_box_t *a,
132 const graphene_box_t *b);
133
134GRAPHENE_AVAILABLE_IN_1_2
135const graphene_box_t * graphene_box_zero (void);
136GRAPHENE_AVAILABLE_IN_1_2
137const graphene_box_t * graphene_box_one (void);
138GRAPHENE_AVAILABLE_IN_1_2
139const graphene_box_t * graphene_box_minus_one (void);
140GRAPHENE_AVAILABLE_IN_1_2
141const graphene_box_t * graphene_box_one_minus_one (void);
142GRAPHENE_AVAILABLE_IN_1_2
143const graphene_box_t * graphene_box_infinite (void);
144GRAPHENE_AVAILABLE_IN_1_2
145const graphene_box_t * graphene_box_empty (void);
146
147GRAPHENE_END_DECLS
148

source code of gtk/subprojects/graphene/include/graphene-box.h