summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/object.h
blob: 2ee4b67c96495a86c13ec229829f4320ac715b95 (plain)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*************************************************************************
 * Copyright (C) 2009-2010 Tavian Barnes <tavianator@gmail.com>          *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library is free software; you can redistribute it and/  *
 * or modify it under the terms of the GNU Lesser General Public License *
 * as published by the Free Software Foundation; either version 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library is distributed in the hope that it will be      *
 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty   *
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

/**
 * @file
 * Objects.
 */

#ifndef DIMENSION_OBJECT_H
#define DIMENSION_OBJECT_H

#include <stdbool.h>

/** A type to represent a ray-object intersection. */
typedef struct dmnsn_intersection {
  dmnsn_line ray; /**< The ray that intersected. */
  double t;       /**< The line index that intersected. */

  /** The surface normal at the intersection point. */
  dmnsn_vector normal;

  /** The texture at the intersection point. */
  const dmnsn_texture *texture;
  /** The interior at the intersection point. */
  const dmnsn_interior *interior;
} dmnsn_intersection;

/* Forward-declare dmnsn_object */
typedef struct dmnsn_object dmnsn_object;

/**
 * Object initialization callback.
 * @param[in,out] object  The object to initialize.
 */
typedef void dmnsn_object_init_fn(dmnsn_object *object);

/**
 * Ray-object intersection callback.
 * @param[in]  object        The object to test.
 * @param[in]  line          The line to test.
 * @param[out] intersection  Where to store the intersection details of the
 *                           closest (if any) intersection.
 * @return Whether \p line intersected \p object.
 */
typedef bool dmnsn_object_intersection_fn(const dmnsn_object *object,
                                          dmnsn_line line,
                                          dmnsn_intersection *intersection);

/**
 * Object inside callback.
 * @param[in] object  The object to test.
 * @param[in] point   The point to test.
 * @return Whether \p point is inside \p object.
 */
typedef bool dmnsn_object_inside_fn(const dmnsn_object *object,
                                    dmnsn_vector point);

/** An object. */
struct dmnsn_object {
  dmnsn_texture *texture;   /**< Surface properties. */
  dmnsn_interior *interior; /**< Interior properties. */

  dmnsn_matrix trans;     /**< Transformation matrix. */
  dmnsn_matrix trans_inv; /**< Inverse of the transformation matrix. */

  dmnsn_bounding_box bounding_box; /**< Object bounding box. */

  /** Child objects.  This array lists objects that can be split into
      sub-objects for bounding purposes (for unions and meshes, for example). */
  dmnsn_array *children;

  dmnsn_object_init_fn         *init_fn; /**< Initialization callback. */
  dmnsn_object_intersection_fn *intersection_fn; /**< Intersection callback. */
  dmnsn_object_inside_fn       *inside_fn; /**< Inside callback. */
  dmnsn_free_fn                *free_fn; /**< Destruction callback. */

  /** Generic pointer for object info. */
  void *ptr;
};

/**
 * Allocate a dummy object.
 * @return The allocated object.
 */
dmnsn_object *dmnsn_new_object(void);

/**
 * Free an object
 * @param[in,out] object  The object to destroy.
 */
void dmnsn_delete_object(dmnsn_object *object);

/**
 * Initialize an object and potentially its children.
 * @param[in,out] object  The object to initialize.
 */
void dmnsn_object_init(dmnsn_object *object);

/**
 * Appropriately transform a ray, then test for an intersection.
 * @param[in]  object        The object to test.
 * @param[in]  line          The ray to test.
 * @param[out] intersection  Where to store the intersection details.
 * @return Whether there was an intersection.
 */
bool dmnsn_object_intersection(const dmnsn_object *object, dmnsn_line line,
                               dmnsn_intersection *intersection);

/**
 * Appropriately transform a point, then test for containment.
 * @param[in] object  The object to test.
 * @param[in] point   The point to test.
 * @return Whether \p point was inside \p object.
 */
bool dmnsn_object_inside(const dmnsn_object *object, dmnsn_vector point);

#endif /* DIMENSION_OBJECT_H */