Home       Trees       Index       Help   

Vision Egg

Package VisionEgg :: Module Text :: Class Text
[frames | no frames]

Class Text

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


Single line of text rendered using pygame/SDL true type fonts.

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

Constant Parameters
===================
font_name         -- (String)
                     Default: (determined at instantiation)
font_size         -- (UnsignedInteger)
                     Default: 30
internal_format   -- format with which OpenGL uses texture data (OpenGL data type enum) (Integer)
                     Inherited from VisionEgg.Textures.TextureStimulus
                     Default: GL_RGB
mipmaps_enabled   -- Are mipmaps enabled? (Boolean)
                     Inherited from VisionEgg.Textures.TextureStimulus
                     Default: True
shrink_texture_ok -- Allow automatic shrinking of texture if too big? (Boolean)
                     Inherited from VisionEgg.Textures.TextureStimulus
                     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 '...
dict constant_parameters_and_defaults = {'font_size': (30, <c...
member_descriptor font = <member 'font' of 'Text' objects>
member_descriptor parameters = <member 'parameters' of 'Text' objects>
dict parameters_and_defaults = {'text': ('the string to displ...
member_descriptor texture_object = <member 'texture_object' of 'Text' obje...

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.TextureStimulus.__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.Textures.TextureStimulus.draw (inherited documentation)

Class Variable Details

__slots__

Type:
tuple
Value:
('parameters',
 'constant_parameters',
 'texture_object',
 '_using_texture',
 'font',
 '_text')

constant_parameters

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

constant_parameters_and_defaults

Type:
dict
Value:
{'font_name': (None, <class 'VisionEgg.ParameterTypes.String'>),
 'font_size': (30, <class 'VisionEgg.ParameterTypes.UnsignedInteger'>)\
}

font

Type:
member_descriptor
Value:
<member 'font' of 'Text' objects>

parameters

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

parameters_and_defaults

Type:
dict
Value:
{'ignore_size_parameter': (True, <class 'VisionEgg.ParameterTypes.Bool\
ean'>),
 'text': ('the string to display', <class 'VisionEgg.ParameterTypes.St\
ring'>)}

texture_object

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

   Home       Trees       Index       Help   

Vision Egg

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