No Pity for the Masses

#! /usr/bin/env python
'''
Quaint little Python/OpenGL/Shader example
 
Uses the x-ray shader found in MeshLab
 
Code is a slightly modified version of http://www.pygame.org/wiki/GLSLExample
'''
import OpenGL 
OpenGL.ERROR_ON_COPY = True 
from OpenGL.GL import *
from OpenGL.GLU import *
from OpenGL.GLUT import *
 
# PyOpenGL 3.0.1 introduces this convenience module...
from OpenGL.GL.shaders import *
 
import time, sys
program = None
global falloffValue
global rotY
 
# A general OpenGL initialization function.  Sets all of the initial parameters. 
def InitGL(Width, Height):                # We call this right after our OpenGL window is created.
    glClearColor(0.0, 0.0, 0.0, 0.0)    # This Will Clear The Background Color To Black
    glClearDepth(1.0)                    # Enables Clearing Of The Depth Buffer
    glShadeModel(GL_SMOOTH)                # Enables Smooth Color Shading
 
    glMatrixMode(GL_PROJECTION)
    glLoadIdentity()                    # Reset The Projection Matrix
                                        # Calculate The Aspect Ratio Of The Window
    gluPerspective(45.0, float(Width)/float(Height), 0.1, 100.0)
 
    glMatrixMode(GL_MODELVIEW)
 
    if not glUseProgram:
        print 'Missing Shader Objects!'
        sys.exit(1)
 
    global program
    program = compileProgram(
        compileShader('''
			// Application to vertex shader
			varying vec3 P;
			varying vec3 N;
			varying vec3 I;
 
			void main()
			{
				//Transform vertex by modelview and projection matrices
				gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex;
 
				// Position in clip space
				P = vec3(gl_ModelViewMatrix * gl_Vertex);
 
				// Normal transform (transposed model-view inverse)
				N = gl_NormalMatrix * gl_Normal;
 
				// Incident vector
				I = P;
 
				// Forward current color and texture coordinates after applying texture matrix
				gl_FrontColor = gl_Color;
				gl_TexCoord[0] = gl_TextureMatrix[0] * gl_MultiTexCoord0;
			}
 
        ''',GL_VERTEX_SHADER),
        compileShader('''
			varying vec3 P;
			varying vec3 N;
			varying vec3 I;
 
			uniform float edgefalloff;
 
			void main()
			{
				float opacity = dot(normalize(N), normalize(-I));
				opacity = abs(opacity);
				opacity = 1.0 - pow(opacity, edgefalloff);
 
				gl_FragColor = opacity * gl_Color;
			}
    ''',GL_FRAGMENT_SHADER),
	)
 
 
# The function called when our window is resized (which shouldn't happen if you enable fullscreen, below)
def ReSizeGLScene(Width, Height):
    if Height == 0:                        # Prevent A Divide By Zero If The Window Is Too Small 
        Height = 1
 
    glViewport(0, 0, Width, Height)        # Reset The Current Viewport And Perspective Transformation
    glMatrixMode(GL_PROJECTION)
    glLoadIdentity()
    gluPerspective(45.0, float(Width)/float(Height), 0.1, 100.0)
    glMatrixMode(GL_MODELVIEW)
 
# The main drawing function. 
def DrawGLScene():
	global rotY
 
	# Clear The Screen And The Depth Buffer
	glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
	glLoadIdentity()                    # Reset The View 
 
 
	# Move Left 1.5 units and into the screen 6.0 units.
	glTranslatef(-1.5, 0.0, -6.0)
 
	# Spin this business.
	glRotatef(rotY,0.0,1.0,0.0)
 
 
	# Enable blending and disable depth masking (x-ray shader only applies the opacity falloff.
	glEnable(GL_BLEND);
	glDepthMask(GL_FALSE);
	glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA)
 
	# Load something with some curves
	glutSolidTeapot(1.0)
 
	# Include a lovely dodecahedron
	glScalef(0.3,0.3,0.3)
	glutSolidDodecahedron()
 
	# Swap buffers
	glutSwapBuffers()
 
	rotY += 1.0
 
def mod_falloff(val):
	global falloffValue
	if program:
		edgefalloff = glGetUniformLocation(program, "edgefalloff")
		if not edgefalloff in (None,-1):
			falloffValue = falloffValue + val
			glUniform1f(edgefalloff,falloffValue)
 
# The function called whenever a key is pressed. Note the use of Python tuples to pass in: (key, x, y)  
def keyPressed(*args):
 
	# If escape is pressed, kill everything.
	if args[0] == '\x1b':
		sys.exit()
	elif args[0] == 'c':
		print "Decreasing falloff"
		mod_falloff(1.0)
	elif args[0] == 'x':
		print "Increasing falloff"
		mod_falloff(-1.0)
 
def main():
	global window
	global falloffValue
	global rotY
 
	# For now we just pass glutInit one empty argument. I wasn't sure what should or could be passed in (tuple, list, ...)
	# Once I find out the right stuff based on reading the PyOpenGL source, I'll address this.
	glutInit(sys.argv)
 
	# Select type of Display mode:   
	#  Double buffer 
	#  RGBA color
	# Alpha components supported 
	# Depth buffer
	glutInitDisplayMode(GLUT_RGBA | GLUT_DOUBLE | GLUT_DEPTH)
 
	# get a 640 x 480 window 
	glutInitWindowSize(640, 480)
 
	# the window starts at the upper left corner of the screen 
	glutInitWindowPosition(0, 0)
 
	# Okay, like the C version we retain the window id to use when closing, but for those of you new
	# to Python (like myself), remember this assignment would make the variable local and not global
	# if it weren't for the global declaration at the start of main.
	window = glutCreateWindow("Jeff Molofee's GL Code Tutorial ... NeHe '99")
 
	# Register the drawing function with glut, BUT in Python land, at least using PyOpenGL, we need to
	# set the function pointer and invoke a function to actually register the callback, otherwise it
	# would be very much like the C version of the code.    
	glutDisplayFunc(DrawGLScene)
 
	# Uncomment this line to get full screen.
	#glutFullScreen()
 
	# When we are doing nothing, redraw the scene.
	glutIdleFunc(DrawGLScene)
 
	# Register the function called when our window is resized.
	glutReshapeFunc(ReSizeGLScene)
 
	# Register the function called when the keyboard is pressed.  
	glutKeyboardFunc(keyPressed)
 
	# Initialize our window. 
	InitGL(800, 600)
 
	#Start using our program
	glUseProgram(program)
 
	#Set defaults
	falloffValue = 1.0
	rotY = 0.0
 
	#Trigger a fall off modify to update the shader
	mod_falloff(0.0)
 
	#glEnable (GL_BLEND)
	#glBlendFunc (GL_SRC_ALPHA,GL_ONE_MINUS_SRC_ALPHA)
 
	# Start Event Processing Engine    
	glutMainLoop()
 
# Print message to console, and kick off the main to get it rolling.
 
if __name__ == "__main__":
	print "Hit ESC key to quit."
	print "x - increase shader falloff"
	print "c - decrease shader falloff"
	main()

void retrieveProgramBinary(const GLchar* vsSource, const GLchar* fsSource,
                               const char* myBinaryFileName, 
                               GLenum* binaryFormat)
    {
        GLuint        newFS, newVS;
        GLuint        newProgram;
        const GLchar* sources[1];
        GLint         success;
 
        GLint   binaryLength;
        GLvoid* binary;
        FILE*   outfile;
 
        //
        //  Create new shader/program objects and attach them together.
        //
        newVS = glCreateShader(GL_VERTEX_SHADER);
        newFS = glCreateShader(GL_FRAGMENT_SHADER);
        newProgram = glCreateProgram();
        glAttachShader(newProgram, newVS);
        glAttachShader(newProgram, newFS);
 
        //
        //  Supply GLSL source shaders, compile, and link them
        //
        sources[0] = vsSource;
        glShaderSource(newVS, 1, sources, NULL);
        glCompileShader(newVS);
 
        sources[0] = fsSource;
        glShaderSource(newFS, 1, sources, NULL);
        glCompileShader(newFS);
 
        glProgramParameteri(newProgram, PROGRAM_BINARY_RETRIEVABLE_HINT, GL_TRUE);
        glLinkProgram(newProgram);
        glGetProgramiv(newProgram, GL_LINK_STATUS, &success);
 
        if (!success)
        {
            //
            // Fallback to simpler source shaders?  Take my toys and go home?
            //
        }
 
        glUseProgram(newProgram);
 
        //
        // Perform rendering and state changes likely to be encountered.
        //
        DoRendering(newProgram);
 
        //
        //  Retrieve the binary from the program object
        //
        glGetProgramiv(newProgram, GL_PROGRAM_BINARY_LENGTH, &binaryLength);
        binary = (GLvoid*)malloc(binaryLength);
        glGetProgramBinary(newProgram, binaryLength, NULL, binaryFormat, binary);
 
        //
        //  Cache the program binary for future runs
        //
        outfile = fopen(myBinaryFileName, "wb");
        fwrite(binary, binaryLength, 1, outfile);
        fclose(outfile);
        free(binary);
 
        //
        // Clean up
        // 
        glDeleteShader(newVS);
        glDeleteShader(newFS);
        glDeleteProgram(newProgram);
    }
 
    void loadProgramBinary(const char* myBinaryFileName, GLenum binaryFormat,
                           GLuint progObj)
    {
        GLint   binaryLength;
        GLvoid* binary;
        GLint   success;
        FILE*   infile;
 
        //
        //  Read the program binary
        //
        infile = fopen(myBinaryFileName, "rb");
        fseek(infile, 0, SEEK_END);
        binaryLength = (GLint)ftell(infile);
        binary = (GLvoid*)malloc(binaryLength);
        fseek(infile, 0, SEEK_SET);
        fread(binary, binaryLength, 1, infile);
        fclose(infile);
 
        //
        //  Load the binary into the program object -- no need to link!
        //
        glProgramBinary(progObj, binaryFormat, binary, binaryLength);
        free(binary);
 
        glGetProgramiv(progObj, GL_LINK_STATUS, &success);
 
        if (!success)
        {
            //
            // Something must have changed since the program binaries
            // were cached away.  Fallback to source shader loading path,
            // and then retrieve and cache new program binaries once again.
            //
        }
    }