BlamUIWidget_UserIDCypher Class Reference

UI widget for the user ID cypher display. More...

#include <uid_cypher.h>

Inheritance diagram for BlamUIWidget_UserIDCypher:

Collaboration diagram for BlamUIWidget_UserIDCypher:

Public Member Functions
	BlamUIWidget_UserIDCypher (BlamUIWidget_Group *_parent)
	Constructs a new user ID cypher widget. More...
	~BlamUIWidget_UserIDCypher ()
	Destroys the user ID cypher widget. More...
void	Draw () override
void	ShowImGuiPropertyEditor () override
void	UpdateMetrics () override
void	RefreshRelativePosition () override
void	OnTickEvent (TickEvent *event) override
Public Member Functions inherited from BlamUIWidget
	BlamUIWidget (BlamWidgetType type)
	BlamUIWidget (BlamWidgetType type, BlamUIWidget_Group *_parent)
virtual	~BlamUIWidget ()
BlamWidgetType	GetType ()
void	RefreshRelativePosition (int viewport_width, int viewport_height, BlamVector2 initial_position)
void	SetSize (BlamVector2 new_size)
virtual void	SetPosition (BlamVector2 new_position)
void	SetRotation (float new_rotation)
void	SetAnchorPosition (BlamWidgetAnchor new_anchor_position)
void	MarkForUpdate ()
BlamVector2	GetAbsolutePosition ()
BlamWidgetAnchor	GetAnchorPosition ()
virtual void	SetHidden (bool new_hidden)
bool	IsHidden ()

Additional Inherited Members
Public Attributes inherited from BlamUIWidget
std::string	display_name = "unnamed"
std::string	description = ""
BlamVector2	position = { 0, 0 }
BlamVector2	size = { 100, 100 }
float	rotation = 0.0f
int	z_index = 0
float	z_size = 1.0f
bool	auto_update = false
Ogre::HlmsDatablock *	material = nullptr
BlamUIWidget_Group *	parent = nullptr
bool	ignore_layout = false
bool	hide_in_layout = false
Protected Member Functions inherited from BlamUIWidget
int	GetAdjustedZIndex ()
Protected Attributes inherited from BlamUIWidget
BlamVector2	position_absolute = { 0, 0 }
BlamVector2	size_absolute = { 100, 100 }
bool	update = false
bool	hidden = false

Detailed Description

UI widget for the user ID cypher display.

This will display a pair of two numbers that, when used together, can be used to identify a player from any footage or screenshot of a pre-release build of the engine. This can be used to ensure that in cases where we don't want certain content leaked, we can identify any potential leaker source.

Todo:

This cypher expects a "user ID" value - which currently does not get used. For the time being, the cypher will operate with a user ID of 0 - causing both numbers to be identical. As soon as we have some kind of system for user login/authentication, this should be updated to use that value instead.

Constructor & Destructor Documentation

BlamUIWidget_UserIDCypher()

BlamUIWidget_UserIDCypher::BlamUIWidget_UserIDCypher

(

BlamUIWidget_Group *

_parent

)

Constructs a new user ID cypher widget.

Parameters

parent

- The parent of this widget.

Here is the call graph for this function:

~BlamUIWidget_UserIDCypher()

BlamUIWidget_UserIDCypher::~BlamUIWidget_UserIDCypher

(

)

Destroys the user ID cypher widget.

Will unregister the listener and release any memory.

Member Function Documentation

Draw()

void BlamUIWidget_UserIDCypher::Draw ( )

overridevirtual

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

OnTickEvent()

void BlamUIWidget_UserIDCypher::OnTickEvent ( TickEvent *  event )

override

Here is the call graph for this function:

RefreshRelativePosition()

void BlamUIWidget_UserIDCypher::RefreshRelativePosition ( )

overridevirtual

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

ShowImGuiPropertyEditor()

void BlamUIWidget_UserIDCypher::ShowImGuiPropertyEditor ( )

overridevirtual

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

UpdateMetrics()

void BlamUIWidget_UserIDCypher::UpdateMetrics ( )

overridevirtual

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

---

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

• blam/components/ui/blam/widgets/advanced/uid_cypher.h
• blam/components/ui/blam/widgets/advanced/BlamUIWidget_UserIDCypher.cpp