/*!
 * \file
 * \ingroup 	display
 * \brief	Displays the 3d objects
 */
#ifndef __OBJ_3D_H__
#define __OBJ_3D_H__

#include "e3d_object.h"
#include "e3d.h"

#ifdef __cplusplus
extern "C" {
#endif

extern int use_3d_alpha_blend;	// do 3d models use alpha blending?

/*!
 * \ingroup	display_3d
 * \brief	Optimized display or a selected 3d object list
 *
 * \return	nothing.
 */
void draw_3d_objects();

/*!
 * \ingroup	load_3d
 * \brief	Adds a 3d object with a specific ID to the map 
 * 
 * 		Adds a 3d object to the map, at position \a id in the objects_list
 * 
 * \param	id The object ID		
 * \param	file_name The file name of the 3d object
 * \param	x_pos The x position
 * \param	y_pos The y position
 * \param	z_pos The z position
 * \param	x_rot The x rotation
 * \param	y_rot The y rotation
 * \param	z_rot The z rotation
 * \param	self_lit Whether the object is self-lit (enables/disables lightning)
 * \param	blended Whether the object is blended (enables/disables blending - GL_ONE,GL_ONE)
 * \param	r Red (0<=r<=1)
 * \param	g Green (0<=g<=1)
 * \param	b Blue (0<=b<=1)
 * \retval int	Returns -1 on error or the position in the objects_list on succes.
 * \callgraph
 */
int add_e3d_at_id (int id, const char *file_name, float x_pos, float y_pos, float z_pos, float x_rot, float y_rot, float z_rot, char self_lit, char blended, float r, float g, float b, unsigned int dynamic);

/*!
 * \ingroup	load_3d
 * \brief	Adds a 3d object to the map.
 * 
 * 		It is usually called from load_map. It adds a 3d object to the given position.
 * 		
 * \param	file_name The file name of the 3d object
 * \param	x_pos The x position
 * \param	y_pos The y position
 * \param	z_pos The z position
 * \param	x_rot The x rotation
 * \param	y_rot The y rotation
 * \param	z_rot The z rotation
 * \param	self_lit Whether the object is self-lit (enables/disables lightning)
 * \param	blended Whether the object is blended (enables/disables blending - GL_ONE,GL_ONE)
 * \param	r Red (0<=r<=1)
 * \param	g Green (0<=g<=1)
 * \param	b Blue (0<=b<=1)
 * \retval int	Returns -1 on error or the position in the objects_list on succes.
 * 
 * \sa add_e3d_at_id
 *
 * \callgraph
 */
int add_e3d (const char * file_name, float x_pos, float y_pos, float z_pos, float x_rot, float y_rot, float z_rot, char self_lit, char blended, float r, float g, float b, unsigned int dynamic);

/*!
 * \ingroup	display_3d
 * \brief	Displays the 3d objects within the range
 *
 * 		Cycles through the objects_list, and displays the 3d object if it's within a visible distance (dist_x^2+dist_y^2<=29*29)
 * 		
 * \callgraph
 */
void display_objects();
void display_ground_objects();
void display_alpha_objects();

/*!
 * \ingroup	display_3d
 * \brief	Displays the blended 3d objects within range
 *
 * 		Cycles through the blended objects list and displays the blended 3d objects within visible range.
 * 		
 * \callgraph
 */
void display_blended_objects();

/*! 
 * \ingroup	display_3d
 * \brief	Clears the clouds cache 
 *
 * 		The function clears the clouds cache, which leads to the clouds map will have to be recalculated for the given object. 
 * 		It is called every 10 seconds.
 * 
 * \callgraph
 */
void clear_clouds_cache();

/*!
 * \ingroup	display_3d
 * \brief	Destroys the 3d object at position i in the objects list
 * 
 * 		Destroyes the 3d object on position i in the objects_list - frees the memory and sets the objects_list[i]=NULL.
 *
 * \param	i The position in the objects_list
 *
 * \callgraph
 */
void destroy_3d_object(int i);

void destroy_e3d(e3d_object *e3d_id);

/*!
 * \ingroup	load_3d
 * \brief	Show or hide one or more 3D map objects
 * 
 * 		Show or hide 3D map objects.
 *		This routine is usually under server control to allow dynamically enabling or disabling seeing objects
 *
 * \param	display_flag whether the objects are to be displayed or not
 * \param	ptr pointer to an array of object ID's to be affected
 * \param	len the length in bytes of the array
 * \callgraph
 */
void set_3d_object (Uint8 display, const void *ptr, int len);

/*!
 * \ingroup	load_3d
 * \brief	Set the state for one or more 3D map objects
 * 
 * 		Set the sate for 3D map objects.
 *		This routine is usually under server control to allow dynamically setting a state for an object, this is for future expansion
 *
 * \param	display_flag whether the objects are to be displayed or not
 * \param	ptr pointer to an array of object ID's to be affected
 * \param	len the length in bytes of the array
 * \callgraph
 */
void state_3d_object (Uint8 state, const void *ptr, int len);

/*!
 * \ingroup	load_3d
 * \brief	Check to see if file_name is in the e3d cache - if not, load it
 *
 * 	Check to see if file_name is in the e3d_cache - if not, load it
 *
 * \param	file_name
 * \retval	A pointer to the e3d object
 */
e3d_object *load_e3d_cache (const char * file_name);

/*!
 * \ingroup	load_3d
 * \brief	Clears the placeholders
 *
 * 	Clears the placeholders. Used to avoid the ghost object bug
 *
 */
void clear_objects_list_placeholders();

/*!
 * \ingroup	load_3d
 * \brief	Increments the number of placeholders
 *
 * 	Increments the number of placeholders. Used to avoid the ghost object bug
 *
 */
void inc_objects_list_placeholders();

#ifdef NEW_SOUND
/*!
 * \ingroup	load_3d
 * \brief	Searches for a 3d object at a location
 * 
 * 		It searches for a 3d object at the specified location
 * 		
 * \param	x_pos		The x position to search for
 * \param	y_pos		The y position to search for
 * \retval char			Returns the object's filename if found, "" otherwise.
 * 
 * \sa add_e3d_at_id
 *
 * \callgraph
 */
char * get_3dobject_at_location(float x_pos, float y_pos);
#endif // NEW_SOUND

/*!
 * \ingroup	display_3d
 * \brief	Draw a specific 3d object
 * 
 * 		Draw a specific 3d object, with optinal enabled lightning and textures.
 *
 * \param	object_id The object to draw
 * \param	material_index The material part of the object to draw
 * \param	use_lightning Should lightning be used (normals, colors and material properties)
 * \param	use_textures Should default texturing be used
 * \param	use_extra_textures Should extra texturing be used (e.g. clouds)
 *
 * \callgraph
 */
void draw_3d_object_detail(object3d * object_id, Uint32 material_index, Uint32 use_lightning,
	Uint32 use_textures, Uint32 use_extra_textures);

/*!
 * \ingroup	display_3d
 * \brief	Disables the buffer arrays.
 * 
 * 		Unlocks compiled vertex arrays, sets VBO to zero and clears current used 3d object.
 *
 * \callgraph
 */
void disable_buffer_arrays();

#ifdef __cplusplus
} // extern "C"
#endif

#endif
