HudGaugeEscort Class Reference

#include <hudescort.h>

Inheritance diagram for HudGaugeEscort:

Public Member Functions
	HudGaugeEscort ()
void	initBitmaps (char *fname_top, char *fname_middle, char *fname_bottom)
void	initHeaderText (char *text)
void	initHeaderTextOffsets (int x, int y)
void	initListStartOffsets (int x, int y)
void	initEntryHeight (int h)
void	initEntryStaggerWidth (int w)
void	initBottomBgOffset (int offset)
void	initShipNameOffsets (int x, int y)
void	initShipIntegrityOffsets (int x, int y)
void	initShipStatusOffsets (int x, int y)
void	initShipNameMaxWidth (int w)
void	initRightAlignNames (bool align)
int	setGaugeColorEscort (int index, int team)
virtual void	render (float frametime)
void	pageIn ()
void	renderIcon (int x, int y, int index)
void	renderIconDogfight (int x, int y, int index)
Public Member Functions inherited from HudGauge
	HudGauge ()
	HudGauge (int _gauge_object, int _gauge_config, bool _slew, bool _message, int _disabled_views, int r, int g, int b)
	HudGauge (int _gauge_config, bool _slew, int r, int g, int b, char *_custom_name, char *_custom_text, char *frame_fname, int txtoffset_x, int txtoffset_y)
virtual	~HudGauge ()
void	initPosition (int x, int y)
void	initBaseResolution (int w, int h)
void	initSlew (bool slew)
void	initFont (int input_font_num)
void	initCockpitTarget (const char *display_name, int _target_x, int _target_y, int _target_w, int _target_h, int _canvas_w, int _canvas_h)
void	initRenderStatus (bool render)
int	getConfigType ()
int	getObjectType ()
void	getPosition (int *x, int *y)
bool	isOffbyDefault ()
bool	isActive ()
void	updateColor (int r, int g, int b, int a=255)
void	lockConfigColor (bool lock)
void	sexpLockConfigColor (bool lock)
void	updateActive (bool show)
void	updatePopUp (bool pop_up_flag)
void	updateSexpOverride (bool sexp)
void	startFlashSexp ()
int	maybeFlashSexp ()
bool	flashExpiredSexp ()
void	resetTimers ()
const char *	getCustomGaugeName ()
void	updateCustomGaugeCoords (int _x, int _y)
void	updateCustomGaugeFrame (int frame_offset)
void	updateCustomGaugeText (const char *txt)
void	updateCustomGaugeText (const SCP_string &txt)
const char *	getCustomGaugeText ()
void	startPopUp (int time=4000)
int	popUpActive ()
virtual void	preprocess ()
virtual bool	canRender ()
virtual void	initialize ()
virtual void	onFrame (float frametime)
bool	setupRenderCanvas (int render_target=-1)
void	setCockpitTarget (const cockpit_display *display)
void	resetCockpitTarget ()
void	setFont ()
void	setGaugeColor (int bright_index=-4)
void	renderBitmap (int x, int y)
void	renderBitmap (int frame, int x, int y)
void	renderBitmapColor (int frame, int x, int y)
void	renderBitmapUv (int frame, int x, int y, int w, int h, float u0, float v0, float u1, float v1)
void	renderBitmapEx (int frame, int x, int y, int w, int h, int sx, int sy)
void	renderString (int x, int y, const char *str)
void	renderString (int x, int y, int gauge_id, const char *str)
void	renderStringAlignCenter (int x, int y, int area_width, const char *s)
void	renderPrintf (int x, int y, const char *format,...)
void	renderPrintf (int x, int y, int gauge_id, const char *format,...)
void	renderLine (int x1, int y1, int x2, int y2)
void	renderGradientLine (int x1, int y1, int x2, int y2)
void	renderRect (int x, int y, int w, int h)
void	renderCircle (int x, int y, int diameter)
void	unsize (int *x, int *y)
void	unsize (float *x, float *y)
void	resize (int *x, int *y)
void	resize (float *x, float *y)
void	setClip (int x, int y, int w, int h)
void	resetClip ()

Protected Attributes
hud_frames	Escort_gauges [NUM_ESCORT_FRAMES]
int	header_text_offsets [2]
char	header_text [NAME_LENGTH]
int	list_start_offsets [2]
int	entry_h
int	entry_stagger_w
int	bottom_bg_offset
int	ship_name_offsets [2]
int	ship_integrity_offsets [2]
int	ship_status_offsets [2]
int	ship_name_max_width
bool	right_align_names
Protected Attributes inherited from HudGauge
int	position [2]
int	base_w
int	base_h
color	gauge_color
int	gauge_config
int	gauge_object
int	font_num
bool	lock_color
bool	sexp_lock_color
bool	reticle_follow
bool	active
bool	off_by_default
bool	sexp_override
bool	pop_up
int	popup_timer
bool	message_gauge
int	disabled_views
int	flash_duration
int	flash_next
bool	flash_status
bool	custom_gauge
hud_frames	custom_frame
int	custom_frame_offset
int	textoffset_x
int	textoffset_y
char	custom_name [NAME_LENGTH]
SCP_string	custom_text
SCP_string	default_text
char	texture_target_fname [MAX_FILENAME_LEN]
int	texture_target
int	canvas_w
int	canvas_h
int	target_w
int	target_h
int	target_x
int	target_y
int	display_offset_x
int	display_offset_y

Detailed Description

Definition at line 40 of file hudescort.h.

Constructor & Destructor Documentation

HudGaugeEscort::HudGaugeEscort

(

)

Definition at line 145 of file hudescort.cpp.

Member Function Documentation

void HudGaugeEscort::initBitmaps	(	char *	fname_top,
		char *	fname_middle,
		char *	fname_bottom
	)

Definition at line 210 of file hudescort.cpp.

void HudGaugeEscort::initBottomBgOffset

(

int

offset

)

Definition at line 177 of file hudescort.cpp.

void HudGaugeEscort::initEntryHeight

(

int

h

)

Definition at line 167 of file hudescort.cpp.

void HudGaugeEscort::initEntryStaggerWidth

(

int

w

)

Definition at line 172 of file hudescort.cpp.

void HudGaugeEscort::initHeaderText

(

char *

text

)

Definition at line 150 of file hudescort.cpp.

void HudGaugeEscort::initHeaderTextOffsets	(	int	x,
		int	y
	)

Definition at line 155 of file hudescort.cpp.

void HudGaugeEscort::initListStartOffsets	(	int	x,
		int	y
	)

Definition at line 161 of file hudescort.cpp.

void HudGaugeEscort::initRightAlignNames

(

bool

align

)

Definition at line 205 of file hudescort.cpp.

void HudGaugeEscort::initShipIntegrityOffsets	(	int	x,
		int	y
	)

Definition at line 188 of file hudescort.cpp.

void HudGaugeEscort::initShipNameMaxWidth

(

int

w

)

Definition at line 200 of file hudescort.cpp.

void HudGaugeEscort::initShipNameOffsets	(	int	x,
		int	y
	)

Definition at line 182 of file hudescort.cpp.

void HudGaugeEscort::initShipStatusOffsets	(	int	x,
		int	y
	)

Definition at line 194 of file hudescort.cpp.

void HudGaugeEscort::pageIn ( )

virtual

Reimplemented from HudGauge.

Definition at line 231 of file hudescort.cpp.

void HudGaugeEscort::render ( float  frametime )

virtual

Reimplemented from HudGauge.

Definition at line 288 of file hudescort.cpp.

void HudGaugeEscort::renderIcon	(	int	x,
		int	y,
		int	index
	)

Definition at line 343 of file hudescort.cpp.

void HudGaugeEscort::renderIconDogfight	(	int	x,
		int	y,
		int	index
	)

Definition at line 404 of file hudescort.cpp.

int HudGaugeEscort::setGaugeColorEscort	(	int	index,
		int	team
	)

Definition at line 240 of file hudescort.cpp.

Member Data Documentation

int HudGaugeEscort::bottom_bg_offset

protected

Definition at line 50 of file hudescort.h.

int HudGaugeEscort::entry_h

protected

Definition at line 48 of file hudescort.h.

int HudGaugeEscort::entry_stagger_w

protected

Definition at line 49 of file hudescort.h.

hud_frames HudGaugeEscort::Escort_gauges[NUM_ESCORT_FRAMES]

protected

Definition at line 43 of file hudescort.h.

char HudGaugeEscort::header_text[NAME_LENGTH]

protected

Definition at line 46 of file hudescort.h.

int HudGaugeEscort::header_text_offsets[2]

protected

Definition at line 45 of file hudescort.h.

int HudGaugeEscort::list_start_offsets[2]

protected

Definition at line 47 of file hudescort.h.

bool HudGaugeEscort::right_align_names

protected

Definition at line 55 of file hudescort.h.

int HudGaugeEscort::ship_integrity_offsets[2]

protected

Definition at line 52 of file hudescort.h.

int HudGaugeEscort::ship_name_max_width

protected

Definition at line 54 of file hudescort.h.

int HudGaugeEscort::ship_name_offsets[2]

protected

Definition at line 51 of file hudescort.h.

int HudGaugeEscort::ship_status_offsets[2]

protected

Definition at line 53 of file hudescort.h.

---

The documentation for this class was generated from the following files:

• code/hud/hudescort.h
• code/hud/hudescort.cpp