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

# Class Text

source code

                   object --+
                            |
          ClassWithParameters --+
                                |
                    Core.Stimulus --+
                                    |
    Textures.TextureStimulusBaseClass --+
                                        |
                 Textures.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 runtime)
    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 runtime)
    text                  -- (AnyOf(String or Unicode))
                             Default: the string to display
    texture               -- source of texture data (Instance of <class 'VisionEgg.Textures.Texture'>)
                             Inherited from VisionEgg.Textures.TextureStimulusBaseClass
                             Default: (determined at runtime)
    texture_mag_filter    -- OpenGL filter enum (Integer)
                             Inherited from VisionEgg.Textures.TextureStimulusBaseClass
                             Default: GL_LINEAR (9729)
    texture_min_filter    -- OpenGL filter enum (Integer)
                             Inherited from VisionEgg.Textures.TextureStimulusBaseClass
                             Default: (GL enum determined at runtime)
    texture_wrap_s        -- OpenGL texture wrap enum (Integer)
                             Inherited from VisionEgg.Textures.TextureStimulusBaseClass
                             Default: (GL enum determined at runtime)
    texture_wrap_t        -- OpenGL texture wrap enum (Integer)
                             Inherited from VisionEgg.Textures.TextureStimulusBaseClass
                             Default: (GL enum determined at runtime)

    Constant Parameters
    ===================
    font_name         -- (AnyOf(String or Unicode))
                         Default: (determined at runtime)
    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 (6407)
    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

Instance Methods
__init__(self, **kw) | source code
draw(self) | source code
Inherited from `ClassWithParameters`: `__getstate__`, `__setstate__`, `get_specified_type`, `is_constant_parameter`, `set`, `verify_parameters` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Class Variables
| parameters_and_defaults = `{'text':('the string to display', ve`...``
| constant_parameters_and_defaults = `{'font_size':(30, ve_types.`...``
Inherited from `ClassWithParameters`: `__safe_for_unpickling__`

Properties
Inherited from `object`: `__class__`

Method Details

### __init__(self, **kw) (Constructor) | source code
Overrides: Textures.TextureStimulusBaseClass.__init__

### draw(self) | source code
Overrides: Textures.TextureStimulus.draw

Class Variable Details

  ### parameters_and_defaults Value:
      {'text':('the string to display', ve_types.AnyOf(ve_types.String, ve_t
      ypes.Unicode)), 'ignore_size_parameter':(True, ve_types.Boolean),}

  ### constant_parameters_and_defaults Value:
      {'font_size':(30, ve_types.UnsignedInteger), 'font_name':(None, ve_typ
      es.AnyOf(ve_types.String, ve_types.Unicode)),}