mirror of
https://github.com/psychopy/psychojs.git
synced 2025-05-10 10:40:54 +00:00
347 lines
12 KiB
HTML
347 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: visual/VisualStim.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/VisualStim.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Base class for all visual stimuli.
|
|
*
|
|
* @author Alain Pitiot
|
|
* @version 2021.2.0
|
|
* @copyright (c) 2017-2020 Ilixa Ltd. (http://ilixa.com) (c) 2020-2021 Open Science Tools Ltd. (https://opensciencetools.org)
|
|
* @license Distributed under the terms of the MIT License
|
|
*/
|
|
|
|
import * as PIXI from "pixi.js-legacy";
|
|
import { MinimalStim } from "../core/MinimalStim.js";
|
|
import { WindowMixin } from "../core/WindowMixin.js";
|
|
import * as util from "../util/Util.js";
|
|
|
|
/**
|
|
* Base class for all visual stimuli.
|
|
*
|
|
* @name module:visual.VisualStim
|
|
* @class
|
|
* @extends MinimalStim
|
|
* @mixes WindowMixin
|
|
* @param {Object} options
|
|
* @param {String} options.name - the name used when logging messages from this stimulus
|
|
* @param {module:core.Window} options.win - the associated Window
|
|
* @param {string} [options.units= "height"] - the units of the stimulus (e.g. for size, position, vertices)
|
|
* @param {number} [options.ori= 0.0] - the orientation (in degrees)
|
|
* @param {number} [options.opacity= 1.0] - the opacity
|
|
* @param {number} [options.depth= 0] - the depth (i.e. the z order)
|
|
* @param {Array.<number>} [options.pos= [0, 0]] - the position of the center of the stimulus
|
|
* @param {number} [options.size= 1.0] - the size
|
|
* @param {PIXI.Graphics} [options.clipMask= null] - the clip mask
|
|
* @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 VisualStim extends util.mix(MinimalStim).with(WindowMixin)
|
|
{
|
|
constructor({ name, win, units, ori, opacity, depth, pos, size, clipMask, autoDraw, autoLog } = {})
|
|
{
|
|
super({ win, name, autoDraw, autoLog });
|
|
|
|
this._addAttribute(
|
|
"units",
|
|
units,
|
|
(typeof win !== "undefined" && win !== null) ? win.units : "height",
|
|
this._onChange(true, true),
|
|
);
|
|
this._addAttribute(
|
|
"pos",
|
|
pos,
|
|
[0, 0],
|
|
);
|
|
this._addAttribute(
|
|
"size",
|
|
size,
|
|
undefined,
|
|
);
|
|
this._addAttribute(
|
|
"ori",
|
|
ori,
|
|
0.0,
|
|
);
|
|
this._addAttribute(
|
|
"opacity",
|
|
opacity,
|
|
1.0,
|
|
this._onChange(true, false),
|
|
);
|
|
this._addAttribute(
|
|
"depth",
|
|
depth,
|
|
0,
|
|
this._onChange(false, false),
|
|
);
|
|
this._addAttribute(
|
|
"clipMask",
|
|
clipMask,
|
|
null,
|
|
this._onChange(false, false),
|
|
);
|
|
|
|
// bounding box of the stimulus, in stimulus units
|
|
// note: boundingBox does not take the orientation into account
|
|
this._addAttribute("boundingBox", PIXI.Rectangle.EMPTY);
|
|
|
|
// the stimulus need to be updated:
|
|
this._needUpdate = true;
|
|
|
|
// the PIXI representation also needs to be updated:
|
|
this._needPixiUpdate = true;
|
|
}
|
|
|
|
/**
|
|
* Force a refresh of the stimulus.
|
|
*
|
|
* refresh() is called, in particular, when the Window is resized.
|
|
*
|
|
* @name module:visual.VisualStim#refresh
|
|
* @public
|
|
*/
|
|
refresh()
|
|
{
|
|
this._onChange(true, true)();
|
|
}
|
|
|
|
/**
|
|
* Setter for the size attribute.
|
|
*
|
|
* @name module:visual.VisualStim#setSize
|
|
* @public
|
|
* @param {undefined | null | number | number[]} size - the stimulus size
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setSize(size, log = false)
|
|
{
|
|
// size is either undefined, null, or a tuple of numbers:
|
|
if (typeof size !== "undefined" && size !== null)
|
|
{
|
|
size = util.toNumerical(size);
|
|
if (!Array.isArray(size))
|
|
{
|
|
size = [size, size];
|
|
}
|
|
}
|
|
|
|
const hasChanged = this._setAttribute("size", size, log);
|
|
|
|
if (hasChanged)
|
|
{
|
|
this._onChange(true, true)();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Setter for the orientation attribute.
|
|
*
|
|
* @name module:visual.VisualStim#setOri
|
|
* @public
|
|
* @param {number} ori - the orientation in degree with 0 as the vertical position, positive values rotate clockwise.
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setOri(ori, log = false)
|
|
{
|
|
const hasChanged = this._setAttribute("ori", ori, log);
|
|
|
|
if (hasChanged)
|
|
{
|
|
let radians = -ori * 0.017453292519943295;
|
|
this._rotationMatrix = [
|
|
[Math.cos(radians), -Math.sin(radians)],
|
|
[Math.sin(radians), Math.cos(radians)]
|
|
];
|
|
|
|
if (this._pixi instanceof PIXI.DisplayObject) {
|
|
this._pixi.rotation = -ori * Math.PI / 180;
|
|
} else {
|
|
this._onChange(true, true)();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Setter for the position attribute.
|
|
*
|
|
* @name module:visual.VisualStim#setPos
|
|
* @public
|
|
* @param {Array.<number>} pos - position of the center of the stimulus, in stimulus units
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setPos(pos, log = false)
|
|
{
|
|
const prevPos = this._pos;
|
|
const hasChanged = this._setAttribute("pos", util.toNumerical(pos), log);
|
|
|
|
if (hasChanged)
|
|
{
|
|
this._needUpdate = true;
|
|
|
|
// update the bounding box, without calling _estimateBoundingBox:
|
|
this._boundingBox.x += this._pos[0] - prevPos[0];
|
|
this._boundingBox.y += this._pos[1] - prevPos[1];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determine whether an object is inside the bounding box of the stimulus.
|
|
*
|
|
* @name module:visual.VisualStim#contains
|
|
* @public
|
|
* @param {Object} object - the object
|
|
* @param {string} units - the units
|
|
* @return {boolean} whether or not the object is inside the bounding box of the stimulus
|
|
*/
|
|
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:
|
|
return this._getBoundingBox_px().contains(objectPos_px[0], objectPos_px[1]);
|
|
}
|
|
|
|
/**
|
|
* Estimate the bounding box.
|
|
*
|
|
* @name module:visual.VisualStim#_estimateBoundingBox
|
|
* @function
|
|
* @protected
|
|
*/
|
|
_estimateBoundingBox()
|
|
{
|
|
throw {
|
|
origin: "VisualStim._estimateBoundingBox",
|
|
context: `when estimating the bounding box of visual stimulus: ${this._name}`,
|
|
error: "this method is abstract and should not be called.",
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Get the bounding box in pixel coordinates
|
|
*
|
|
* @name module:visual.VisualStim#contains
|
|
* @function
|
|
* @protected
|
|
* @returns {PIXI.Rectangle} the bounding box, in pixel coordinates
|
|
*/
|
|
_getBoundingBox_px()
|
|
{
|
|
if (this._units === "pix")
|
|
{
|
|
return this._boundingBox.clone();
|
|
}
|
|
else if (this._units === "norm")
|
|
{
|
|
return new PIXI.Rectangle(
|
|
this._boundingBox.x * this._win.size[0] / 2,
|
|
this._boundingBox.y * this._win.size[1] / 2,
|
|
this._boundingBox.width * this._win.size[0] / 2,
|
|
this._boundingBox.height * this._win.size[1] / 2,
|
|
);
|
|
}
|
|
else if (this._units === "height")
|
|
{
|
|
const minSize = Math.min(this._win.size[0], this._win.size[1]);
|
|
return new PIXI.Rectangle(
|
|
this._boundingBox.x * minSize,
|
|
this._boundingBox.y * minSize,
|
|
this._boundingBox.width * minSize,
|
|
this._boundingBox.height * minSize,
|
|
);
|
|
}
|
|
else
|
|
{
|
|
throw Object.assign(response, { error: `unknown units: ${this._units}` });
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate a callback that prepares updates to the stimulus.
|
|
* This is typically called in the constructor of a stimulus, when attributes are added
|
|
* with _addAttribute.
|
|
*
|
|
* @name module:visual.VisualStim#_onChange
|
|
* @function
|
|
* @protected
|
|
* @param {boolean} [withPixi = false] - whether or not the PIXI representation must
|
|
* also be updated
|
|
* @param {boolean} [withBoundingBox = false] - whether or not to immediately estimate
|
|
* the bounding box
|
|
* @return {Function}
|
|
*/
|
|
_onChange(withPixi = false, withBoundingBox = false)
|
|
{
|
|
return () =>
|
|
{
|
|
this._needUpdate = true;
|
|
if (withPixi)
|
|
{
|
|
this._needPixiUpdate = true;
|
|
}
|
|
if (withBoundingBox)
|
|
{
|
|
this._estimateBoundingBox();
|
|
}
|
|
};
|
|
}
|
|
}
|
|
</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="FaceDetector_FaceDetector.html">FaceDetector</a></li><li><a href="module.data.MultiStairHandler.html">MultiStairHandler</a></li><li><a href="module.data.QuestHandler.html">QuestHandler</a></li><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.MultiStairHandler.html">MultiStairHandler</a></li><li><a href="module-data.QuestHandler.html">QuestHandler</a></li><li><a href="module-data.Shelf.html">Shelf</a></li><li><a href="module-data.TrialHandler.html">TrialHandler</a></li><li><a href="module-sound.AudioClip.html">AudioClip</a></li><li><a href="module-sound.AudioClipPlayer.html">AudioClipPlayer</a></li><li><a href="module-sound.Microphone.html">Microphone</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-sound.Transcriber.html">Transcriber</a></li><li><a href="module-sound.Transcript.html">Transcript</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.ButtonStim.html">ButtonStim</a></li><li><a href="module-visual.Camera.html">Camera</a></li><li><a href="module-visual.FaceDetector.html">FaceDetector</a></li><li><a href="module-visual.Form.html">Form</a></li><li><a href="module-visual.GratingStim.html">GratingStim</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></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.7</a> on Mon May 23 2022 12:29:28 GMT+0200 (Central European Summer Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|