mirror of
https://github.com/psychopy/psychojs.git
synced 2025-05-10 10:40:54 +00:00
443 lines
13 KiB
HTML
443 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: visual/ShapeStim.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: visual/ShapeStim.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/** @module visual */
|
|
/**
|
|
* Basic Shape Stimulus.
|
|
*
|
|
* @author Alain Pitiot
|
|
* @version 2020.5
|
|
* @copyright (c) 2020 Ilixa Ltd. ({@link http://ilixa.com})
|
|
* @license Distributed under the terms of the MIT License
|
|
*/
|
|
|
|
|
|
import {VisualStim} from './VisualStim';
|
|
import {Color} from '../util/Color';
|
|
import {ColorMixin} from '../util/ColorMixin';
|
|
import * as util from '../util/Util';
|
|
import {WindowMixin} from "../core/WindowMixin";
|
|
|
|
|
|
/**
|
|
* <p>This class provides the basic functionality of shape stimuli.</p>
|
|
*
|
|
* @class
|
|
* @extends VisualStim
|
|
* @mixes ColorMixin
|
|
* @param {Object} options
|
|
* @param {String} options.name - the name used when logging messages from this stimulus
|
|
* @param {Window} options.win - the associated Window
|
|
* @param {number} options.lineWidth - the line width
|
|
* @param {Color} [options.lineColor= 'white'] the line color
|
|
* @param {Color} options.fillColor - the fill color
|
|
* @param {number} [options.opacity= 1.0] - the opacity
|
|
* @param {Array.<Array.<number>>} [options.vertices= [[-0.5, 0], [0, 0.5], [0.5, 0]]] - the shape vertices
|
|
* @param {boolean} [options.closeShape= true] - whether or not the shape is closed
|
|
* @param {Array.<number>} [options.pos= [0, 0]] - the position of the center of the shape
|
|
* @param {number} [options.size= 1.0] - the size
|
|
* @param {number} [options.ori= 0.0] - the orientation (in degrees)
|
|
* @param {string} options.units - the units of the stimulus vertices, size and position
|
|
* @param {number} [options.contrast= 1.0] - the contrast
|
|
* @param {number} [options.depth= 0] - the depth
|
|
* @param {boolean} [options.interpolate= true] - whether or not the shape is interpolated
|
|
* @param {boolean} [options.autoDraw= false] - whether or not the stimulus should be automatically drawn on every frame flip
|
|
* @param {boolean} [options.autoLog= false] - whether or not to log
|
|
*/
|
|
export class ShapeStim extends util.mix(VisualStim).with(ColorMixin, WindowMixin)
|
|
{
|
|
constructor({name, win, lineWidth, lineColor, fillColor, opacity, vertices, closeShape, pos, size, ori, units, contrast, depth, interpolate, autoDraw, autoLog} = {})
|
|
{
|
|
super({name, win, units, ori, opacity, pos, depth, size, autoDraw, autoLog});
|
|
|
|
// the PIXI polygon corresponding to the vertices, in pixel units:
|
|
this._pixiPolygon_px = undefined;
|
|
// the vertices (in pixel units):
|
|
this._vertices_px = undefined;
|
|
|
|
// shape:
|
|
if (typeof size === 'undefined' || size === null)
|
|
{
|
|
this.size = [1.0, 1.0];
|
|
}
|
|
this._addAttribute(
|
|
'vertices',
|
|
vertices,
|
|
[[-0.5, 0], [0, 0.5], [0.5, 0]]
|
|
);
|
|
this._addAttribute(
|
|
'closeShape',
|
|
closeShape,
|
|
true,
|
|
this._onChange(true, false)
|
|
);
|
|
this._addAttribute(
|
|
'interpolate',
|
|
interpolate,
|
|
true,
|
|
this._onChange(true, false)
|
|
);
|
|
|
|
this._addAttribute(
|
|
'lineWidth',
|
|
lineWidth,
|
|
1.5,
|
|
this._onChange(true, true)
|
|
);
|
|
|
|
// colors:
|
|
this._addAttribute(
|
|
'lineColor',
|
|
lineColor,
|
|
'white',
|
|
this._onChange(true, false)
|
|
);
|
|
this._addAttribute(
|
|
'fillColor',
|
|
fillColor,
|
|
undefined,
|
|
this._onChange(true, false)
|
|
);
|
|
this._addAttribute(
|
|
'contrast',
|
|
contrast,
|
|
1.0,
|
|
this._onChange(true, false)
|
|
);
|
|
this._addAttribute(
|
|
'opacity',
|
|
opacity,
|
|
1.0,
|
|
this._onChange(false, false)
|
|
);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Setter for the vertices attribute.
|
|
*
|
|
* @name module:visual.ShapeStim#setVertices
|
|
* @public
|
|
* @param {Array.<Array.<number>>} vertices - the vertices
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setVertices(vertices, log = false)
|
|
{
|
|
const response = {
|
|
origin: 'ShapeStim.setVertices',
|
|
context: 'when setting the vertices of ShapeStim: ' + this._name
|
|
};
|
|
|
|
this._psychoJS.logger.debug('set the vertices of ShapeStim:', this.name);
|
|
|
|
try
|
|
{
|
|
// if vertices is a string, we check whether it is a known shape:
|
|
if (typeof vertices === 'string')
|
|
{
|
|
if (vertices in ShapeStim.KnownShapes)
|
|
{
|
|
vertices = ShapeStim.KnownShapes[vertices];
|
|
}
|
|
else
|
|
{
|
|
throw `unknown shape: ${vertices}`;
|
|
}
|
|
}
|
|
|
|
this._setAttribute('vertices', vertices, log);
|
|
|
|
this._onChange(true, true)();
|
|
}
|
|
catch (error)
|
|
{
|
|
throw Object.assign(response, {error: error});
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Determine whether an object is inside the bounding box of the ShapeStim.
|
|
*
|
|
* This is overridden in order to provide a finer inclusion test.
|
|
*
|
|
* @name module:visual.ShapeStim#contains
|
|
* @public
|
|
* @override
|
|
* @param {Object} object - the object
|
|
* @param {string} units - the units
|
|
* @return {boolean} whether or not the object is inside the bounding box of the ShapeStim
|
|
*/
|
|
contains(object, units)
|
|
{
|
|
// get the position of the object, in pixel coordinates:
|
|
const objectPos_px = util.getPositionFromObject(object, units);
|
|
|
|
if (typeof objectPos_px === 'undefined')
|
|
{
|
|
throw {
|
|
origin: 'VisualStim.contains',
|
|
context: 'when determining whether VisualStim: ' + this._name + ' contains object: ' + util.toString(object),
|
|
error: 'unable to determine the position of the object'
|
|
};
|
|
}
|
|
|
|
// test for inclusion:
|
|
const pos_px = util.to_px(this.pos, this.units, this.win);
|
|
this._getVertices_px();
|
|
const polygon_px = this._vertices_px.map(v => [v[0] + pos_px[0], v[1] + pos_px[1]]);
|
|
return util.IsPointInsidePolygon(objectPos_px, polygon_px);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Estimate the bounding box.
|
|
*
|
|
* @name module:visual.ShapeStim#_estimateBoundingBox
|
|
* @function
|
|
* @override
|
|
* @protected
|
|
*/
|
|
_estimateBoundingBox()
|
|
{
|
|
this._getVertices_px();
|
|
|
|
// left, top, right, bottom limits:
|
|
const limits_px = [
|
|
Number.POSITIVE_INFINITY,
|
|
Number.POSITIVE_INFINITY,
|
|
Number.NEGATIVE_INFINITY,
|
|
Number.NEGATIVE_INFINITY
|
|
];
|
|
for (const vertex of this._vertices_px)
|
|
{
|
|
limits_px[0] = Math.min(limits_px[0], vertex[0]);
|
|
limits_px[1] = Math.min(limits_px[1], vertex[1]);
|
|
limits_px[2] = Math.max(limits_px[2], vertex[0]);
|
|
limits_px[3] = Math.max(limits_px[3], vertex[1]);
|
|
}
|
|
|
|
this._boundingBox = new PIXI.Rectangle(
|
|
this._pos[0] + this._getLengthUnits(limits_px[0]),
|
|
this._pos[1] + this._getLengthUnits(limits_px[1]),
|
|
this._getLengthUnits(limits_px[2] - limits_px[0]),
|
|
this._getLengthUnits(limits_px[3] - limits_px[1])
|
|
);
|
|
|
|
// TODO take the orientation into account
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Update the stimulus, if necessary.
|
|
*
|
|
* @name module:visual.ShapeStim#_updateIfNeeded
|
|
* @private
|
|
*/
|
|
_updateIfNeeded()
|
|
{
|
|
if (!this._needUpdate)
|
|
{
|
|
return;
|
|
}
|
|
this._needUpdate = false;
|
|
|
|
// update the PIXI representation, if need be:
|
|
if (this._needPixiUpdate)
|
|
{
|
|
this._needPixiUpdate = false;
|
|
|
|
if (typeof this._pixi !== 'undefined')
|
|
{
|
|
this._pixi.destroy(true);
|
|
}
|
|
this._pixi = undefined;
|
|
|
|
// get the PIXI polygon (this also updates _vertices_px):
|
|
this._getPixiPolygon();
|
|
|
|
// prepare the polygon in the given color and opacity:
|
|
this._pixi = new PIXI.Graphics();
|
|
this._pixi.lineStyle(this._lineWidth, this._lineColor.int, this._opacity, 0.5);
|
|
if (typeof this._fillColor !== 'undefined' && this._fillColor !== null)
|
|
{
|
|
this._pixi.beginFill(this._fillColor.int, this._opacity);
|
|
}
|
|
this._pixi.drawPolygon(this._pixiPolygon_px);
|
|
if (typeof this._fillColor !== 'undefined' && this._fillColor !== null)
|
|
{
|
|
this._pixi.endFill();
|
|
}
|
|
}
|
|
|
|
// set polygon position and rotation:
|
|
this._pixi.position = util.to_pixiPoint(this.pos, this.units, this.win);
|
|
this._pixi.rotation = this.ori * Math.PI / 180.0;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Get the PIXI polygon (in pixel units) corresponding to the vertices.
|
|
*
|
|
* @name module:visual.ShapeStim#_getPolygon
|
|
* @private
|
|
* @return {Object} the PIXI polygon corresponding to this stimulus vertices.
|
|
*/
|
|
_getPixiPolygon()
|
|
{
|
|
// make sure the vertices in pixel units are available:
|
|
this._getVertices_px();
|
|
|
|
// flatten the vertex_px, which is an array of arrays:
|
|
let coords_px = [];
|
|
for (const vertex_px of this._vertices_px)
|
|
{
|
|
coords_px.push.apply(coords_px, vertex_px);
|
|
}
|
|
|
|
// close the polygon if need be:
|
|
if (coords_px.length >= 6 && this._closeShape)
|
|
{
|
|
// note: we first check whether the vertices already define a closed polygon:
|
|
const n = coords_px.length;
|
|
if (coords_px[0] !== coords_px[n - 2] || coords_px[1] !== coords_px[n - 1])
|
|
{
|
|
coords_px.push(coords_px[0]);
|
|
coords_px.push(coords_px[1]);
|
|
}
|
|
}
|
|
|
|
// destroy the previous PIXI polygon and create a new one:
|
|
this._pixiPolygon_px = new PIXI.Polygon(coords_px);
|
|
return this._pixiPolygon_px;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Get the vertices in pixel units.
|
|
*
|
|
* @name module:visual.ShapeStim#_getVertices_px
|
|
* @protected
|
|
* @return {Array.<number[]>} the vertices (in pixel units)
|
|
*/
|
|
_getVertices_px()
|
|
{
|
|
// handle flipping:
|
|
let flip = [1.0, 1.0];
|
|
if ('_flipHoriz' in this && this._flipHoriz)
|
|
{
|
|
flip[0] = -1.0;
|
|
}
|
|
if ('_flipVert' in this && this._flipVert)
|
|
{
|
|
flip[1] = -1.0;
|
|
}
|
|
|
|
// handle size, flipping, and convert to pixel units:
|
|
this._vertices_px = this._vertices.map(v => util.to_px(
|
|
[v[0] * this._size[0] * flip[0], v[1] * this._size[1] * flip[1]],
|
|
this._units,
|
|
this._win)
|
|
);
|
|
|
|
return this._vertices_px;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Known shapes.
|
|
*
|
|
* @readonly
|
|
* @public
|
|
*/
|
|
ShapeStim.KnownShapes = {
|
|
cross: [
|
|
[-0.1, +0.5], // up
|
|
[+0.1, +0.5],
|
|
[+0.1, +0.1],
|
|
[+0.5, +0.1], // right
|
|
[+0.5, -0.1],
|
|
[+0.1, -0.1],
|
|
[+0.1, -0.5], // down
|
|
[-0.1, -0.5],
|
|
[-0.1, -0.1],
|
|
[-0.5, -0.1], // left
|
|
[-0.5, +0.1],
|
|
[-0.1, +0.1]
|
|
],
|
|
|
|
star7: [
|
|
[0.0, 0.5],
|
|
[0.09, 0.18],
|
|
[0.39, 0.31],
|
|
[0.19, 0.04],
|
|
[0.49, -0.11],
|
|
[0.16, -0.12],
|
|
[0.22, -0.45],
|
|
[0.0, -0.2],
|
|
[-0.22, -0.45],
|
|
[-0.16, -0.12],
|
|
[-0.49, -0.11],
|
|
[-0.19, 0.04],
|
|
[-0.39, 0.31],
|
|
[-0.09, 0.18]
|
|
]
|
|
|
|
};
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-core.html">core</a></li><li><a href="module-data.html">data</a></li><li><a href="module-sound.html">sound</a></li><li><a href="module-util.html">util</a></li><li><a href="module-visual.html">visual</a></li></ul><h3>Classes</h3><ul><li><a href="module-core.BuilderKeyResponse.html">BuilderKeyResponse</a></li><li><a href="module-core.EventManager.html">EventManager</a></li><li><a href="module-core.GUI.html">GUI</a></li><li><a href="module-core.Keyboard.html">Keyboard</a></li><li><a href="module-core.KeyPress.html">KeyPress</a></li><li><a href="module-core.Logger.html">Logger</a></li><li><a href="module-core.MinimalStim.html">MinimalStim</a></li><li><a href="module-core.Mouse.html">Mouse</a></li><li><a href="module-core.PsychoJS.html">PsychoJS</a></li><li><a href="module-core.ServerManager.html">ServerManager</a></li><li><a href="module-core.Window.html">Window</a></li><li><a href="module-data.ExperimentHandler.html">ExperimentHandler</a></li><li><a href="module-data.TrialHandler.html">TrialHandler</a></li><li><a href="module-sound.Sound.html">Sound</a></li><li><a href="module-sound.TonePlayer.html">TonePlayer</a></li><li><a href="module-sound.TrackPlayer.html">TrackPlayer</a></li><li><a href="module-util.Clock.html">Clock</a></li><li><a href="module-util.Color.html">Color</a></li><li><a href="module-util.CountdownTimer.html">CountdownTimer</a></li><li><a href="module-util.EventEmitter.html">EventEmitter</a></li><li><a href="module-util.MixinBuilder.html">MixinBuilder</a></li><li><a href="module-util.MonotonicClock.html">MonotonicClock</a></li><li><a href="module-util.PsychObject.html">PsychObject</a></li><li><a href="module-util.Scheduler.html">Scheduler</a></li><li><a href="module-visual.Form.html">Form</a></li><li><a href="module-visual.ImageStim.html">ImageStim</a></li><li><a href="module-visual.MovieStim.html">MovieStim</a></li><li><a href="module-visual.Polygon.html">Polygon</a></li><li><a href="module-visual.Rect.html">Rect</a></li><li><a href="module-visual.ShapeStim.html">ShapeStim</a></li><li><a href="module-visual.Slider.html">Slider</a></li><li><a href="module-visual.TextBox.html">TextBox</a></li><li><a href="module-visual.TextStim.html">TextStim</a></li><li><a href="module-visual.VisualStim.html">VisualStim</a></li><li><a href="TextInput.html">TextInput</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-sound.SoundPlayer.html">SoundPlayer</a></li></ul><h3>Mixins</h3><ul><li><a href="module-core.WindowMixin.html">WindowMixin</a></li><li><a href="module-util.ColorMixin.html">ColorMixin</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Aug 20 2020 11:48:06 GMT+0200 (Central European Summer Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|