Source code for psychopy.visual.polygon

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""Creates a regular polygon (triangles, pentagons, ...) as a special case of a

# Part of the PsychoPy library
# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2022 Open Science Tools Ltd.
# Distributed under the terms of the GNU General Public License (GPL).

import psychopy  # so we can get the __path__
from psychopy.visual.shape import BaseShapeStim
from import attributeSetter, setAttribute

import numpy as np

[docs]class Polygon(BaseShapeStim): """Creates a regular polygon (triangles, pentagons, ...). This class is a special case of a :class:`~psychopy.visual.ShapeStim` that accepts the same parameters except `closeShape` and `vertices`. Parameters ---------- win : :class:`~psychopy.visual.Window` Window this shape is being drawn to. The stimulus instance will allocate its required resources using that Windows context. In many cases, a stimulus instance cannot be drawn on different windows unless those windows share the same OpenGL context, which permits resources to be shared between them. edges : `int` Number of sides for the polygon (for instance, `edges=3` will result in a triangle). radius : float Initial radius of the polygon in `units`. This specifies how far out to place the corners (vertices) of the shape. units : str Units to use when drawing. This will affect how parameters and attributes `pos`, `size` and `radius` are interpreted. lineWidth : float Width of the polygon's outline. lineColor, fillColor : array_like, str, :class:`~psychopy.colors.Color` or `None` Color of the shape's outline and fill. If `None`, a fully transparent color is used which makes the fill or outline invisible. lineColorSpace, fillColorSpace : str Colorspace to use for the outline and fill. These change how the values passed to `lineColor` and `fillColor` are interpreted. *Deprecated*. Please use `colorSpace` to set both outline and fill colorspace. These arguments may be removed in a future version. pos : array_like Initial position (`x`, `y`) of the shape on-screen relative to the origin located at the center of the window or buffer in `units`. This can be updated after initialization by setting the `pos` property. The default value is `(0.0, 0.0)` which results in no translation. size : float or array_like Initial scale factor for adjusting the size of the shape. A single value (`float`) will apply uniform scaling, while an array (`sx`, `sy`) will result in anisotropic scaling in the horizontal (`sx`) and vertical (`sy`) direction. Providing negative values to `size` will cause the shape being mirrored. Scaling can be changed by setting the `size` property after initialization. The default value is `1.0` which results in no scaling. ori : float Initial orientation of the shape in degrees about its origin. Positive values will rotate the shape clockwise, while negative values will rotate counterclockwise. The default value for `ori` is 0.0 degrees. opacity : float Opacity of the shape. A value of 1.0 indicates fully opaque and 0.0 is fully transparent (therefore invisible). Values between 1.0 and 0.0 will result in colors being blended with objects in the background. This value affects the fill (`fillColor`) and outline (`lineColor`) colors of the shape. contrast : float Contrast level of the shape (0.0 to 1.0). This value is used to modulate the contrast of colors passed to `lineColor` and `fillColor`. depth : int Depth layer to draw the stimulus when `autoDraw` is enabled. interpolate : bool Enable smoothing (anti-aliasing) when drawing shape outlines. This produces a smoother (less-pixelated) outline of the shape. lineRGB, fillRGB: array_like, :class:`~psychopy.colors.Color` or None *Deprecated*. Please use `lineColor` and `fillColor`. These arguments may be removed in a future version. name : str Optional name of the stimuli for logging. autoLog : bool Enable auto-logging of events associated with this stimuli. Useful for debugging and to track timing when used in conjunction with `autoDraw`. autoDraw : bool Enable auto drawing. When `True`, the stimulus will be drawn every frame without the need to explicitly call the :py:meth:`~psychopy.visual.shape.ShapeStim.draw()` method. color : array_like, str, :class:`~psychopy.colors.Color` or `None` Sets both the initial `lineColor` and `fillColor` of the shape. colorSpace : str Sets the colorspace, changing how values passed to `lineColor` and `fillColor` are interpreted. """ def __init__(self, win, edges=3, radius=.5, units='', lineWidth=1.5, lineColor=None, lineColorSpace=None, fillColor='white', fillColorSpace=None, pos=(0, 0), size=1.0, anchor=None, ori=0.0, opacity=None, contrast=1.0, depth=0, interpolate=True, lineRGB=False, fillRGB=False, name=None, autoLog=None, autoDraw=False, color=None, colorSpace='rgb'): # what local vars are defined (these are the init params) for use by # __repr__ self._initParams = dir() self._initParams.remove('self') self.autoLog = False # but will be changed if needed at end of init self.__dict__['edges'] = edges self.radius = np.asarray(radius) self._calcVertices() super(Polygon, self).__init__( win, units=units, lineWidth=lineWidth, lineColor=lineColor, lineColorSpace=lineColorSpace, fillColor=fillColor, fillColorSpace=fillColorSpace, vertices=self.vertices, closeShape=True, pos=pos, size=size, anchor=anchor, ori=ori, opacity=opacity, contrast=contrast, depth=depth, interpolate=interpolate, lineRGB=lineRGB, fillRGB=fillRGB, name=name, autoLog=autoLog, autoDraw=autoDraw, color=color, colorSpace=colorSpace) def _calcVertices(self): self.vertices = self._calcEquilateralVertices(self.edges, self.radius) @attributeSetter def edges(self, edges): """Number of edges of the polygon. Floats are rounded to int. :ref:`Operations <attrib-operations>` supported. """ self.__dict__['edges'] = edges self._calcVertices() self.setVertices(self.vertices, log=False)
[docs] def setEdges(self, edges, operation='', log=None): """Usually you can use 'stim.attribute = value' syntax instead, but use this method if you need to suppress the log message""" setAttribute(self, 'edges', edges, log, operation)
@attributeSetter def radius(self, radius): """float, int, tuple, list or 2x1 array Radius of the Polygon (distance from the center to the corners). May be a -2tuple or list to stretch the polygon asymmetrically. :ref:`Operations <attrib-operations>` supported. Usually there's a setAttribute(value, log=False) method for each attribute. Use this if you want to disable logging. """ self.__dict__['radius'] = np.array(radius) self._calcVertices() self.setVertices(self.vertices, log=False)
[docs] def setRadius(self, radius, operation='', log=None): """Usually you can use 'stim.attribute = value' syntax instead, but use this method if you need to suppress the log message """ setAttribute(self, 'radius', radius, log, operation)

Back to top