Polygon

visual Polygon

Polygonal visual stimulus.

Constructor

new Polygon(options)

Source:

Polygonal visual stimulus.

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
name String

the name used when logging messages from this stimulus
win Window

the associated Window
lineWidth number <optional>
 1.5

the line width
lineColor Color <optional>
 Color('white')

the line color
fillColor Color

the fill color
opacity number <optional>
 1.0

the opacity
edges number <optional>
 3

the number of edges of the polygon
radius number <optional>
 0.5

the radius of the polygon
pos Array.<number> <optional>
 [0, 0]

the position
size number <optional>
 1.0

the size
ori number <optional>
 0.0

the orientation (in degrees)
units string

the units of the stimulus vertices, size and position
contrast number <optional>
 1.0

the contrast
depth number <optional>
 0

the depth
interpolate boolean <optional>
 true

whether or not the shape is interpolated
autoDraw boolean <optional>
 false

whether or not the stimulus should be automatically drawn on every frame flip
autoLog boolean <optional>
 false

whether or not to log

Extends

Methods

(protected) _estimateBoundingBox()

Source:
Inherited From:

Estimate the bounding box.

(protected) _getPixiPolygon() → {Object}

Source:
Overrides:

Get the PIXI polygon (in pixel units) corresponding to the vertices.

Returns:

the PIXI polygon corresponding to this stimulus vertices.

Type
Object

(protected) _getVertices_px() → {Array.<Array.<number>>}

Source:
Overrides:

Get the vertices in pixel units.

Returns:

the vertices (in pixel units)

Type
Array.<Array.<number>>

(protected) _updateIfNeeded()

Source:
Overrides:

Update the stimulus, if necessary.

contains(object, units) → {boolean}

Source:
Inherited From:

Determine whether an object is inside the bounding box of the ShapeStim.

This is overridden in order to provide a finer inclusion test.

Parameters:
Name Type Description
object Object

the object
units string

the units
Returns:

whether or not the object is inside the bounding box of the ShapeStim

Type
boolean

setEdges(edges, logopt)

Source:

Setter for the edges attribute.

Parameters:
Name Type Attributes Default Description
edges number

the number of edges
log boolean <optional>
 false

whether of not to log

setRadius(radius, logopt)

Source:

Setter for the radius attribute.

Parameters:
Name Type Attributes Default Description
radius number

the polygon radius
log boolean <optional>
 false

whether of not to log

setVertices(vertices, logopt)

Source:
Overrides:

Setter for the vertices attribute.

Parameters:
Name Type Attributes Default Description
vertices Array.<Array.<number>>

the vertices
log boolean <optional>
 false

whether of not to log