BlamRendering::RenderStack::TickCounter Class Reference

Class to contain the onscreen tick counter display. More...

#include <tick_counter.hpp>

Inheritance diagram for BlamRendering::RenderStack::TickCounter:

Public Member Functions
void	increment ()
	TickCounter ()
	~TickCounter ()
void	Draw ()
	Draws the stack object. More...
void	ShowImPropertyEditor ()
	Shows a set of ImGUI properties associated with the object. More...
void	onTickEvent (Blam::Events::TickEvent *event)
	Called when the listener is subscribed to Key Press events, and a new TickEvent is fired. More...
Public Member Functions inherited from BlamRendering::RenderStack::StackObjectBase
	StackObjectBase ()
	Sets default values and provides a default ID to be used if none is provided. More...
	~StackObjectBase ()
	Empty destructor. More...
virtual void	HandleResize ()
	Called upon window resize events. More...
void	SetArea (float new_area[4])
	Sets the area of the object. More...
void	SetArea (float top, float bottom, float left, float right)
	Sets the area of the object. More...
void	SetArea (D2D1_RECT_F new_area)
	Sets the area of the object. More...
void	SetColor (float new_color[3])
	Sets the color of the object. More...
void	SetColor (float r, float g, float b)
	Sets the color of the object. More...
void	SetColor (float r, float g, float b, float a)
	Sets the color of the object. More...
void	SetColor (D2D1::ColorF color)
	Sets the color of the object. More...
void	SetZOrder (int z)
	Sets the Z-Order of the object. More...
void	SetTranslation (float new_x, float new_y)
	Sets the translation of the object. More...
void	PokeTranslation ()
	Updates the area of the object to account for any x/y coordinate changes. More...
void	SetSize (float new_width, float new_height)
	Sets the size of the object. More...
void	PokeSize ()
	Updates the area of the object to account for any width/height changes. More...
void	ValidateSizeAndTranslation ()
	Validates X/Y coordinates and Width/Height sizes after the area has been modified. More...
std::string	GetType ()
	Retrieves the type of item that this stack object is. More...
std::string	GetDrawModeLabel ()
	Retrieves the current drawing mode of the object. More...
Public Member Functions inherited from Blam::Events::EventListener
void	Subscribe (EventType type)
	Subscribes to an event type. More...
	~EventListener ()
std::vector< EventType >	getSubscribedEvents ()
	Retrieves the list of subscribed event types. More...
bool	isSubscribed (EventType type)
	Determines whether or not the listener is subscribed to the specified event type. More...
void	SetPriority (int new_priority)
	Sets the priority of the listener. More...
int	GetPriority ()
	Retrieves the priority of the listener. More...
virtual void	onCharacterInputEvent (Blam::Events::CharacterInputEvent *event)
	Called when the listener is subscribed to Character Input events, and a new CharacterInputEvent is fired. More...
virtual void	onKeyPressEvent (Blam::Events::KeyPressEvent *event)
	Called when the listener is subscribed to Key Press events, and a new KeyPressEvent is fired. More...

Additional Inherited Members
Public Attributes inherited from BlamRendering::RenderStack::StackObjectBase
D2D1_RECT_F	area
	The area of the object. More...
D2D1_COLOR_F	color
	The color of the object. More...
int	z_order = 0
	The Z-Order of the object. More...
StackType	type_label = STACKTYPE_GENERIC
	The type of the object. More...
StackItemDrawMode	draw_mode = DEFAULT_DRAWMODE
	The drawing mode of the object. More...
bool	visible = true
	Whether or not the object is visible. More...
float	x = 0
	The X coordinate of the object. More...
float	y = 0
	The Y coordinate of the object. More...
float	width = 100
	The width of the object. More...
float	height = 100
	The height of the object. More...
std::string	unique_id = ""
	The unique ID of this object. More...

Detailed Description

Class to contain the onscreen tick counter display.

It does not actually count the number of ticks, but rather increments on each tick.

From the words of Lord Zedd himself:

as long as its ticking you know the game is running

Constructor & Destructor Documentation

TickCounter()

BlamRendering::RenderStack::TickCounter::TickCounter ( )

inline

~TickCounter()

BlamRendering::RenderStack::TickCounter::~TickCounter ( )

inline

Member Function Documentation

Draw()

void BlamRendering::RenderStack::TickCounter::Draw ( )

inlinevirtual

Draws the stack object.

Specific functionality may vary depending on the type of object.

Reimplemented from BlamRendering::RenderStack::StackObjectBase.

increment()

void BlamRendering::RenderStack::TickCounter::increment ( )

inline

onTickEvent()

void BlamRendering::RenderStack::TickCounter::onTickEvent ( Blam::Events::TickEvent *  event )

inlinevirtual

Called when the listener is subscribed to Key Press events, and a new TickEvent is fired.

Parameters

-	The event that was fired.

Reimplemented from Blam::Events::EventListener.

ShowImPropertyEditor()

void BlamRendering::RenderStack::TickCounter::ShowImPropertyEditor ( )

inlinevirtual

Shows a set of ImGUI properties associated with the object.

This will call functions to draw only the property controls for the item, and nothing else. The window/container for the properties must be handled externally.

Reimplemented from BlamRendering::RenderStack::StackObjectBase.

---

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

• blam/components/rendering/directx11/render_stack/stack_types/blam_ui/tick_counter.hpp