half-edge/src/half_edge.h

/*
 * Copyright 2011-2014 hasufell
 *
 * This file is part of a hasufell project.
 *
 * 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 version 2 of the License only.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * @file half_edge.h
 * Header for the external API of half_edge.c,
 * primarily holding the common half-edge data
 * structures.
 * @brief header of half_edge.c
 */

#ifndef _DROW_ENGINE_HE_OPERATIONS_H
#define _DROW_ENGINE_HE_OPERATIONS_H


#include "vector.h"

#include <stdbool.h>
#include <stdint.h>


/**
 * Fault intolerant macro. Will abort the program if the called
 * function failed.
 */
#define FACE_NORMAL(...) \
{ \
	if (!face_normal(__VA_ARGS__)) { \
		fprintf(stderr, "Failure in face_normal()!\n"); \
		abort(); \
	} \
}

/**
 * Fault intolerant macro. Will abort the program if the called
 * function failed.
 */
#define VEC_NORMAL(...) \
{ \
	if (!vec_normal(__VA_ARGS__)) { \
		fprintf(stderr, "Failure in vec_normal()!\n"); \
		abort(); \
	} \
}

/**
 * Fault intolerant macro. Will abort the program if the called
 * function failed.
 */
#define FIND_CENTER(...) \
{ \
	if (!find_center(__VA_ARGS__)) { \
		fprintf(stderr, "Failure in find_center()!\n"); \
		abort(); \
	} \
}

/**
 * Fault intolerant macro. Will abort the program if the called
 * function failed.
 */
#define NORMALIZE_OBJECT(...) \
{ \
	if (!normalize_object(__VA_ARGS__)) { \
		fprintf(stderr, "Failure in normalize_object()!\n"); \
		abort(); \
	} \
}


typedef double** VERTICES;
typedef double** FACES;
typedef double** V_TEXTURES;

typedef struct HE_edge HE_edge;
typedef struct HE_vert HE_vert;
typedef struct HE_face HE_face;
typedef struct HE_obj HE_obj;
typedef struct color color;


/**
 * Represents a half-edge.
 */
struct HE_edge {
	/**
	 * Start-vertex of the halfe-edge.
	 */
	HE_vert *vert;
	/**
	 * Oppositely oriented adjacent half-edge.
	 * Border edges have a dummy pair which have "face"
	 * and "next" set to NULL.
	 */
	HE_edge *pair;
	/**
	 * Face the half-edge borders.
	 */
	HE_face *face;
	/**
	 * Next half-edge around the face.
	 */
	HE_edge *next;
};

/**
 * Represents a vertex with a random attached
 * half-edge.
 */
struct HE_vert {
	/**
	 * A vector pointing
	 * to the coordinates of the vertex.
	 */
	vector *vec;

	/**
	 * One of the half-edges emanating from the vertex.
	 * It is made sure that this is never a border edge,
	 * unless there are only border edges.
	 */
	HE_edge *edge;

	/**
	 * Acceleration structure which saves all potential
	 * pair edges that point TO this vertex. It is used
	 * for finding the pairs when assembling
	 * the HE_edge struct. Note that this does not reliably
	 * save all border edges (which is a non-issue for the
	 * specific purpose of this struct since border-edges
	 * don't qualify for pairs anyway).
	 */
	HE_edge **edge_array;

	/**
	 * Element count of the edge_array.
	 */
	uint32_t eac;

	/**
	 * Color of the vertex.
	 */
	color *col;
};

/**
 * Represents a face
 */
struct HE_face {
	/**
	 * One of the half-edges bordering the face.
	 */
	HE_edge *edge;
};

/**
 * Represents a collection of HE_edge, HE_vert and HE_face
 * which are all attached to one object. This is useful
 * for algorithms that need to iterate over one or another.
 */
struct HE_obj {
	/**
	 * Array of edges.
	 */
	HE_edge *edges;
	/**
	 * Array of vertices.
	 */
	HE_vert *vertices;
	/**
	 * Array of faces.
	 */
	HE_face *faces;
	/**
	 * Count of edges.
	 */
	uint32_t ec;
	/**
	 * Count of vertices.
	 */
	uint32_t vc;
	/**
	 * Count of faces.
	 */
	uint32_t fc;
};

/**
 * Color.
 */
struct color {
	float red;
	float green;
	float blue;
};


bool face_normal(HE_edge const * const edge,
		vector *vec);
bool vec_normal(HE_vert const * const vert, vector *vec);
bool find_center(HE_obj const * const obj, vector *vec);
float get_normalized_scale_factor(HE_obj const * const obj);
bool normalize_object(HE_obj *obj);
HE_obj *parse_obj(char const * const filename);
void delete_object(HE_obj *obj);


#endif /* _DROW_ENGINE_HE_OPERATIONS_H */