ScrollBarEssentials Class Reference

The class that handles the data, base functions and drawing of a Game Bar More...

Inheritance diagram for ScrollBarEssentials:

Public Member Functions
	ScrollBarEssentials ()
	A default initializer for a ScrollBarEssentaisl Game Bar System More...
	ScrollBarEssentials (Rect sb_dimen, bool vbar, Texture sb_bt, Texture st, float rot)
	Creates a ScrollBarEssentials Game Bar System More...
	ScrollBarEssentials (Rect sb_dimen, Rect sbv_dimen, bool vbar, Texture sb_bt, Texture st, float rot)
	Creates a ScrollBarEssentials HealthSystem Game Bar More...
virtual void	DrawBar ()
	Draws the ScrollBarEssentials Game Bar More...
virtual void	DoInMouseRect ()
	What to do when hovering over a Game Bar More...
virtual void	DoOutMouseRect ()
	What to do when not hovering over a Game Bar System More...
virtual void	IncrimentBar (float value)
	Incriments or De-incriments the current_value More...
float	getCurrentValue ()
	The current_value of the Game Bar More...
float	getMaxValue (float value)
	The max_value of the Game Bar More...
Rect	getScrollBarRect ()
	The main Scroll Bar Dimensions More...
Rect	getScrollBarTextureDimens ()
	The Scroll Bar Texture Dimensions More...

Protected Member Functions
virtual float	DetermineMaxVal (float value)
	Overridable function for determining a max value More...
void	ProcessValue (float value)
	Function for changing the current_value by a value More...
void	SetCurrentValue (float value)
	Sets the current_value to a value More...

Protected Attributes
GUIStyle	style = new GUIStyle()
Vector2	string_size
Vector2	pivotVector = Vector2.zero
bool	MouseInRect = false
float	current_value = 0
float	max_value = 100
Rect	ScrollBarDimens = new Rect()
Rect	ScrollBarTextureDimens
bool	VerticleBar = false
float	texture_rotation = 0
Texture	ScrollBarBubbleTexture
Texture	ScrollTexture

Detailed Description

The class that handles the data, base functions and drawing of a Game Bar

Constructor & Destructor Documentation

ScrollBarEssentials.ScrollBarEssentials

(

)

A default initializer for a ScrollBarEssentaisl Game Bar System

ScrollBarEssentials.ScrollBarEssentials	(	Rect	sb_dimen,
		bool	vbar,
		Texture	sb_bt,
		Texture	st,
		float	rot
	)

Creates a ScrollBarEssentials Game Bar System

Parameters

sb_dimen	Dimensions of the Scroll Bar: x,y,w,h
vbar	Is this a Verticle Bar?
sb_bt	The Scroll Bar Bubble Texture
st	The Scroll Texture
rot	The Rotation

ScrollBarEssentials.ScrollBarEssentials	(	Rect	sb_dimen,
		Rect	sbv_dimen,
		bool	vbar,
		Texture	sb_bt,
		Texture	st,
		float	rot
	)

Creates a ScrollBarEssentials HealthSystem Game Bar

Parameters

sb_dimen	Dimensions of the Scroll Bar: x,y,w,h
sbv_dimen	Dimensions of the Scroll Texture: x,y,w,h
vbar	Is this a Verticle Bar?
sb_bt	The Scroll Bar Bubble Texture
st	The Scroll Texture
rot	The Rotation

Member Function Documentation

virtual float ScrollBarEssentials.DetermineMaxVal ( float  value )

protectedvirtual

Overridable function for determining a max value

virtual void ScrollBarEssentials.DoInMouseRect ( )

virtual

What to do when hovering over a Game Bar

Reimplemented in TimerBarSystem.

virtual void ScrollBarEssentials.DoOutMouseRect ( )

virtual

What to do when not hovering over a Game Bar System

Reimplemented in TimerBarSystem.

virtual void ScrollBarEssentials.DrawBar ( )

virtual

Draws the ScrollBarEssentials Game Bar

float ScrollBarEssentials.getCurrentValue

(

)

The current_value of the Game Bar

float ScrollBarEssentials.getMaxValue

(

float

value

)

The max_value of the Game Bar

Rect ScrollBarEssentials.getScrollBarRect

(

)

The main Scroll Bar Dimensions

Rect ScrollBarEssentials.getScrollBarTextureDimens

(

)

The Scroll Bar Texture Dimensions

virtual void ScrollBarEssentials.IncrimentBar ( float  value )

virtual

Incriments or De-incriments the current_value

Parameters

value

The value to change the current_value by

Reimplemented in TimerBarSystem, and HealthSystem.

void ScrollBarEssentials.ProcessValue ( float  value )

protected

Function for changing the current_value by a value

void ScrollBarEssentials.SetCurrentValue ( float  value )

protected

Sets the current_value to a value

Member Data Documentation

float ScrollBarEssentials.current_value = 0

protected

float ScrollBarEssentials.max_value = 100

protected

bool ScrollBarEssentials.MouseInRect = false

protected

Vector2 ScrollBarEssentials.pivotVector = Vector2.zero

protected

Texture ScrollBarEssentials.ScrollBarBubbleTexture

protected

Rect ScrollBarEssentials.ScrollBarDimens = new Rect()

protected

Rect ScrollBarEssentials.ScrollBarTextureDimens

protected

Texture ScrollBarEssentials.ScrollTexture

protected

Vector2 ScrollBarEssentials.string_size

protected

GUIStyle ScrollBarEssentials.style = new GUIStyle()

protected

float ScrollBarEssentials.texture_rotation = 0

protected

bool ScrollBarEssentials.VerticleBar = false

protected

---

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

• ScrollBarEssentials.cs