Vega strike Python Modules doc  0.5.1
Documentation of the " Modules " folder of Vega strike
 All Data Structures Namespaces Files Functions Variables
GUIRoot Class Reference

Public Member Functions

def __init__
 
def setScreenDimensions
 
def getScreenDimensions
 
def setScreenMargins
 
def getScreenAspectRatio
 
def setScreenAspectRatio
 
def getScreenMargins
 
def dispatchMessage
 
def broadcastMessage
 
def broadcastRoomMessage
 
def registerObject
 
def keyEvent
 
def registerRoom
 
def deregisterObject
 
def deregisterAllObjects
 
def deregisterAllRooms
 
def redrawIfNeeded
 
def getRoomById
 

Data Fields

 aspect
 
 needRedraw
 
 modalElement
 
 keyTarget
 
 screenX
 
 screenY
 
 marginX
 
 marginY
 
 nextId
 
 objects
 
 rooms
 

Detailed Description

global GUI setup

Definition at line 334 of file GUI.py.

Constructor & Destructor Documentation

def __init__ (   self,
  screenX = None,
  screenY = None,
  marginX = None,
  marginY = None,
  aspect = None 
)

Definition at line 336 of file GUI.py.

References GUIRoot.deregisterAllObjects(), GUIRoot.deregisterAllRooms(), and GUIRoot.setScreenDimensions().

337  def __init__(self,screenX=None,screenY=None,marginX=None,marginY=None,aspect=None):
338  self.deregisterAllObjects()
339  self.deregisterAllRooms()
340  if not screenX or not screenY:
341  # Get screen dimensions from config
342  screenX = int(VS.vsConfig("graphics","base_max_width",
343  VS.vsConfig("graphics","x_resolution","0")))
344  screenY = int(VS.vsConfig("graphics","base_max_height",
345  VS.vsConfig("graphics","y_resolution","0")))
346  aspect = float(VS.vsConfig("graphics","aspect","0"))
347  self.setScreenDimensions(screenX,screenY)
348  self.aspect = aspect or (screenX * 1.0 / screenY)
349  if (marginX == None):
350  marginX = 0.00
351  if (marginY == None):
352  marginY = 0.00
353  self.setScreenMargins(marginX,marginY)
354  self.needRedraw = {}
355  self.modalElement = None
356  self.keyTarget = None
357  Base.GlobalKeyPython('#\nfrom GUI import GUIRootSingleton\nGUIRootSingleton.keyEvent()\n')

Member Function Documentation

def broadcastMessage (   self,
  message,
  params 
)

Definition at line 387 of file GUI.py.

References GUIRoot.objects, and inspect.trace().

388  def broadcastMessage(self,message,params):
389  trace(_GUITraceLevel, "::: calling GUI.GUIRoot.broadcastMessage(%s,%s)" %(message,params) )
390  for i in self.objects.keys():
391  self.objects[i][1].onMessage(message,params)
def broadcastRoomMessage (   self,
  roomindex,
  message,
  params 
)

Definition at line 392 of file GUI.py.

References GUIRoot.objects, and inspect.trace().

393  def broadcastRoomMessage(self,roomindex,message,params):
394  trace(_GUITraceLevel, "::: calling GUI.GUIRoot.broadcastRoomMessage(%s,%s,%s)" %(roomindex,message,params) )
395  for i in self.objects.keys():
396  if self.objects[i][0]==roomindex:
397  self.objects[i][1].onMessage(message,params)
def deregisterAllObjects (   self)

Definition at line 422 of file GUI.py.

424  self.objects = {}
425  self.nextId = 0
def deregisterAllRooms (   self)

Definition at line 426 of file GUI.py.

428  self.rooms = {}
def deregisterObject (   self,
  id 
)

Definition at line 419 of file GUI.py.

420  def deregisterObject(self,id):
421  self.objects.erase(id)
def dispatchMessage (   self,
  id,
  message,
  params 
)

Definition at line 380 of file GUI.py.

References GUIRoot.objects, locale.str(), and inspect.trace().

381  def dispatchMessage(self,id,message,params):
382  trace(_GUITraceLevel, "::: calling GUI.GUIRoot.dispatchMessage(%s, %s, %s) :::" %(id,message,params))
383  if id in self.objects:
384  self.objects[id][1].onMessage(message,params)
385  else:
386  trace(_GUITraceLevel + 1, 'WARNING! - gui.py - GUIRoot::dispatchMessage(): Object id "' + str(id) + '" not found\n')
def getRoomById (   self,
  id 
)

Definition at line 434 of file GUI.py.

435  def getRoomById(self,id):
436  return self.rooms.get(id,None)
437 
def getScreenAspectRatio (   self)

Definition at line 371 of file GUI.py.

References GUIRoot.aspect.

372  def getScreenAspectRatio(self):
373  return self.aspect
def getScreenDimensions (   self)

Definition at line 363 of file GUI.py.

References GUIRoot.screenX, and GUIRoot.screenY.

364  def getScreenDimensions(self):
365  return (self.screenX,self.screenY)
def getScreenMargins (   self)

Definition at line 377 of file GUI.py.

References GUIRoot.marginX, and GUIRoot.marginY.

378  def getScreenMargins(self):
379  return (self.marginX,self.marginY)
def keyEvent (   self)

Definition at line 404 of file GUI.py.

References GUIRoot.keyTarget.

405  def keyEvent(self):
406  eventdata = Base.GetEventData();
407  if self.keyTarget is not None:
408  eventTarget = self.keyTarget
409  else:
410  eventTarget = self.rooms.get(Base.GetCurRoom())
411  if eventTarget is not None:
412  if eventdata['type'] == 'keyup' and hasattr(eventTarget,'keyUp'):
413  eventTarget.keyUp(eventdata['key'])
414  if eventdata['type'] == 'keydown' and hasattr(eventTarget,'keyDown'):
415  eventTarget.keyDown(eventdata['key'])
def redrawIfNeeded (   self)

Definition at line 429 of file GUI.py.

References GUIRoot.rooms, and inspect.trace().

430  def redrawIfNeeded(self):
431  trace(_GUITraceLevel, "::: calling GUI.GUIRoot.redrawIfNeeded()" )
432  for i in self.rooms:
433  self.rooms[i].redrawIfNeeded()
def registerObject (   self,
  room,
  object 
)

Definition at line 398 of file GUI.py.

References GUIRoot.nextId, and GUIRoot.objects.

399  def registerObject(self,room,object):
400  id = self.nextId
401  self.objects[id] = (room,object)
402  self.nextId = self.nextId + 1
403  return id
def registerRoom (   self,
  room 
)

Definition at line 416 of file GUI.py.

References GUIRoot.rooms.

417  def registerRoom(self,room):
418  self.rooms[room.getIndex()] = room
def setScreenAspectRatio (   self,
  aspect 
)

Definition at line 374 of file GUI.py.

References GUIRoot.aspect.

375  def setScreenAspectRatio(self, aspect):
376  self.aspect = aspect
def setScreenDimensions (   self,
  screenX,
  screenY 
)

Definition at line 358 of file GUI.py.

359  def setScreenDimensions(self,screenX,screenY):
360  self.screenX=screenX
361  self.screenY=screenY
362  self.broadcastMessage('changedScreenDimensions', {'screenX':screenX,'screenY':screenY} )
def setScreenMargins (   self,
  marginX,
  marginY 
)

Definition at line 366 of file GUI.py.

367  def setScreenMargins(self,marginX,marginY):
368  self.marginX=marginX
369  self.marginY=marginY
370  self.broadcastMessage('changedScreenMargins', {'marginX':marginX,'marginY':marginY} )

Field Documentation

aspect

Definition at line 347 of file GUI.py.

keyTarget

Definition at line 355 of file GUI.py.

marginX

Definition at line 367 of file GUI.py.

marginY

Definition at line 368 of file GUI.py.

modalElement

Definition at line 354 of file GUI.py.

needRedraw

Definition at line 353 of file GUI.py.

nextId

Definition at line 401 of file GUI.py.

objects

Definition at line 423 of file GUI.py.

rooms

Definition at line 427 of file GUI.py.

screenX

Definition at line 359 of file GUI.py.

screenY

Definition at line 360 of file GUI.py.


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