Module Rasterizer
[frames | no frames]

Module Rasterizer

Documentation for the Rasterizer module.

Example Uses an SCA_MouseSensor, and two KX_ObjectActuators to implement MouseLook:
       # To use a mouse movement sensor "Mouse" and a 
       # motion actuator to mouse look:
       import Rasterizer
       import GameLogic

       # SCALE sets the speed of motion
       SCALE=[1, 0.5]
       
       co = GameLogic.getCurrentController()
       obj = co.getOwner()
       mouse = co.getSensor("Mouse")
       lmotion = co.getActuator("LMove")
       wmotion = co.getActuator("WMove")
       
       # Transform the mouse coordinates to see how far the mouse has moved.
       def mousePos():
               x = (Rasterizer.getWindowWidth()/2 - mouse.getXPosition())*SCALE[0]
               y = (Rasterizer.getWindowHeight()/2 - mouse.getYPosition())*SCALE[1]
               return (x, y)
       
       pos = mousePos()
       
       # Set the amount of motion: X is applied in world coordinates...
       lmotion.setTorque(0.0, 0.0, pos[0], False)
       # ...Y is applied in local coordinates
       wmotion.setTorque(-pos[1], 0.0, 0.0, True)
       
       # Activate both actuators
       GameLogic.addActiveActuator(lmotion, True)
       GameLogic.addActiveActuator(wmotion, True)
       
       # Centre the mouse
       Rasterizer.setMousePosition(Rasterizer.getWindowWidth()/2, Rasterizer.getWindowHeight()/2)

Function Summary
  enableVisibility(visible)
Doesn't really do anything...
float getEyeSeparation()
Gets the current eye separation for stereo mode.
float getFocalLength()
Gets the current focal length for stereo mode.
integer getWindowHeight()
Gets the height of the window (in pixels)
integer getWindowWidth()
Gets the width of the window (in pixels)
  makeScreenshot(filename)
Writes a screenshot to the given filename.
  setBackgroundColor(rgba)
Sets the window background colour.
  setEyeSeparation(eyesep)
Sets the eye separation for stereo mode.
  setFocalLength(focallength)
Sets the focal length for stereo mode.
  setMistColor(rgb)
Sets the mist colour.
  setMistEnd(end)
Sets the mist end value.
  setMistStart(start)
Sets the mist start value.
  setMousePosition(x, y)
Sets the mouse cursor position.
  showMouse(visible)
Enables or disables the operating system mouse cursor.

Function Details

enableVisibility(visible)

Doesn't really do anything...

getEyeSeparation()

Gets the current eye separation for stereo mode.
Returns:
float

getFocalLength()

Gets the current focal length for stereo mode.
Returns:
float

getWindowHeight()

Gets the height of the window (in pixels)
Returns:
integer

getWindowWidth()

Gets the width of the window (in pixels)
Returns:
integer

makeScreenshot(filename)

Writes a screenshot to the given filename.

If filename starts with // the image will be saved relative to the current directory. If the filename contains # it will be replaced with the frame number.

The standalone player saves .png files. It does not support colour space conversion or gamma correction.

When run from Blender, makeScreenshot supports Iris, IrisZ, TGA, Raw TGA, PNG, HamX, and Jpeg. Gamma, Colourspace conversion and Jpeg compression are taken from the Render settings panels.
Parameters:
filename
           (type=string)

setBackgroundColor(rgba)

Sets the window background colour.
Parameters:
rgba
           (type=list [r, g, b, a])

setEyeSeparation(eyesep)

Sets the eye separation for stereo mode.
Parameters:
eyesep - The distance between the left and right eye.
           (type=float)

setFocalLength(focallength)

Sets the focal length for stereo mode.
Parameters:
focallength - The focal length.
           (type=float)

setMistColor(rgb)

Sets the mist colour.
Parameters:
rgb
           (type=list [r, g, b])

setMistEnd(end)

Sets the mist end value. Objects further away from this will be coloured solid with the colour set by setMistColor().
Parameters:
end
           (type=float)

setMistStart(start)

Sets the mist start value. Objects further away than start will have mist applied to them.
Parameters:
start
           (type=float)

setMousePosition(x, y)

Sets the mouse cursor position.
Parameters:
x
           (type=integer)
y
           (type=integer)

showMouse(visible)

Enables or disables the operating system mouse cursor.
Parameters:
visible
           (type=boolean)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net