Vega strike Python Modules doc: GUIRect Class Reference

•All Data Structures Namespaces Files Functions Variables

Inheritance diagram for GUIRect:

Public Member Functions
def	__init__

def	__repr__

def	__str__

def	getNormalXYWH

def	getNormalCenter

def	getNormalTL

def	getNormalBR

def	getNormalWH

def	getHotRect

def	getSpriteRect

def	getTextRect

Data Fields
	x

	y

	w

	h

	ref

	mode

Detailed Description

A rectangle on the screen

ref: may be (room), (screenx,screeny) or (screenx,screeny,marginx,marginy)

(first takes the dimensions from the room, the next from the tuple itself

just the dimensions but margins and stuff from the root, and the last

takes everything from the tuple)

Definition at line 452 of file GUI.py.

Constructor & Destructor Documentation

def __init__	(	self,
		x,
		y,
		wid,
		hei,
		mode = `"pixel"`,
		ref = `None`
	)

Definition at line 458 of file GUI.py.

 
     def __init__(self,x,y,wid,hei,mode="pixel",ref=None):
         self.x = x
         self.y = y
         self.w = wid
         self.h = hei
         self.ref = ref
         self.mode = mode

Member Function Documentation

def __repr__ ( self)

Definition at line 466 of file GUI.py.

References GUIRect.h, GzipFile.mode, ZipFile.mode, GUIRect.mode, GUIRect.ref, GUIRect.w, GUIRect.x, and GUIRect.y.

466

467 def __repr__(self):

return repr((self.x,self.y,self.w,self.h,self.mode,self.ref))

def __str__ ( self)

Definition at line 468 of file GUI.py.

References GUIRect.h, GzipFile.mode, ZipFile.mode, GUIRect.mode, GUIRect.ref, locale.str(), GUIRect.w, GUIRect.x, and GUIRect.y.

 
     def __str__(self):
         return str((self.x,self.y,self.w,self.h,self.mode,self.ref))

def getHotRect ( self)

(BOTTOM, LEFT, WIDTH, HEIGHT) as needed by Base hotspots

Definition at line 540 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getHotRect(self):
         """ (BOTTOM, LEFT, WIDTH, HEIGHT) as needed by Base hotspots """
         aux = self.getNormalXYWH()
         return ( aux[0], aux[1]-aux[3], aux[2], aux[3] )

def getNormalBR ( self)

returns BOTTOM-RIGHT coordinate pair

Definition at line 524 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getNormalBR(self):
         """ returns BOTTOM-RIGHT coordinate pair """
         aux = self.getNormalXYWH()
         return ( aux[0]+aux[2], aux[1]-aux[3] )

def getNormalCenter ( self)

Definition at line 515 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getNormalCenter(self):
         aux = self.getNormalXYWH()
         return ( aux[0]+aux[2]/2, aux[1]-aux[3]/2 )

def getNormalTL ( self)

returns TOP-LEFT coordinate pair

Definition at line 519 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getNormalTL(self):
         """ returns TOP-LEFT coordinate pair """
         aux = self.getNormalXYWH()
         return ( aux[0], aux[1] )

def getNormalWH ( self)

returns WIDTH-HEIGHT dimensions

Definition at line 529 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getNormalWH(self):
         """ returns WIDTH-HEIGHT dimensions """
         aux = self.getNormalXYWH()
         return ( aux[2], aux[3] )

def getNormalXYWH ( self)

returns (x,y,w,h) - x/y is top-left - in Base coordinates

Allow two kinds of screen dimension overrides, for design convenience

a) (screenx,screeny) - margins set as per root settings

b) (screenx,screeny,marginx,marginy) - set both dimensions and margin manually

Definition at line 471 of file GUI.py.

References GUIRect.h, GzipFile.mode, ZipFile.mode, GUIRect.mode, GUIRect.ref, inspect.trace(), GUIRect.w, GUIRect.x, and GUIRect.y.

 
     def getNormalXYWH(self):
         """ returns (x,y,w,h) - x/y is top-left - in Base coordinates """
 
         """ Allow two kinds of screen dimension overrides, for design convenience """
         """ a) (screenx,screeny) - margins set as per root settings """
         """ b) (screenx,screeny,marginx,marginy) - set both dimensions and margin manually """
         if not self.ref or (type(self.ref)!=tuple) or ((len(self.ref)!=1)and(len(self.ref)!=2)and(len(self.ref)!=4)):
             (screenX,screenY) = GUIRootSingleton.getScreenDimensions()
             (marginX,marginY) = GUIRootSingleton.getScreenMargins()
         else:
             if len(self.ref)==4:
                 (screenX,screenY,marginX,marginY) = self.ref
             elif len(self.ref)==2:
                 (screenX,screenY) = self.ref
                 (marginX,marginY) = GUIRootSingleton.getScreenMargins()
             else:
                 (screenX,screenY) = self.ref[0].getScreenDimensions()
                 (marginX,marginY) = self.ref[0].getScreenMargins()
         if (self.mode=="pixel"):
             """ pixel coordinates relative to current screen settings 
                 to translate (0,0) (screenX,screenY) to (-1,1) (1,-1)
                 x = 2*xi/screenX - 1
                 y = 1 - 2*yi/screenY
             """
             return ( (2.0 * self.x / screenX - 1.0)*(1.0-marginX) ,  \
                            (-2.0 * self.y / screenY + 1.0)*(1.0-marginY) , \
                            (2.0 * self.w / screenX * (1.0-marginX)) ,      \
                            (2.0 * self.h / screenY * (1.0-marginY))        \
                           )
         elif (self.mode=='normalized_biased_scaled'):
             """ direct coordinates: top-left = (-1,+1), bottom-right = (+1,-1) - margins WILL NOT be applied """
             return (self.x,self.y,self.w,self.h)
         elif (self.mode=='normalized_biased'):
             """ direct coordinates: top-left = (-1,+1), bottom-right = (+1,-1) - margins WILL be applied """
             return (self.x*(1.0-marginX),self.y*(1.0-marginY),self.w*(1.0-marginX),self.h*(1.0-marginY))
         elif (self.mode=='normalized_scaled'):
             """ normalized coordinates: top-left = (0,0), bottom-right = (1,1) - margins WILL NOT be applied """
             return ((2.0*self.x-1.0),(-2.0*self.y+1.0),2.0*self.w,2.0*self.h)
         elif (self.mode=='normalized'):
             """ normalized coordinates: top-left = (0,0), bottom-right = (1,1) - margins WILL be applied """
             return ((2.0*self.x-1.0)*(1.0-marginX),(-2.0*self.y+1.0)*(1.0-marginY),2.0*self.w*(1.0-marginX),2.0*self.h*(1.0-marginY))
         else:
             trace(_GUITraceLevel, "WARNING! - gui.py - GUIRect::getNormalizedCoords(): unknown coordinate mode\n")

def getSpriteRect ( self)

(CenterX, CenterY, WIDTH, -HEIGHT) as needed by Base sprites

Definition at line 545 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getSpriteRect(self):
         """ (CenterX, CenterY, WIDTH, -HEIGHT) as needed by Base sprites """
         aux = self.getNormalXYWH()
         return ( aux[0]+aux[2]/2, aux[1]-aux[3]/2, aux[2], -aux[3] )

def getTextRect ( self)

(TOP, LEFT, WIDTH, HEIGHT) as needed by Base textboxes

Definition at line 550 of file GUI.py.

References GUIRect.getNormalXYWH().

 
     def getTextRect(self):
         """ (TOP, LEFT, WIDTH, HEIGHT) as needed by Base textboxes """
         return self.getNormalXYWH()
 
 
 """----------------------------------------------------------------"""
 """                                                                """
 """ GUINPOTRect - defines rectangles on the screen.                """
 """     Adjusts a rectangle so that a Power-Of-Two texture         """
 """     with Non-Power-Of-Two contents (top/left aligned)          """
 """     displays its contents in the specified area.               """
 """                                                                """
 """----------------------------------------------------------------"""

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation