Package VisionEgg :: Module Textures :: Class TextureStimulus
[frames | no frames]

Class TextureStimulus

         object --+            
                  |            
ClassWithParameters --+        
                      |        
               Stimulus --+    
                          |    
   TextureStimulusBaseClass --+
                              |
                             TextureStimulus

Known Subclasses:
Text

A textured rectangle.

This is mainly for 2D use (z coordinate fixed to 0.0 and w
coordinated fixed to 1.0 if not given).


Parameters
==========
anchor             -- specifies how position parameter is interpreted (String)
                      Default: lowerleft
angle              -- units: degrees, 0=right, 90=up (Real)
                      Default: 0.0
color              -- texture environment color. alpha ignored (if given) for max_alpha parameter (AnyOf(Sequence3 of Real or Sequence4 of Real))
                      Default: (1.0, 1.0, 1.0)
depth_test         -- perform depth test? (Boolean)
                      Default: False
mask               -- optional masking function (Instance of <class 'VisionEgg.Textures.Mask2D'>)
                      Default: (determined at instantiation)
max_alpha          -- controls opacity. 1.0=copletely opaque, 0.0=completely transparent (Real)
                      Default: 1.0
on                 -- draw stimulus? (Boolean)
                      Default: True
position           -- units: eye coordinates (AnyOf(Sequence2 of Real or Sequence3 of Real or Sequence4 of Real))
                      Default: (0.0, 0.0)
size               -- defaults to texture data size (units: eye coordinates) (Sequence2 of Real)
                      Default: (determined at instantiation)
texture            -- source of texture data (Instance of <class 'VisionEgg.Textures.Texture'>)
                      Inherited from TextureStimulusBaseClass
                      Default: (determined at instantiation)
texture_mag_filter -- OpenGL filter enum (Integer)
                      Inherited from TextureStimulusBaseClass
                      Default: GL_LINEAR
texture_min_filter -- OpenGL filter enum (Integer)
                      Inherited from TextureStimulusBaseClass
                      Default: (GL enum determined at instantiation)
texture_wrap_s     -- OpenGL texture wrap enum (Integer)
                      Inherited from TextureStimulusBaseClass
                      Default: (GL enum determined at instantiation)
texture_wrap_t     -- OpenGL texture wrap enum (Integer)
                      Inherited from TextureStimulusBaseClass
                      Default: (GL enum determined at instantiation)

Constant Parameters
===================
internal_format   -- format with which OpenGL uses texture data (OpenGL data type enum) (Integer)
                     Default: GL_RGB
mipmaps_enabled   -- Are mipmaps enabled? (Boolean)
                     Default: True
shrink_texture_ok -- Allow automatic shrinking of texture if too big? (Boolean)
                     Default: False

Method Summary
  __init__(self, **kw)
Instantiate and get ready to draw.
  draw(self)
Draw the stimulus.
    Inherited from ClassWithParameters
  get_specified_type(self, parameter_name)
  is_constant_parameter(self, parameter_name)
  set(self, **kw)
Set a parameter with type-checked value This is the slow but safe way to set parameters.
  verify_parameters(self)
Perform type check on all parameters...
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name...
  __getattribute__(...)
x.__getattribute__('name') <==> x.name...
  __hash__(x)
x.__hash__() <==> hash(x)...
  __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)...
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T...

Class Variable Summary
tuple __slots__ = ('parameters', 'constant_parameters', 'textu...
member_descriptor constant_parameters = <member 'constant_parameters' of '...
member_descriptor parameters = <member 'parameters' of 'TextureStimulus' o...
dict parameters_and_defaults = {'on': (True, <class 'VisionEg...
member_descriptor texture_object = <member 'texture_object' of 'TextureSti...
    Inherited from TextureStimulusBaseClass
dict constant_parameters_and_defaults = {'shrink_texture_ok':...

Method Details

__init__(self, **kw)
(Constructor)

Instantiate and get ready to draw.

Set parameter values and create anything needed to draw the
stimulus including OpenGL state variables such display lists
and texture objects.
Overrides:
VisionEgg.Textures.TextureStimulusBaseClass.__init__ (inherited documentation)

draw(self)

Draw the stimulus. (Called by Viewport instance.)

This method is called every frame.  This method actually
performs the OpenGL calls to draw the stimulus.
Overrides:
VisionEgg.Core.Stimulus.draw (inherited documentation)

Class Variable Details

__slots__

Type:
tuple
Value:
('parameters', 'constant_parameters', 'texture_object', '_using_textur\
e')                                                                    

constant_parameters

Type:
member_descriptor
Value:
<member 'constant_parameters' of 'TextureStimulus' objects>            

parameters

Type:
member_descriptor
Value:
<member 'parameters' of 'TextureStimulus' objects>                     

parameters_and_defaults

Type:
dict
Value:
{'anchor': ('lowerleft',
            <class 'VisionEgg.ParameterTypes.String'>,
            'specifies how position parameter is interpreted'),
 'angle': (0.0,
           <class 'VisionEgg.ParameterTypes.Real'>,
           'units: degrees, 0=right, 90=up'),
 'color': ((1.0, 1.0, 1.0),
           <VisionEgg.ParameterTypes.AnyOf object at 0x40f1f8ec>,
...                                                                    

texture_object

Type:
member_descriptor
Value:
<member 'texture_object' of 'TextureStimulus' objects>                 

Generated by Epydoc 2.0 on Fri Sep 19 18:29:36 2003 http://epydoc.sf.net