Module Dialogs
[hide private]
[frames] | no frames]

Module Dialogs

source code

A bunch of dialog functions for interacting with the user.

Classes [hide private]
  GetText
Text input layer.
  GetKey
Key choosing layer.
  LoadingScreen
Loading screen layer.
  MessageScreen
Message screen layer.
  SongChooser
Song choosing layer.
  FileChooser
File choosing layer.
  ItemChooser
Item menu layer.
  BpmEstimator
Beats per minute value estimation layer.
  KeyTester
Keyboard configuration testing layer.
Functions [hide private]
 
wrapText(font, pos, text, rightMargin=0.9, scale=0.002, visibility=0.0)
Wrap a piece of text inside given margins.
source code
 
fadeScreen(v)
Fade the screen to a dark color to make whatever is on top easier to read.
source code
 
_runDialog(engine, dialog)
Run a dialog in a sub event loop until it is finished.
source code
 
getText(engine, prompt, text='')
Get a string of text from the user.
source code
 
getKey(engine, prompt, key='')
Ask the user to choose a key.
source code
 
chooseSong(engine, prompt='Choose a Song', selectedSong='', selectedLibrary='')
Ask the user to select a song.
source code
 
chooseFile(engine, masks=['*.*'], path='.', prompt='Choose a File')
Ask the user to select a file.
source code
 
chooseItem(engine, items, prompt, selected='')
Ask the user to one item from a list.
source code
 
testKeys(engine, prompt='Play with the keys and press Escape when you\'re done.')
Have the user test the current keyboard configuration.
source code
 
showLoadingScreen(engine, condition, text='Loading...', allowCancel=True)
Show a loading screen until a condition is met.
source code
 
showMessage(engine, text)
Show a message to the user.
source code
 
estimateBpm(engine, song, prompt)
Ask the user to estimate the beats per minute value of a song.
source code
Variables [hide private]
  glColorPointerb = <OpenGL.wrapper.glColorPointer object at 0x4...
  glColorPointerd = <OpenGL.wrapper.glColorPointer object at 0x4...
  glColorPointerf = <OpenGL.wrapper.glColorPointer object at 0x4...
  glColorPointeri = <OpenGL.wrapper.glColorPointer object at 0x4...
  glColorPointers = <OpenGL.wrapper.glColorPointer object at 0x4...
  glColorPointerub = <OpenGL.wrapper.glColorPointer object at 0x...
  glColorPointerui = <OpenGL.wrapper.glColorPointer object at 0x...
  glColorPointerus = <OpenGL.wrapper.glColorPointer object at 0x...
  glDrawElementsub = <OpenGL.wrapper.glDrawElements object at 0x...
  glDrawElementsui = <OpenGL.wrapper.glDrawElements object at 0x...
  glDrawElementsus = <OpenGL.wrapper.glDrawElements object at 0x...
  glDrawPixelsb = <OpenGL.wrapper.glDrawPixels object at 0x41b13...
  glDrawPixelsf = <OpenGL.wrapper.glDrawPixels object at 0x41b17...
  glDrawPixelsi = <OpenGL.wrapper.glDrawPixels object at 0x41b17...
  glDrawPixelss = <OpenGL.wrapper.glDrawPixels object at 0x41b1c...
  glDrawPixelsub = <OpenGL.wrapper.glDrawPixels object at 0x41b1...
  glDrawPixelsui = <OpenGL.wrapper.glDrawPixels object at 0x41b1...
  glDrawPixelsus = <OpenGL.wrapper.glDrawPixels object at 0x41b2...
  glEdgeFlagPointerb = <OpenGL.wrapper.glEdgeFlagPointer object ...
  glIndexPointerb = <OpenGL.wrapper.glIndexPointer object at 0x4...
  glIndexPointerd = <OpenGL.wrapper.glIndexPointer object at 0x4...
  glIndexPointerf = <OpenGL.wrapper.glIndexPointer object at 0x4...
  glIndexPointeri = <OpenGL.wrapper.glIndexPointer object at 0x4...
  glIndexPointers = <OpenGL.wrapper.glIndexPointer object at 0x4...
  glIndexPointerub = <OpenGL.wrapper.glIndexPointer object at 0x...
  glNormalPointerb = <OpenGL.wrapper.glNormalPointer object at 0...
  glNormalPointerd = <OpenGL.wrapper.glNormalPointer object at 0...
  glNormalPointerf = <OpenGL.wrapper.glNormalPointer object at 0...
  glNormalPointeri = <OpenGL.wrapper.glNormalPointer object at 0...
  glNormalPointers = <OpenGL.wrapper.glNormalPointer object at 0...
  glTexCoordPointerb = <OpenGL.wrapper.glTexCoordPointer object ...
  glTexCoordPointerd = <OpenGL.wrapper.glTexCoordPointer object ...
  glTexCoordPointerf = <OpenGL.wrapper.glTexCoordPointer object ...
  glTexCoordPointeri = <OpenGL.wrapper.glTexCoordPointer object ...
  glTexCoordPointers = <OpenGL.wrapper.glTexCoordPointer object ...
  glTexImage1Db = <OpenGL.wrapper.glTexImage1D object at 0x41b13...
  glTexImage1Df = <OpenGL.wrapper.glTexImage1D object at 0x41b17...
  glTexImage1Di = <OpenGL.wrapper.glTexImage1D object at 0x41b17...
  glTexImage1Ds = <OpenGL.wrapper.glTexImage1D object at 0x41b17...
  glTexImage1Dub = <OpenGL.wrapper.glTexImage1D object at 0x41b1...
  glTexImage1Dui = <OpenGL.wrapper.glTexImage1D object at 0x41b1...
  glTexImage1Dus = <OpenGL.wrapper.glTexImage1D object at 0x41b1...
  glTexImage2Db = <OpenGL.wrapper.glTexImage2D object at 0x41b13...
  glTexImage2Df = <OpenGL.wrapper.glTexImage2D object at 0x41b17...
  glTexImage2Di = <OpenGL.wrapper.glTexImage2D object at 0x41b17...
  glTexImage2Ds = <OpenGL.wrapper.glTexImage2D object at 0x41b17...
  glTexImage2Dub = <OpenGL.wrapper.glTexImage2D object at 0x41b1...
  glTexImage2Dui = <OpenGL.wrapper.glTexImage2D object at 0x41b1...
  glTexImage2Dus = <OpenGL.wrapper.glTexImage2D object at 0x41b1...
  glTexImage3Db = <OpenGL.wrapper.glTexImage3D object at 0x41b2e...
  glTexImage3Df = <OpenGL.wrapper.glTexImage3D object at 0x41b31...
  glTexImage3Di = <OpenGL.wrapper.glTexImage3D object at 0x41b31...
  glTexImage3Ds = <OpenGL.wrapper.glTexImage3D object at 0x41b31...
  glTexImage3Dub = <OpenGL.wrapper.glTexImage3D object at 0x41b3...
  glTexImage3Dui = <OpenGL.wrapper.glTexImage3D object at 0x41b3...
  glTexImage3Dus = <OpenGL.wrapper.glTexImage3D object at 0x41b3...
  glTexSubImage1Db = <OpenGL.wrapper.glTexSubImage1D object at 0...
  glTexSubImage1Df = <OpenGL.wrapper.glTexSubImage1D object at 0...
  glTexSubImage1Di = <OpenGL.wrapper.glTexSubImage1D object at 0...
  glTexSubImage1Ds = <OpenGL.wrapper.glTexSubImage1D object at 0...
  glTexSubImage1Dub = <OpenGL.wrapper.glTexSubImage1D object at ...
  glTexSubImage1Dui = <OpenGL.wrapper.glTexSubImage1D object at ...
  glTexSubImage1Dus = <OpenGL.wrapper.glTexSubImage1D object at ...
  glTexSubImage2Db = <OpenGL.wrapper.glTexSubImage2D object at 0...
  glTexSubImage2Df = <OpenGL.wrapper.glTexSubImage2D object at 0...
  glTexSubImage2Di = <OpenGL.wrapper.glTexSubImage2D object at 0...
  glTexSubImage2Ds = <OpenGL.wrapper.glTexSubImage2D object at 0...
  glTexSubImage2Dub = <OpenGL.wrapper.glTexSubImage2D object at ...
  glTexSubImage2Dui = <OpenGL.wrapper.glTexSubImage2D object at ...
  glTexSubImage2Dus = <OpenGL.wrapper.glTexSubImage2D object at ...
  glTexSubImage3Db = <OpenGL.wrapper.glTexSubImage3D object at 0...
  glTexSubImage3Df = <OpenGL.wrapper.glTexSubImage3D object at 0...
  glTexSubImage3Di = <OpenGL.wrapper.glTexSubImage3D object at 0...
  glTexSubImage3Ds = <OpenGL.wrapper.glTexSubImage3D object at 0...
  glTexSubImage3Dub = <OpenGL.wrapper.glTexSubImage3D object at ...
  glTexSubImage3Dui = <OpenGL.wrapper.glTexSubImage3D object at ...
  glTexSubImage3Dus = <OpenGL.wrapper.glTexSubImage3D object at ...
  glVertexPointerb = <OpenGL.wrapper.glVertexPointer object at 0...
  glVertexPointerd = <OpenGL.wrapper.glVertexPointer object at 0...
  glVertexPointerf = <OpenGL.wrapper.glVertexPointer object at 0...
  glVertexPointeri = <OpenGL.wrapper.glVertexPointer object at 0...
  glVertexPointers = <OpenGL.wrapper.glVertexPointer object at 0...
  name = 'glUniform4iv'
Function Details [hide private]

wrapText(font, pos, text, rightMargin=0.9, scale=0.002, visibility=0.0)

source code 
Wrap a piece of text inside given margins.
Parameters:
  • pos - (x, y) tuple, x defines the left margin
  • text - Text to wrap
  • rightMargin - Right margin
  • scale - Text scale
  • visibility - Visibility factor [0..1], 0 is fully visible

fadeScreen(v)

source code 
Fade the screen to a dark color to make whatever is on top easier to read.
Parameters:
  • v - Visibility factor [0..1], 0 is fully visible

getText(engine, prompt, text='')

source code 
Get a string of text from the user.
Parameters:
  • engine - Game engine
  • prompt - Prompt shown to the user
  • text - Default text

getKey(engine, prompt, key='')

source code 
Ask the user to choose a key.
Parameters:
  • engine - Game engine
  • prompt - Prompt shown to the user
  • key - Default key

chooseSong(engine, prompt='Choose a Song', selectedSong='', selectedLibrary='')

source code 
Ask the user to select a song.
Parameters:
  • engine - Game engine
  • prompt - Prompt shown to the user
  • selectedSong - Name of song to select initially
  • selectedLibrary - Name of the library where to search for the songs or None for the default library

    @returns a (library, song) pair

chooseFile(engine, masks=['*.*'], path='.', prompt='Choose a File')

source code 
Ask the user to select a file.
Parameters:
  • engine - Game engine
  • masks - List of glob masks for files that are acceptable
  • path - Initial path
  • prompt - Prompt shown to the user

chooseItem(engine, items, prompt, selected='')

source code 
Ask the user to one item from a list.
Parameters:
  • engine - Game engine
  • items - List of items
  • prompt - Prompt shown to the user
  • selected - Item selected by default

testKeys(engine, prompt='Play with the keys and press Escape when you\'re done.')

source code 
Have the user test the current keyboard configuration.
Parameters:
  • engine - Game engine
  • prompt - Prompt shown to the user

showLoadingScreen(engine, condition, text='Loading...', allowCancel=True)

source code 
Show a loading screen until a condition is met.
Parameters:
  • engine - Game engine
  • condition - A function that will be polled until it returns a true value
  • text - Text shown to the user
  • allowCancel (bool) - Can the loading be canceled
Returns:
True if the condition was met, Fales if the loading was canceled.

showMessage(engine, text)

source code 
Show a message to the user.
Parameters:
  • engine - Game engine
  • text - Message text

estimateBpm(engine, song, prompt)

source code 
Ask the user to estimate the beats per minute value of a song.
Parameters:
  • engine - Game engine
  • song - Song instance
  • prompt - Prompt shown to the user

Variables Details [hide private]

glColorPointerb

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc52c>

glColorPointerd

Value:
<OpenGL.wrapper.glColorPointer object at 0x41af8eec>

glColorPointerf

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc02c>

glColorPointeri

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc16c>

glColorPointers

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc2ac>

glColorPointerub

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc3ec>

glColorPointerui

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc66c>

glColorPointerus

Value:
<OpenGL.wrapper.glColorPointer object at 0x41afc7ac>

glDrawElementsub

Value:
<OpenGL.wrapper.glDrawElements object at 0x41b04d0c>

glDrawElementsui

Value:
<OpenGL.wrapper.glDrawElements object at 0x41b04e4c>

glDrawElementsus

Value:
<OpenGL.wrapper.glDrawElements object at 0x41b04f8c>

glDrawPixelsb

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b13f8c>

glDrawPixelsf

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b1754c>

glDrawPixelsi

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b17aec>

glDrawPixelss

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b1c0ac>

glDrawPixelsub

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b1c64c>

glDrawPixelsui

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b1cbec>

glDrawPixelsus

Value:
<OpenGL.wrapper.glDrawPixels object at 0x41b211ac>

glEdgeFlagPointerb

Value:
<OpenGL.wrapper.glEdgeFlagPointer object at 0x41afc8ec>

glIndexPointerb

Value:
<OpenGL.wrapper.glIndexPointer object at 0x41b0008c>

glIndexPointerd

Value:
<OpenGL.wrapper.glIndexPointer object at 0x41afca2c>

glIndexPointerf

Value:
<OpenGL.wrapper.glIndexPointer object at 0x41afcb6c>

glIndexPointeri

Value:
<OpenGL.wrapper.glIndexPointer object at 0x41afccac>

glIndexPointers

Value:
<OpenGL.wrapper.glIndexPointer object at 0x41afcf2c>

glIndexPointerub

Value:
<OpenGL.wrapper.glIndexPointer object at 0x41afcdec>

glNormalPointerb

Value:
<OpenGL.wrapper.glNormalPointer object at 0x41b0058c>

glNormalPointerd

Value:
<OpenGL.wrapper.glNormalPointer object at 0x41b001cc>

glNormalPointerf

Value:
<OpenGL.wrapper.glNormalPointer object at 0x41b0030c>

glNormalPointeri

Value:
<OpenGL.wrapper.glNormalPointer object at 0x41b0044c>

glNormalPointers

Value:
<OpenGL.wrapper.glNormalPointer object at 0x41b006cc>

glTexCoordPointerb

Value:
<OpenGL.wrapper.glTexCoordPointer object at 0x41b00bcc>

glTexCoordPointerd

Value:
<OpenGL.wrapper.glTexCoordPointer object at 0x41b0080c>

glTexCoordPointerf

Value:
<OpenGL.wrapper.glTexCoordPointer object at 0x41b0094c>

glTexCoordPointeri

Value:
<OpenGL.wrapper.glTexCoordPointer object at 0x41b00a8c>

glTexCoordPointers

Value:
<OpenGL.wrapper.glTexCoordPointer object at 0x41b00d0c>

glTexImage1Db

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b13acc>

glTexImage1Df

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b170cc>

glTexImage1Di

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b1766c>

glTexImage1Ds

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b17c0c>

glTexImage1Dub

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b1c1cc>

glTexImage1Dui

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b1c76c>

glTexImage1Dus

Value:
<OpenGL.wrapper.glTexImage1D object at 0x41b1cd0c>

glTexImage2Db

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b13c2c>

glTexImage2Df

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b171ec>

glTexImage2Di

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b1778c>

glTexImage2Ds

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b17d2c>

glTexImage2Dub

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b1c2ec>

glTexImage2Dui

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b1c88c>

glTexImage2Dus

Value:
<OpenGL.wrapper.glTexImage2D object at 0x41b1ce2c>

glTexImage3Db

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b2ef4c>

glTexImage3Df

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b3120c>

glTexImage3Di

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b3144c>

glTexImage3Ds

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b3168c>

glTexImage3Dub

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b318cc>

glTexImage3Dui

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b31b0c>

glTexImage3Dus

Value:
<OpenGL.wrapper.glTexImage3D object at 0x41b31d4c>

glTexSubImage1Db

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b13d4c>

glTexSubImage1Df

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b1730c>

glTexSubImage1Di

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b178ac>

glTexSubImage1Ds

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b17e4c>

glTexSubImage1Dub

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b1c40c>

glTexSubImage1Dui

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b1c9ac>

glTexSubImage1Dus

Value:
<OpenGL.wrapper.glTexSubImage1D object at 0x41b1cf4c>

glTexSubImage2Db

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b13e6c>

glTexSubImage2Df

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b1742c>

glTexSubImage2Di

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b179cc>

glTexSubImage2Ds

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b17f6c>

glTexSubImage2Dub

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b1c52c>

glTexSubImage2Dui

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b1cacc>

glTexSubImage2Dus

Value:
<OpenGL.wrapper.glTexSubImage2D object at 0x41b2108c>

glTexSubImage3Db

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b310ec>

glTexSubImage3Df

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b3132c>

glTexSubImage3Di

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b3156c>

glTexSubImage3Ds

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b317ac>

glTexSubImage3Dub

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b319ec>

glTexSubImage3Dui

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b31c2c>

glTexSubImage3Dus

Value:
<OpenGL.wrapper.glTexSubImage3D object at 0x41b31e6c>

glVertexPointerb

Value:
<OpenGL.wrapper.glVertexPointer object at 0x41b0422c>

glVertexPointerd

Value:
<OpenGL.wrapper.glVertexPointer object at 0x41b00e4c>

glVertexPointerf

Value:
<OpenGL.wrapper.glVertexPointer object at 0x41b00f8c>

glVertexPointeri

Value:
<OpenGL.wrapper.glVertexPointer object at 0x41b040ec>

glVertexPointers

Value:
<OpenGL.wrapper.glVertexPointer object at 0x41b0436c>