spyre.spyre.StudioColorMat

Package spyre :: Module spyre :: Class StudioColorMat

Type StudioColorMat

object --+    
         |    
NullStudio --+
             |
            StudioColorMat

Manage environmental effects such as lights and fog

Method Summary
	`__init__(self, engine, ambient)` Initialize new instance.
	`addCamLight(self, light, position)` Add a light to camera lights array
	`addFixedLight(self, light, position)` Add a light to fixed lights array
	`addMobileLight(self, light, mover, position)` Add a light to mobile lights array.
	`depthCueing(self, status, fmode, density, near, far)` Initialize depth cueing.
	`display(self)` Push settings to OpenGL.
	`displayCamLights(self)` Push all light params through to OpenGL
	`displayFixedLights(self)` Push all light params through to OpenGL
	`displayFog(self)` Initialize depth cueing.
	`displayMobileLights(self)` Push all light params through to OpenGL.
	`init(self)` Prep scene for lighting, set light models, colormaterial, etc...
	`lightsOK(self)` Enable lighting
	`lightsOut(self)` Disable all lighting
	`removeCamLight(self, light)` Removes light from camera lights array
	`removeFixedLight(self, light)` Removes light from fixed lights array
	`removeMobileLight(self, light)` Removes light from mobile lights array.
	`setup(self)` Prep scene for lighting, set light models, colormaterial, etc...
	`update(self)` Updates the Mobile Lights (and whatever else).
Inherited from NullStudio
	`commit(self)` Commits the Mobile Lights (and whatever else)
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

init(self, engine, ambient=(0.14999999999999999, 0.14999999999999999, 0.149999999999...)
(Constructor)

Initialize new instance.

Parameters:: engine - the engine; ambient - 4 tuple, rgba for ambient light color

Overrides:: spyre.spyre.NullStudio.__init__

addCamLight(self, light, position=None)

Add a light to camera lights array

Overrides:: spyre.spyre.NullStudio.addCamLight

addFixedLight(self, light, position=None)

Add a light to fixed lights array

Overrides:: spyre.spyre.NullStudio.addFixedLight

addMobileLight(self, light, mover=None, position=None)

Add a light to mobile lights array. If mover provided, studio will call update method of mover periodically. Same light can be passed as both.

Parameters:: light - light to be added; mover - typically a 'group' that moves, and contains the light. Can be same as light.; position - x,y,z tuple with initial light position

Overrides:: spyre.spyre.NullStudio.addMobileLight

depthCueing(self, status=True, fmode=None, density=None, near=None, far=None)

Initialize depth cueing.

Parameters:: status - is depth cueing enabled?; fmode - GL_LINEAR, GL_EXP, or GL_EXP2; density - float > 0, ignored for GL_LINEAR mode; near - how near the camera does fog start?; far - how far from the camera does fog extend?