quakeforge/libs/models/trace.c

/*
	trace.c

	BSP line tracing

	Copyright (C) 2004 Bill Currie

	Author: Bill Currie <bill@taniwha.org>
	Date: 2004/9/25

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; either version 2
	of the License, or (at your option) any later version.

	This program 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 General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to:

		Free Software Foundation, Inc.
		59 Temple Place - Suite 330
		Boston, MA  02111-1307, USA

*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

static __attribute__ ((used)) const char rcsid[] =
	"$Id$";

#ifdef HAVE_STRING_H
# include <string.h>
#endif
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif

#include "QF/model.h"
#include "QF/sys.h"

#include "compat.h"
#include "world.h"

/* LINE TESTING IN HULLS */

static inline void
calc_impact (trace_t *trace, const vec3_t start, const vec3_t end,
			 mplane_t *plane)
{
	vec_t       t1, t2, frac, offset;
	vec3_t      dist;

	t1 = PlaneDiff (start, plane);
	t2 = PlaneDiff (end, plane);
	offset = 0;
	if (trace->isbox) {
		if (plane->type < 3)
			offset = trace->extents[plane->type];
		else
			offset = (fabs (trace->extents[0] * plane->normal[0])
					  + fabs (trace->extents[1] * plane->normal[1])
					  + fabs (trace->extents[2] * plane->normal[2]));
	}

	if (t1 < 0) {
		frac = (t1 + offset + DIST_EPSILON) / (t1 - t2);
		// invert plane paramterers
		VectorNegate (plane->normal, trace->plane.normal);
		trace->plane.dist = -plane->dist;
	} else {
		frac = (t1 - offset - DIST_EPSILON) / (t1 - t2);
		VectorCopy (plane->normal, trace->plane.normal);
		trace->plane.dist = plane->dist;
	}
	frac = bound (0, frac, 1);
	trace->fraction = frac;
	VectorSubtract (end, start, dist);
	VectorMultAdd (start, frac, dist, trace->endpos);
}
#ifdef ENABLE_BOXCLIP
typedef struct {
	mplane_t    *plane;
	int          side;
} tp_t;

typedef struct {
	const vec_t *start;
	const vec_t *end;
	const vec_t *extents;
	qboolean    isbox;
	hull_t      hull;
	tp_t        split;
	tp_t        straddle;
	tp_t        impact;
	float       fraction;
	int         flags;
} tl_t;

static inline void
set_split (tl_t *tl, mplane_t *plane, int side, tp_t *s)
{
	if (s)
		*s = tl->split;
	tl->split.plane = plane;
	tl->split.side = side;
}

static inline void
restore_split (tl_t *tl, tp_t *s)
{
	tl->split = *s;
}

static inline void
set_straddle (tl_t *tl, mplane_t *plane, int side, tp_t *s)
{
	if (s)
		*s = tl->straddle;
	tl->straddle.plane = plane;
	tl->straddle.side = side;
}

static inline void
restore_straddle (tl_t *tl, tp_t *s)
{
	tl->straddle = *s;
}

static inline void
set_impact (tl_t *tl, mplane_t *plane, int side)
{
	tl->impact.plane = plane;
	tl->impact.side = side;
}

#define print_tp(tp) \
	Sys_Printf ("%s [(%g %g %g) %g %d]\n", #tp, \
				(tp).plane->normal[0], (tp).plane->normal[1], \
				(tp).plane->normal[2], (tp).plane->dist, (tp).side)

static inline vec_t
sgn (vec_t v)
{
	return v < 0 ? -1 : (v > 0 ? 1 : 0);
}

static inline void
select_point (tl_t *tl, tp_t *impact, tp_t *split, vec3_t offs)
{
	int         axis;

	for (axis = 0; axis < 3; axis++) {
		vec_t       s = sgn (impact->plane->normal[axis]);
		if (!impact->side)
			s = -s;
		if (!s) {
			s = sgn (split->plane->normal[axis]);
			if (split->side)
				s = -s;
		}
		offs[axis] = tl->extents[axis] * s;
	}
}

static inline void
check_contents (int num, tl_t *tl)
{
	if (num != CONTENTS_SOLID) {
		tl->flags &= ~1;
		if (num == CONTENTS_EMPTY)
			tl->flags |= 4;
		else
			tl->flags |= 8;
	} else {
		if (!(tl->flags & 12))
			tl->flags |= 2;
	}
}

static inline float
calc_offset (tl_t *tl, mplane_t *plane)
{
	if (tl->isbox) {
		if (plane->type < 3)
			return tl->extents[plane->type];
		else
			return (fabs (tl->extents[0] * plane->normal[0])
					+ fabs (tl->extents[1] * plane->normal[1])
					+ fabs (tl->extents[2] * plane->normal[2]));
	}
	return 0;
}

static void
impact (tl_t *tl)
{
	float       t1, t2, offset, frac;
	int         side = 0;

	t1 = PlaneDiff (tl->start, tl->split.plane);
	t2 = PlaneDiff (tl->end, tl->split.plane);
	offset = calc_offset (tl, tl->split.plane);
	if (t1 < t2) {
		side = -1;
		frac = (t1 + offset) / (t1 - t2);
	} else if (t1 > t2) {
		side = 0;
		frac = (t1 - offset) / (t1 - t2);
	} else {
		frac = 0;
		Sys_DPrintf ("help! help! the world is falling apart!\n");
	}
	if (frac >= 0) {
		tl->fraction = frac;
		set_impact (tl, tl->split.plane, side);
//		print_tp (tl->impact);
	}
}

static int
validate_impact (tp_t *split, tl_t *tl)
{
	vec3_t      dist, point, offs;
	int         side;

	VectorSubtract (tl->end, tl->start, dist);
	VectorMultAdd (tl->start, tl->fraction, dist, point);
	select_point (tl, &tl->impact, split, offs);
	VectorAdd (point, offs, point);
	side = PlaneDiff (point, split->plane) < 0;
#if 0
	Sys_Printf ("\nimpact: (%g %g %g) (%g %g %g) %d %d\n",
				point[0], point[1], point[2],
				offs[0], offs[1], offs[2],
				side, split->side);
	print_tp (tl->impact);
	print_tp (*split);
#endif
	if (side != split->side) {
		tl->fraction = 1;
		set_impact (tl, 0, 0);
		return 0;
	}
	return 1;
}

#define set_point(a,s,b,c) \
	do { \
		(c)[0] = (a)[0] + (s)[0] * (b)[0]; \
		(c)[1] = (a)[1] + (s)[1] * (b)[1]; \
		(c)[2] = (a)[2] + (s)[2] * (b)[2]; \
	} while (0)

static int
validate_solid (const vec3_t p, tp_t *wall, tp_t *straddle, tl_t *tl)
{
	static const vec3_t edges[][2] = {
		{{ 1, -1,  1}, { 1,  1,  1}},
		{{-1, -1,  1}, { 1, -1,  1}},
		{{-1, -1,  1}, {-1,  1,  1}},
		{{-1,  1,  1}, { 1,  1,  1}},

		{{ 1,  1, -1}, { 1,  1,  1}},
		{{ 1, -1, -1}, { 1, -1,  1}},
		{{-1, -1, -1}, {-1, -1,  1}},
		{{-1,  1, -1}, {-1,  1,  1}},

		{{ 1, -1, -1}, { 1,  1, -1}},
		{{-1, -1, -1}, { 1, -1, -1}},
		{{-1, -1, -1}, {-1,  1, -1}},
		{{-1,  1, -1}, { 1,  1, -1}},
	};
	static const int tests[] = {
		0xa0a, 0x505, 0x0f0, 0x5f5, 0xafa, 0xf0f, 0xfff,
	};
	float       t, t1, t2, frac;
	int         side;
	vec3_t      p1, p2, dist, point;

	int         type = wall->plane->type;
	int         i;

	if (!straddle->plane)
		return 1;

	for (i = 0; i < 4; i++) {
		set_point (p, edges[i + 4][0], tl->extents, p1);
		t1 = PlaneDiff (p1, wall->plane);
		if ((t1 < 0) == wall->side) {
			t = PlaneDiff (p1, straddle->plane);
			if ((t < 0) == straddle->side)
				return 1;
		}
		set_point (p, edges[i + 4][1], tl->extents, p2);
		t2 = PlaneDiff (p2, wall->plane);
		if ((t2 < 0) == wall->side) {
			t = PlaneDiff (p2, straddle->plane);
			if ((t < 0) == straddle->side)
				return 1;
		}
	}

	if (type >= 3) {
		// don't trust multi-axial types
		if (!wall->plane->normal[0])
			type = 3;
		else if (!wall->plane->normal[1])
			type = 4;
		else if (!wall->plane->normal[1])
			type = 5;
		else
			type = 6;
	}
	for (i = 0; i < 12; i++) {
		if (!(tests[type] & (1 << i)))
			continue;

		set_point (p, edges[i][0], tl->extents, p1);
		set_point (p, edges[i][1], tl->extents, p2);

		t1 = PlaneDiff (p1, wall->plane);
		t2 = PlaneDiff (p2, wall->plane);
		if (t1 == t2)	// shouldn't happen because of the test bits, but...
			continue;	// the edge is parallel to the plane

		frac = t1 / (t1 - t2);
		if (frac < 0 || frac > 1)
			continue;	// the edge didn't hit the plane

		VectorSubtract (p2, p1, dist);
		VectorMultAdd (p1, frac, dist, point);

		t = PlaneDiff (point, straddle->plane);

		side = t < 0;

		if (!t || side == straddle->side)
			return 1;
	}
#if 0
	Sys_Printf ("\nsolid: (%g %g %g) (%g %g %g) %d %d\n",
				point[0], point[1], point[2],
				offs[0], offs[1], offs[2],
				side, straddle->side);
	print_tp (*wall);
	print_tp (*straddle);
#endif
	return 0;
}

static int
traceline (int num, float p1f, float p2f, const vec3_t p1, const vec3_t p2,
		   tl_t *tl)
{
	dclipnode_t *node;
	mplane_t   *plane;
	float       t1, t2, frac, frac2, midf, offset;
	int         side;
	vec3_t      mid;
	int         c1, c2;
	tp_t        split;

	// Skip past nodes that don't intersect with the line.
	do {
//		Sys_Printf ("%d\n", num);
		while (num >= 0) {
			node = tl->hull.clipnodes + num;
			plane = tl->hull.planes + node->planenum;

			t1 = PlaneDiff (p1, plane);
			t2 = PlaneDiff (p2, plane);
			offset = calc_offset (tl, plane);

			if (t1 >= offset && t2 >= offset) {
				num = node->children[0];
			} else if (t1 < -offset && t2 < -offset) {
				num = node->children[1];
			} else {
				break;
			}
//			Sys_Printf ("%d\n", num);
		}
		if (num < 0)
			return num;
	} while (0);

//	if (t1 == t2) {
	if (t1 >= -offset && t1 < offset && t2 >= -offset && t2 < offset) {
		tp_t        straddle;

		set_straddle (tl, plane, 0, &straddle);
		c1 = c2 = traceline (node->children[0], p1f, p2f, p1, p2, tl);
		if (c1 == CONTENTS_SOLID) {
			if (!validate_solid (p1, &tl->straddle, &straddle, tl))
				c1 = CONTENTS_EMPTY;
		} else {
			if (tl->impact.plane)
				validate_impact (&tl->straddle, tl);
		}
		if (c1 != CONTENTS_SOLID) {
			set_straddle (tl, plane, 1, 0);
			c2 = traceline (node->children[1], p1f, p2f, p1, p2, tl);
			if (c2 == CONTENTS_SOLID && !validate_solid (p1, &tl->straddle,
														 &straddle, tl))
				c2 = CONTENTS_EMPTY;
		}
		restore_straddle (tl, &straddle);
		if (c1 == CONTENTS_SOLID || c2 == CONTENTS_SOLID) {
			if (!p1f) {
				tl->flags &= 3;
				tl->flags |= 2;
			}
//			if (tl->split.plane)
//				impact (tl);
			return CONTENTS_SOLID;
		}
		if (c1 == CONTENTS_EMPTY && c2 == CONTENTS_EMPTY) {
			tl->flags &= ~1;
			tl->flags |= 4;
		} else {
			tl->flags &= ~1;
			tl->flags |= 8;
		}
		return min (c1, c2); //FIXME correct?
	} else {
		if (t1 < t2) {
			side = 1;
			frac  = (t1 - offset) / (t1 - t2);
			frac2 = (t1 + offset) / (t1 - t2);
		} else /*if (t1 > t2)*/ {
			side = 0;
			frac  = (t1 + offset) / (t1 - t2);
			frac2 = (t1 - offset) / (t1 - t2);
		}

		frac = bound (0, frac, 1);
		midf = p1f + (p2f - p1f) * frac;
		VectorSubtract (p2, p1, mid);
		VectorMultAdd (p1, frac, mid, mid);
		c1 = c2 = traceline (node->children[side], p1f, midf, p1, mid, tl);

		frac2 = bound (0, frac2, 1);
		midf = p1f + (p2f - p1f) * frac2;
		set_split (tl, plane, side ^ 1, &split);
		if (!tl->impact.plane || midf <= tl->fraction) {
			VectorSubtract (p2, p1, mid);
			VectorMultAdd (p1, frac2, mid, mid);
			c2 = traceline (node->children[side ^ 1], midf, p2f, mid, p2, tl);
		}

		if (c1 != CONTENTS_SOLID && c2 == CONTENTS_SOLID)
			impact (tl);
		restore_split (tl, &split);
		if (c1 == CONTENTS_SOLID && !(tl->flags & 0xc))
			tl->flags |= 2;
		if (c1 == CONTENTS_EMPTY || c2 == CONTENTS_EMPTY) {
			tl->flags &= ~1;
			tl->flags |= 4;
		}
		if (c1 < CONTENTS_SOLID || c2 < CONTENTS_SOLID) {
			tl->flags &= ~1;
			tl->flags |= 8;
		}

		return frac2 ? c1 : c2;
	}
}

VISIBLE void
MOD_TraceLine (hull_t *hull, int num,
			   const vec3_t start_point, const vec3_t end_point,
			   trace_t *trace)
{
	tl_t        tl;
	int         c;

	tl.start = start_point;
	tl.end = end_point;
	tl.hull = *hull;
	tl.fraction = 1;
	set_split (&tl, 0, 0, 0);
	set_straddle (&tl, 0, 0, 0);
	set_impact (&tl, 0, 0);
	tl.flags = 1;
	tl.isbox = trace->isbox;
	tl.extents = trace->extents;
	c = traceline (num, 0, 1, start_point, end_point, &tl);
	if (c == CONTENTS_EMPTY) {
		tl.flags &= ~1;
		tl.flags |= 4;
	}
	if (c < CONTENTS_SOLID) {
		tl.flags &= ~1;
		tl.flags |= 8;
	}
	if (tl.fraction < 1) {
		calc_impact (trace, start_point, end_point, tl.impact.plane);
	}
	trace->allsolid = (tl.flags & 1) != 0;
	trace->startsolid = (tl.flags & 2) != 0;
	trace->inopen = (tl.flags & 4) != 0;
	trace->inwater = (tl.flags & 8) != 0;
}
#else
typedef struct {
	vec3_t     end;
	int        side;
	int        num;
	mplane_t   *plane;
} tracestack_t;

VISIBLE void
MOD_TraceLine (hull_t *hull, int num,
			   const vec3_t start_point, const vec3_t end_point,
			   trace_t *trace)
{
	vec_t       start_dist, end_dist, offset, frac;
	vec3_t      start, end, dist;
	int         side, empty, solid;
	tracestack_t *tstack;
	tracestack_t tracestack[256];
	dclipnode_t *node;
	mplane_t   *plane, *split_plane;

	VectorCopy (start_point, start);
	VectorCopy (end_point, end);

	tstack = tracestack;
	empty = 0;
	solid = 0;
	split_plane = 0;

	while (1) {
		while (num < 0) {
			if (!solid && num != CONTENTS_SOLID) {
				empty = 1;
				if (num == CONTENTS_EMPTY)
					trace->inopen = true;
				else
					trace->inwater = true;
			} else if (!empty && num == CONTENTS_SOLID) {
				solid = 1;
			} else if (solid && num != CONTENTS_SOLID) {
				//FIXME not sure what I want
				//made it out of the solid and into open space, continue
				//on as if we were always in empty space
				empty = 1;
				solid = 0;
				trace->startsolid = 1;
				if (num == CONTENTS_EMPTY)
					trace->inopen = true;
				else
					trace->inwater = true;
			} else if (empty/* || solid*/) {//FIXME not sure what I want
				// DONE!
				trace->allsolid = solid & (num == CONTENTS_SOLID);
				trace->startsolid = solid;
				calc_impact (trace, start_point, end_point, split_plane);
				return;
			}

			// pop up the stack for a back side
			if (tstack-- == tracestack) {
				trace->allsolid = solid & (num == CONTENTS_SOLID);
				trace->startsolid = solid;
				return;
			}

			// set the hit point for this plane
			VectorCopy (end, start);

			// go down the back side
			VectorCopy (tstack->end, end);
			side = tstack->side;
			split_plane = tstack->plane;

			num = hull->clipnodes[tstack->num].children[side ^ 1];
		}

		node = hull->clipnodes + num;
		plane = hull->planes + node->planenum;

		offset = 0;
		start_dist = PlaneDiff (start, plane);
		end_dist = PlaneDiff (end, plane);
		if (trace->isbox) {
			if (plane->type < 3)
				offset = trace->extents[plane->type];
			else
				offset = (fabs (trace->extents[0] * plane->normal[0])
						  + fabs (trace->extents[1] * plane->normal[1])
						  + fabs (trace->extents[2] * plane->normal[2]));
		}

		/*	when offset is 0, the following is equivalent to:
				if (start_dist >= 0 && end_dist >= 0) ...
				if (start_dist < 0 && end_dist < 0) ...
			due to the order of operations
			however, when (start_dist == offset && end_dist == offset) or
			(start_dist == -offset && end_dist == -offset), the trace will go
			down the /correct/ side of the plane: ie, the side the box is
			actually on
		*/
		if (start_dist >= offset && end_dist >= offset) {
			// entirely in front of the plane
			num = node->children[0];
			continue;
		}
		//if (start_dist <= -offset && end_dist <= -offset) {
		//XXX not so equivalent, it seems.
		if (start_dist < -offset && end_dist < -offset) {
			// entirely behind the plane
			num = node->children[1];
			continue;
		}
		// when offset is 0, equvalent to (start_dist >= 0 && end_dist < 0) and
		// (start_dist < 0 && end_dist >= 0) due to the above tests.
		if (start_dist >= offset && end_dist <= -offset) {
			side = 0;
			frac = (start_dist - offset) / (start_dist - end_dist);
		} else if (start_dist <= offset && end_dist >= offset) {
			side = 1;
			frac = (start_dist + offset) / (start_dist - end_dist);
		} else {
			// get here only when offset is non-zero
			Sys_DPrintf ("foo\n");
			frac = 1;
			side = start_dist < end_dist;
		}
		frac = bound (0, frac, 1);

		tstack->num = num;
		tstack->side = side;
		tstack->plane = plane;
		VectorCopy (end, tstack->end);
		tstack++;

		VectorSubtract (end, start, dist);
		VectorMultAdd (start, frac, dist, end);

		num = node->children[side];
	}
}
#endif