Renegade/Code/wwphys/widgets.h

/*
**	Command & Conquer Renegade(tm)
**	Copyright 2025 Electronic Arts Inc.
**
**	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 3 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, see <http://www.gnu.org/licenses/>.
*/

/***********************************************************************************************
 ***              C O N F I D E N T I A L  ---  W E S T W O O D  S T U D I O S               ***
 ***********************************************************************************************
 *                                                                                             *
 *                 Project Name : WWPhys                                                       *
 *                                                                                             *
 *                     $Archive:: /Commando/Code/wwphys/widgets.h                             $*
 *                                                                                             *
 *                       Author:: Greg Hjelstrom                                               *
 *                                                                                             *
 *                     $Modtime:: 7/29/99 11:25a                                              $*
 *                                                                                             *
 *                    $Revision:: 2                                                           $*
 *                                                                                             *
 *---------------------------------------------------------------------------------------------*
 * Functions:                                                                                  *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */


#if defined(_MSC_VER)
#pragma once
#endif

#ifndef WIDGETS_H
#define WIDGETS_H

class RenderObjClass;

/*
** Debug Widgets.  These render objects will be used by the physics debugging code
** to render bounding boxes, force vectors, co-ordinate axes, etc.  These are meant
** to be rendered immediately and then released because someone else could come along
** and get a pointer to the same object.  
*/
class WidgetSystem
{
public:

	enum WidgetType
	{
		WIDGET_AABOX = 0,		// an AABoxRenderObjClass
		WIDGET_OBBOX,			// an OBBoxRenderObjClass
		WIDGET_VECTOR,			// a skin, designed to point along -z (use with lookat) with bones Point0, Point1
		WIDGET_AXES,			// a mesh with red,green,and blue axes for +x,+y,+z
		WIDGET_POINT,			// a 0.1m sphere
		NUM_WIDGETS
	};

	static void						Init_Debug_Widgets(void);
	static void						Release_Debug_Widgets(void);
	static RenderObjClass *		Get_Debug_Widget(WidgetType id);

protected:

	/*
	** Debug widgets.  These are render objects that are used to aid in debugging
	** the physics system.  They are allocated in Init_Debug_Widgets and released
	** in Release_Debug_Widgets.  Users can get at them through the Get_Debug_Widget
	** call.  They are meant to be rendered immediately and released.
	*/
#ifdef WWDEBUG
	static RenderObjClass *	DebugWidgets[NUM_WIDGETS];
#endif
};

#endif