Loki GUI - Virtual Buttons [ code ]

Author

Message

Yeshu777

4

Years of Service

User Offline

Joined: 26th Feb 2020

Location: Cymru

Posted: 20th Aug 2023 22:48 Edited at: 21st Aug 2023 01:29

Link

Hi All,

Thought I'd share this.. as the inbuilt Virtual Button functionality has various drawbacks.

It's a snippet from my new GUI system, it's a WIP but thought this might help others.

#constant  OFF      0
#constant  ON       1

/*---------------------------------------------------*/

function create_gui_button( vb_index, xpos#, ypos#, image, text$, font, txt_size )

img_w = GetImageWidth( image )
	img_h = GetImageHeight( image )
	
	adj_x = ( img_w / 2 )
	adj_y = ( img_h / 2 )
	 
	AddVirtualButton ( vb_index, xpos# + adj_x, ypos# + adj_y, img_w )
	SetVirtualButtonSize ( vb_index, img_w, img_h )
	SetVirtualButtonAlpha ( vb_index, 0 )

CreateSprite( vb_index, image )
	SetSpritePosition ( vb_index, xpos#, ypos# )
	SetSpriteColorAlpha ( vb_index, 255 )
							
	CreateText( vb_index, text$ )
	SetTextFont( vb_index, good_font )
	SetTextPosition( vb_index,  xpos# + adj_x, ypos# + ( adj_y / 2 ) )
			
	SetTextSize( vb_index, txt_size )
	SetTextBold( vb_index, 0 )
	SetTextColor( vb_index, 255, 255, 255, 255 )
	SetTextAlignment( vb_index, 1 )
	SetTextDepth( vb_index, 1 )
	SetTextVisible( vb_index, ON )
				
endfunction

/*---------------------------------------------------*/

function set_gui_button_on_off( vb_index, on_off )
	
	if( GetVirtualButtonExists( vb_index ) )
	
		alpha = 128
		
		if( on_off > OFF ) then alpha = 255
			
		SetSpriteColorAlpha( vb_index, alpha )
		
	endif
		
endfunction

/*---------------------------------------------------*/

function service_gui_btn_state( vb_index )

if( GetVirtualButtonExists( vb_index ) )
	
		if( GetVirtualButtonReleased( vb_index ) )

set_gui_button_on_off( vb_index, ON )

endif

if( GetVirtualButtonPressed( vb_index ) )
		
			set_gui_button_on_off( vb_index, OFF )
	
		endif

endif
	
endfunction

+ Code Snippet


#constant  OFF      0
#constant  ON       1

/*---------------------------------------------------*/

function create_gui_button( vb_index, xpos#, ypos#, image, text$, font, txt_size )

	img_w = GetImageWidth( image )
	img_h = GetImageHeight( image )
	
	adj_x = ( img_w / 2 )
	adj_y = ( img_h / 2 )
	 
	AddVirtualButton ( vb_index, xpos# + adj_x, ypos# + adj_y, img_w )
	SetVirtualButtonSize ( vb_index, img_w, img_h )
	SetVirtualButtonAlpha ( vb_index, 0 )

	CreateSprite( vb_index, image )
	SetSpritePosition ( vb_index, xpos#, ypos# )
	SetSpriteColorAlpha ( vb_index, 255 )
							
	CreateText( vb_index, text$ )
	SetTextFont( vb_index, good_font )
	SetTextPosition( vb_index,  xpos# + adj_x, ypos# + ( adj_y / 2 ) )
			
	SetTextSize( vb_index, txt_size )
	SetTextBold( vb_index, 0 )
	SetTextColor( vb_index, 255, 255, 255, 255 )
	SetTextAlignment( vb_index, 1 )
	SetTextDepth( vb_index, 1 )
	SetTextVisible( vb_index, ON )
				
endfunction

/*---------------------------------------------------*/

function set_gui_button_on_off( vb_index, on_off )
	
	if( GetVirtualButtonExists( vb_index ) )
	
		alpha = 128
		
		if( on_off > OFF ) then alpha = 255
			
		SetSpriteColorAlpha( vb_index, alpha )
		
	endif
		
endfunction

/*---------------------------------------------------*/

function service_gui_btn_state( vb_index )

	if( GetVirtualButtonExists( vb_index ) )
	
		if( GetVirtualButtonReleased( vb_index ) )

			set_gui_button_on_off( vb_index, ON )

		endif

		if( GetVirtualButtonPressed( vb_index ) )
		
			set_gui_button_on_off( vb_index, OFF )
	
		endif

	endif
	
endfunction

So quite simply..

On intialise / start of program.. to create a button

+ Code Snippet


grn_rect_img = LoadImage( "grn_rect_btn.png" )             // 150 x 48 png Image

create_gui_button( VB_BUTTON_1, 195, 356, grn_rect_img, "BUTTON_1", good_font, 22 )

Then in main loop.. call this function to update the on and off press

+ Code Snippet


function service_virtual_buttons( )
	
	service_gui_btn_state( VB_BUTTON_1)

endfunction

The VirtualButton functionally can process the selection / mouse click in the usual manner..

All the best,

Yeshu777

Back to top

Profile PM

Yeshu777

4

Years of Service

User Offline

Joined: 26th Feb 2020

Location: Cymru

Posted: 21st Aug 2023 21:23 Edited at: 22nd Aug 2023 14:00

Link

Updated - sprite_id and text_id are now assigned dynamically...

/*---------------------------------------------------*/

#constant  OFF            0
#constant  ON             1

#constant  VB_TEST    1

#constant  MAX_NOF_VB_BUTS     100          // Maximum nof of AGK Virtual Buttons

/*---------------------------------------------------*/

Type GUI_VB_Button
	
	vb_index as Integer
	spr_id as Integer

img_w as Integer
	img_h as Integer

xpos# as Float
	ypos# as Float
	alpha as Integer
	
	txt_id as Integer
	text$ as String
		
	active as Integer
	
	mode as Integer
	phase as Integer
	
EndType

Dim  vb_gui_button[ MAX_NOF_VB_BUTS ] as GUI_VB_Button

Global    grn_rect_btn as Integer = 0

/*---------------------------------------------------*/

function init_gui_gfx( /* void */ )

grn_rect_btn = LoadImage( "grn_rect_btn.png" )

endfunction

/*---------------------------------------------------*/

function create_gui_button( vb_index, xpos#, ypos#, image, text$, font, txt_size, def_state )

vb_gui_button[ vb_index ].vb_index = vb_index
	vb_gui_button[ vb_index ].xpos# = xpos#
	vb_gui_button[ vb_index ].ypos# = ypos#
	vb_gui_button[ vb_index ].text$ = text$
	vb_gui_button[ vb_index ].active = def_state
	
	vb_gui_button[ vb_index ].img_w = GetImageWidth( image )
	vb_gui_button[ vb_index ].img_h = GetImageHeight( image )
			
	adj_x = ( vb_gui_button[ vb_index ].img_w / 2 )
	adj_y = ( vb_gui_button[ vb_index ].img_h / 2 )
		
	AddVirtualButton ( vb_index, vb_gui_button[ vb_index ].xpos# + adj_x, vb_gui_button[ vb_index ].ypos# + adj_y, vb_gui_button[ vb_index ].img_w )
	SetVirtualButtonSize ( vb_index, vb_gui_button[ vb_index ].img_w, vb_gui_button[ vb_index ].img_h )
	SetVirtualButtonAlpha ( vb_index, 0 )

vb_gui_button[ vb_index ].spr_id = CreateSprite( image )
	SetSpritePosition ( vb_gui_button[ vb_index ].spr_id, vb_gui_button[ vb_index ].xpos#, vb_gui_button[ vb_index ].ypos# )
	SetSpriteDepth ( vb_gui_button[ vb_index ].spr_id, 2 )
	SetSpriteColorAlpha ( vb_gui_button[ vb_index ].spr_id, 255 )
							
	vb_gui_button[ vb_index ].txt_id = CreateText( text$ )
	SetTextFont( vb_gui_button[ vb_index ].txt_id, good_font )
	SetTextPosition( vb_gui_button[ vb_index ].txt_id, ( vb_gui_button[ vb_index ].xpos# + adj_x ), vb_gui_button[ vb_index ].ypos# + ( adj_y / 2 ) )
			
	SetTextSize( vb_gui_button[ vb_index ].txt_id, txt_size )
	SetTextBold( vb_gui_button[ vb_index ].txt_id, 0 )
	SetTextColor( vb_gui_button[ vb_index ].txt_id, 255, 255, 255, 255 )
	SetTextAlignment( vb_gui_button[ vb_index ].txt_id, 1 )
	SetTextDepth( vb_gui_button[ vb_index ].txt_id, 1 )
	SetTextVisible( vb_gui_button[ vb_index ].txt_id, ON )
				
endfunction

/*---------------------------------------------------*/

function set_gui_button_on_off( vb_index, on_off )
	
	if( GetVirtualButtonExists( vb_index ) )
	
		vb_gui_button[ vb_index ].alpha = 128
		
		if( on_off > OFF ) then 	vb_gui_button[ vb_index ].alpha = 255
			
		SetSpriteColorAlpha( vb_gui_button[ vb_index ].spr_id, vb_gui_button[ vb_index ].alpha )
		
	endif
		
endfunction

/*---------------------------------------------------*/

function service_gui_btn_state( vb_index )

if( GetVirtualButtonExists( vb_index ) )
	
		if( vb_gui_button[ vb_index ].active )
		
			if( GetVirtualButtonReleased( vb_index ) )

set_gui_button_on_off( vb_index, ON )

endif

if( GetVirtualButtonPressed( vb_index ) )
		
				set_gui_button_on_off( vb_index, OFF )
	
			endif
			
		else
			
			set_gui_button_on_off( vb_index, OFF )
			
		endif

endif
	
endfunction

/*---------------------------------------------------*/

function set_gui_btn_state( vb_index, on_off )

if( GetVirtualButtonExists( vb_index ) )

vb_gui_button[ vb_index ].active = on_off
	
	endif
	
endfunction

/*---------------------------------------------------*/

function get_gui_btn_pressed( vb_index )

status = OFF
	
	if( GetVirtualButtonExists( vb_index ) )
								
		if( GetVirtualButtonPressed( vb_index ) )
	
			if( vb_gui_button[ vb_index ].active > OFF )
			
				status = ON
				
			endif
			
		endif
		
	endif
	
endfunction( status )

+ Code Snippet

/*---------------------------------------------------*/

#constant  OFF            0
#constant  ON             1


#constant  VB_TEST    1

#constant  MAX_NOF_VB_BUTS     100          // Maximum nof of AGK Virtual Buttons

/*---------------------------------------------------*/

Type GUI_VB_Button
	
	vb_index as Integer
	spr_id as Integer

	img_w as Integer
	img_h as Integer

	xpos# as Float
	ypos# as Float
	alpha as Integer
	
	txt_id as Integer
	text$ as String
		
	active as Integer
	
	mode as Integer
	phase as Integer
	
EndType

Dim  vb_gui_button[ MAX_NOF_VB_BUTS ] as GUI_VB_Button

Global    grn_rect_btn as Integer = 0

/*---------------------------------------------------*/

function init_gui_gfx( /* void */ )

        grn_rect_btn = LoadImage( "grn_rect_btn.png" )

endfunction

/*---------------------------------------------------*/

function create_gui_button( vb_index, xpos#, ypos#, image, text$, font, txt_size, def_state )

	vb_gui_button[ vb_index ].vb_index = vb_index
	vb_gui_button[ vb_index ].xpos# = xpos#
	vb_gui_button[ vb_index ].ypos# = ypos#
	vb_gui_button[ vb_index ].text$ = text$
	vb_gui_button[ vb_index ].active = def_state
	
	vb_gui_button[ vb_index ].img_w = GetImageWidth( image )
	vb_gui_button[ vb_index ].img_h = GetImageHeight( image )
			
	adj_x = ( vb_gui_button[ vb_index ].img_w / 2 )
	adj_y = ( vb_gui_button[ vb_index ].img_h / 2 )
		
	AddVirtualButton ( vb_index, vb_gui_button[ vb_index ].xpos# + adj_x, vb_gui_button[ vb_index ].ypos# + adj_y, vb_gui_button[ vb_index ].img_w )
	SetVirtualButtonSize ( vb_index, vb_gui_button[ vb_index ].img_w, vb_gui_button[ vb_index ].img_h )
	SetVirtualButtonAlpha ( vb_index, 0 )

	vb_gui_button[ vb_index ].spr_id = CreateSprite( image )
	SetSpritePosition ( vb_gui_button[ vb_index ].spr_id, vb_gui_button[ vb_index ].xpos#, vb_gui_button[ vb_index ].ypos# )
	SetSpriteDepth ( vb_gui_button[ vb_index ].spr_id, 2 )
	SetSpriteColorAlpha ( vb_gui_button[ vb_index ].spr_id, 255 )
							
	vb_gui_button[ vb_index ].txt_id = CreateText( text$ )
	SetTextFont( vb_gui_button[ vb_index ].txt_id, good_font )
	SetTextPosition( vb_gui_button[ vb_index ].txt_id, ( vb_gui_button[ vb_index ].xpos# + adj_x ), vb_gui_button[ vb_index ].ypos# + ( adj_y / 2 ) )
			
	SetTextSize( vb_gui_button[ vb_index ].txt_id, txt_size )
	SetTextBold( vb_gui_button[ vb_index ].txt_id, 0 )
	SetTextColor( vb_gui_button[ vb_index ].txt_id, 255, 255, 255, 255 )
	SetTextAlignment( vb_gui_button[ vb_index ].txt_id, 1 )
	SetTextDepth( vb_gui_button[ vb_index ].txt_id, 1 )
	SetTextVisible( vb_gui_button[ vb_index ].txt_id, ON )
				
endfunction

/*---------------------------------------------------*/

function set_gui_button_on_off( vb_index, on_off )
	
	if( GetVirtualButtonExists( vb_index ) )
	
		vb_gui_button[ vb_index ].alpha = 128
		
		if( on_off > OFF ) then 	vb_gui_button[ vb_index ].alpha = 255
			
		SetSpriteColorAlpha( vb_gui_button[ vb_index ].spr_id, vb_gui_button[ vb_index ].alpha )
		
	endif
		
endfunction

/*---------------------------------------------------*/

function service_gui_btn_state( vb_index )

	if( GetVirtualButtonExists( vb_index ) )
	
		if( vb_gui_button[ vb_index ].active )
		
			if( GetVirtualButtonReleased( vb_index ) )

				set_gui_button_on_off( vb_index, ON )

			endif

			if( GetVirtualButtonPressed( vb_index ) )
		
				set_gui_button_on_off( vb_index, OFF )
	
			endif
			
		else
			
			set_gui_button_on_off( vb_index, OFF )
			
		endif

	endif
	
endfunction

/*---------------------------------------------------*/

function set_gui_btn_state( vb_index, on_off )

	if( GetVirtualButtonExists( vb_index ) )

		vb_gui_button[ vb_index ].active = on_off
	
	endif
	
endfunction

/*---------------------------------------------------*/

function get_gui_btn_pressed( vb_index )

	status = OFF
	
	if( GetVirtualButtonExists( vb_index ) )
								
		if( GetVirtualButtonPressed( vb_index ) )
	
			if( vb_gui_button[ vb_index ].active > OFF )
			
				status = ON
				
			endif
			
		endif
		
	endif
	
endfunction( status )

Creation and event handling :

+ Code Snippet


/*---------------------------------------------------*/
/*-- Placed at program start
/*---------------------------------------------------*/

function init_virtual_buttons( )

    /*-- Load Resources --*/
    init_gui_gfx( )

	/*-- Create a Test Button --*/
	create_gui_button( VB_TEST, 195, 356, grn_rect_btn, "TEST", good_font, 22, OFF )

endfunction

/*---------------------------------------------------*/
/*-- Placed in main loop
/*---------------------------------------------------*/

function service_virtual_buttons( )
	
	/* Service Button Image ON or OFF when clicked */
	service_gui_btn_state( VB_TEST )

	/* Service Button Function */
	if( get_gui_btn_pressed( VB_TEST ) <> OFF )

                  // Do something useful here...
								
	endif

endfunction

And an example of how it looks ..

Attachments

Login to view attachments

Back to top

Profile PM

Aidan

User Banned

Posted: 22nd Aug 2023 09:25

Link

Hello.

I can't test any of this as yet but from what I've seen of your works already

https://forum.thegamecreators.com/thread/229182#msg2674770

I'm pretty sure that this is good and useful also.

Thanks for your codings for later

Back to top

Profile

Yeshu777

4

Years of Service

User Offline

Joined: 26th Feb 2020

Location: Cymru

Posted: 22nd Aug 2023 12:32

Link

Hi Aidan,

It's simply a starting point for others to expand upon - and it's always nice to contribute.

There should be space in the November / December Newsletter detailing what I've been up to using AGK.

Diolch!

Back to top

Profile PM

Sorry your browser is not supported!

AppGameKit Studio Chat / Loki GUI - Virtual Buttons [ code ]

Attachments