root/trunk/RBRapier/RBRapier/Renderer/Appearance/Lighting.py

#!/usr/bin/env python
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##~ License 
##~ 
##- The RuneBlade Foundation library is intended to ease some 
##- aspects of writing intricate Jabber, XML, and User Interface (wxPython, etc.) 
##- applications, while providing the flexibility to modularly change the 
##- architecture. Enjoy.
##~ 
##~ Copyright (C) 2002  TechGame Networks, LLC.
##~ 
##~ This library is free software; you can redistribute it and/or
##~ modify it under the terms of the BSD style License as found in the 
##~ LICENSE file included with this distribution.
##~ 
##~ TechGame Networks, LLC can be reached at:
##~ 3578 E. Hartsel Drive #211
##~ Colorado Springs, Colorado, USA, 80920
##~
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Imports 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

from RBRapier.Renderer.AttributeMgr import AttributeChangeElement
from RBRapier.Tools import Vector
from OpenGL import GL

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Definitions 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class LightingModel(object):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    AttributeChange = AttributeChangeElement(GL.GL_LIGHTING_BIT)

    LocalViewer = 0
    TwoSided = 0
    ShadeModel = GL.GL_SMOOTH
    AmbientColor = Vector.ColorVectorProperty('Ambient', (.2, .2, .2, 1.))

    # The following is not supported at the moment by PyOpenGL -- no constants!
    #SeperateSpecular = GL.GL_SINGLE_COLOR # GL.GL_SEPARATE_SPECULAR_COLOR

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def __init__(self, **kw):
        for name,value in kw.iteritems():
            setattr(self, name, value)

    def GLSelect(self, context):
        context.StateMgr.Enable(GL.GL_LIGHTING)
        GL.glShadeModel(self.ShadeModel)
        GL.glLightModel(GL.GL_LIGHT_MODEL_AMBIENT, self.AmbientColor)
        GL.glLightModel(GL.GL_LIGHT_MODEL_TWO_SIDE, self.TwoSided)
        GL.glLightModel(GL.GL_LIGHT_MODEL_LOCAL_VIEWER, self.LocalViewer)

        # The following is not supported at the moment by PyOpenGL -- no constants!
        #GL.glLightModel(GL.GL_LIGHT_MODEL_COLOR_CONTROL, self.SeperateSpecular)

    def GLDeselect(self, context):
        context.StateMgr.Disable(GL.GL_LIGHTING)

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class Light(object):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    AttributeChange = AttributeChangeElement(GL.GL_LIGHTING_BIT)

    LightNumber = None # 0

    Ambient = Vector.ColorVectorProperty('Ambient', (0., 0., 0., 1.))
    Diffuse = Vector.ColorVectorProperty('Diffuse', (1., 1., 1., 1.))
    Specular = Vector.ColorVectorProperty('Specular', (1., 1., 1., 1.))

    Position = Vector.Vector4Property('Position', (0., 0., 1., 0.))

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def __init__(self, LightNumber=None, **kw):
        self.LightNumber = LightNumber
        for name,value in kw.iteritems():
            setattr(self, name, value)

    def GLSelect(self, context):
        LightId = GL.GL_LIGHT0 + self.LightNumber
        context.StateMgr.Enable(LightId)
        GL.glLightfv(LightId, GL.GL_AMBIENT, self.Ambient)
        GL.glLightfv(LightId, GL.GL_DIFFUSE, self.Diffuse)
        GL.glLightfv(LightId, GL.GL_SPECULAR, self.Specular)
        GL.glLightfv(LightId, GL.GL_POSITION, self.Position)

    def GLDeselect(self, context):
        LightId = GL.GL_LIGHT0 + self.LightNumber
        context.StateMgr.Disable(LightId)

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class AttenuatedLightMixin(object):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    Attenuation = Vector.Vector3Property('Attenuation', (1., 0., 0.))

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def GLSelect(self, context):
        self.__super.GLSelect(context)
        const,linear,quadratic = self.Attenuation
        GL.glLightf(LightId, GL.GL_CONSTANT_ATTENUATION, const)
        GL.glLightf(LightId, GL.GL_LINEAR_ATTENUATION, linear)
        GL.glLightf(LightId, GL.GL_QUADRATIC_ATTENUATION, quadratic)

AttenuatedLightMixin._AttenuatedLightMixin__super = super(AttenuatedLightMixin)

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class SpotLightMixin(object):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    SpotDirection = Vector.UnitVector3Property('SpotDirection', (0., 0., -1.))
    SpotExponent = 0.0
    SpotCutoff = 180.0

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def GLSelect(self, context):
        self.__super.GLSelect(context)
        LightId = GL.GL_LIGHT0 + self.LightNumber
        GL.glLightfv(LightId, GL.GL_SPOT_DIRECTION, self.SpotDirection)
        GL.glLightf(LightId, GL.GL_SPOT_EXPONENT, self.SpotExponent)
        GL.glLightf(LightId, GL.GL_SPOT_CUTOFF, self.SpotCutoff)

SpotLightMixin._SpotLightMixin__super = super(SpotLightMixin)

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class AttenuatedLight(AttenuatedLightMixin, Light): pass
class SpotLight(SpotLightMixin, Light): pass
class AttenuatedSpotLight(SpotLightMixin, AttenuatedLightMixin, Light): pass