Photon Quantum 3.0.0

Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Quantum.QuantumFrameDifferGUI Class Referenceabstract

The actual GUI to render the frame dumps differences of multiple dumps send by different clients. Uses Unity Immediate Mode GUI. More...

Classes

class  FrameDifferState
 The state saves multiple frame dumps. More...
 

Public Member Functions

abstract void DrawHeader ()
 Draws the header of the GUI. More...
 
void OnGUI ()
 Should be invoked from Unity OnGUI method to draw the GUI. More...
 
virtual void Repaint ()
 Toggles a windows repaint. More...
 
void Show ()
 Toggles the _hidden flag. More...
 

Public Attributes

int ReferenceActorId = 0
 The actor id to use as a reference state when comparing differences. More...
 
virtual float ScrollWidth => 16.0f
 Returns the scroll width. Default is 16. More...
 

Protected Member Functions

 QuantumFrameDifferGUI (FrameDifferState state)
 Create a new GUI frame differ instance using the given state. More...
 

Protected Attributes

Boolean _hidden
 True if the GUI is not rendered. More...
 

Properties

virtual GUIStyle BoldLabel [get]
 Returns the bold label style. Can be customized in derived classes. More...
 
virtual GUIStyle DiffBackground [get]
 Returns the background style. Can be customized in derived classes. More...
 
virtual GUIStyle DiffHeader [get]
 Returns the header style. Can be customized in derived classes. More...
 
virtual GUIStyle DiffHeaderError [get]
 Returns the error header style. Can be customized in derived classes. More...
 
virtual GUIStyle DiffLineOverlay [get]
 Returns the line overlay style. Can be customized in derived classes. More...
 
virtual Boolean IsEditor [get]
 Returns true or derived classes if the GUI is running inside the Unity Editor. More...
 
virtual GUIStyle MiniButton [get]
 Returns the button style. Can be customized in derived classes. More...
 
virtual GUIStyle MiniButtonLeft [get]
 Returns the left button style. More...
 
virtual GUIStyle MiniButtonRight [get]
 Returns the right button style. More...
 
abstract Rect Position [get]
 Returns the position of the screen/window. More...
 
FrameDifferState State [get, set]
 Get or set the state of the frame differ. More...
 
virtual GUIStyle TextLabel [get]
 Returns the text label style. Can be customized in derived classes. More...
 
virtual Int32 TextLineHeight [get]
 Returns the text line height. Default is 16. Can be customized in derived classes. More...
 

Detailed Description

The actual GUI to render the frame dumps differences of multiple dumps send by different clients. Uses Unity Immediate Mode GUI.

Constructor & Destructor Documentation

◆ QuantumFrameDifferGUI()

Quantum.QuantumFrameDifferGUI.QuantumFrameDifferGUI ( FrameDifferState  state)
inlineprotected

Create a new GUI frame differ instance using the given state.

Parameters
state

Member Function Documentation

◆ Repaint()

virtual void Quantum.QuantumFrameDifferGUI.Repaint ( )
inlinevirtual

Toggles a windows repaint.

◆ DrawHeader()

abstract void Quantum.QuantumFrameDifferGUI.DrawHeader ( )
pure virtual

Draws the header of the GUI.

◆ Show()

void Quantum.QuantumFrameDifferGUI.Show ( )
inline

Toggles the _hidden flag.

◆ OnGUI()

void Quantum.QuantumFrameDifferGUI.OnGUI ( )
inline

Should be invoked from Unity OnGUI method to draw the GUI.

Member Data Documentation

◆ ReferenceActorId

int Quantum.QuantumFrameDifferGUI.ReferenceActorId = 0

The actor id to use as a reference state when comparing differences.

◆ _hidden

Boolean Quantum.QuantumFrameDifferGUI._hidden
protected

True if the GUI is not rendered.

◆ ScrollWidth

virtual float Quantum.QuantumFrameDifferGUI.ScrollWidth => 16.0f

Returns the scroll width. Default is 16.

Property Documentation

◆ State

FrameDifferState Quantum.QuantumFrameDifferGUI.State
getset

Get or set the state of the frame differ.

◆ IsEditor

virtual Boolean Quantum.QuantumFrameDifferGUI.IsEditor
get

Returns true or derived classes if the GUI is running inside the Unity Editor.

◆ TextLineHeight

virtual Int32 Quantum.QuantumFrameDifferGUI.TextLineHeight
get

Returns the text line height. Default is 16. Can be customized in derived classes.

◆ DiffBackground

virtual GUIStyle Quantum.QuantumFrameDifferGUI.DiffBackground
get

Returns the background style. Can be customized in derived classes.

◆ DiffHeader

virtual GUIStyle Quantum.QuantumFrameDifferGUI.DiffHeader
get

Returns the header style. Can be customized in derived classes.

◆ DiffHeaderError

virtual GUIStyle Quantum.QuantumFrameDifferGUI.DiffHeaderError
get

Returns the error header style. Can be customized in derived classes.

◆ DiffLineOverlay

virtual GUIStyle Quantum.QuantumFrameDifferGUI.DiffLineOverlay
get

Returns the line overlay style. Can be customized in derived classes.

◆ MiniButton

virtual GUIStyle Quantum.QuantumFrameDifferGUI.MiniButton
get

Returns the button style. Can be customized in derived classes.

◆ TextLabel

virtual GUIStyle Quantum.QuantumFrameDifferGUI.TextLabel
get

Returns the text label style. Can be customized in derived classes.

◆ BoldLabel

virtual GUIStyle Quantum.QuantumFrameDifferGUI.BoldLabel
get

Returns the bold label style. Can be customized in derived classes.

◆ MiniButtonLeft

virtual GUIStyle Quantum.QuantumFrameDifferGUI.MiniButtonLeft
get

Returns the left button style.

◆ MiniButtonRight

virtual GUIStyle Quantum.QuantumFrameDifferGUI.MiniButtonRight
get

Returns the right button style.

◆ Position

abstract Rect Quantum.QuantumFrameDifferGUI.Position
get

Returns the position of the screen/window.