1 | /* graphene-frustum.h: A 3D field of view |
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-plane.h" |
34 | |
35 | GRAPHENE_BEGIN_DECLS |
36 | |
37 | /** |
38 | * graphene_frustum_t: |
39 | * |
40 | * A 3D volume delimited by 2D clip planes. |
41 | * |
42 | * The contents of the `graphene_frustum_t` are private, and should not be |
43 | * modified directly. |
44 | * |
45 | * Since: 1.2 |
46 | */ |
47 | struct _graphene_frustum_t |
48 | { |
49 | /*< private >*/ |
50 | GRAPHENE_PRIVATE_FIELD (graphene_plane_t, planes[6]); |
51 | }; |
52 | |
53 | GRAPHENE_AVAILABLE_IN_1_2 |
54 | graphene_frustum_t * graphene_frustum_alloc (void); |
55 | GRAPHENE_AVAILABLE_IN_1_2 |
56 | void graphene_frustum_free (graphene_frustum_t *f); |
57 | |
58 | GRAPHENE_AVAILABLE_IN_1_2 |
59 | graphene_frustum_t * graphene_frustum_init (graphene_frustum_t *f, |
60 | const graphene_plane_t *p0, |
61 | const graphene_plane_t *p1, |
62 | const graphene_plane_t *p2, |
63 | const graphene_plane_t *p3, |
64 | const graphene_plane_t *p4, |
65 | const graphene_plane_t *p5); |
66 | GRAPHENE_AVAILABLE_IN_1_2 |
67 | graphene_frustum_t * graphene_frustum_init_from_frustum (graphene_frustum_t *f, |
68 | const graphene_frustum_t *src); |
69 | GRAPHENE_AVAILABLE_IN_1_2 |
70 | graphene_frustum_t * graphene_frustum_init_from_matrix (graphene_frustum_t *f, |
71 | const graphene_matrix_t *matrix); |
72 | |
73 | GRAPHENE_AVAILABLE_IN_1_2 |
74 | bool graphene_frustum_contains_point (const graphene_frustum_t *f, |
75 | const graphene_point3d_t *point); |
76 | |
77 | GRAPHENE_AVAILABLE_IN_1_2 |
78 | bool graphene_frustum_intersects_sphere (const graphene_frustum_t *f, |
79 | const graphene_sphere_t *sphere); |
80 | GRAPHENE_AVAILABLE_IN_1_2 |
81 | bool graphene_frustum_intersects_box (const graphene_frustum_t *f, |
82 | const graphene_box_t *box); |
83 | |
84 | GRAPHENE_AVAILABLE_IN_1_2 |
85 | void graphene_frustum_get_planes (const graphene_frustum_t *f, |
86 | graphene_plane_t planes[]); |
87 | |
88 | GRAPHENE_AVAILABLE_IN_1_6 |
89 | bool graphene_frustum_equal (const graphene_frustum_t *a, |
90 | const graphene_frustum_t *b); |
91 | |
92 | GRAPHENE_END_DECLS |
93 | |