mirror of
https://github.com/psychopy/psychojs.git
synced 2025-05-10 10:40:54 +00:00
195 lines
7.1 KiB
HTML
195 lines
7.1 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 2020.1
|
|
* @copyright (c) 2020 Ilixa Ltd. ({@link http://ilixa.com})
|
|
* @license Distributed under the terms of the MIT License
|
|
*/
|
|
|
|
|
|
import {MinimalStim} from '../core/MinimalStim';
|
|
import {WindowMixin} from '../core/WindowMixin';
|
|
import * as util from '../util/Util';
|
|
|
|
|
|
/**
|
|
* 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 {Window} options.win - the associated Window
|
|
* @param {string} [options.units= "norm"] - 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 {Array.<number>} [options.pos= [0, 0]] - the position of the center of the stimulus
|
|
* @param {number} [options.size= 1.0] - the size
|
|
* @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 = 0.0,
|
|
opacity = 1.0,
|
|
pos = [0, 0],
|
|
size,
|
|
autoDraw,
|
|
autoLog
|
|
} = {})
|
|
{
|
|
super({win, name, autoDraw, autoLog});
|
|
|
|
this._addAttributes(VisualStim, units, ori, opacity, pos, size);
|
|
|
|
this._needUpdate = true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Force a refresh of the stimulus.
|
|
*
|
|
* @name module:visual.VisualStim#refresh
|
|
* @public
|
|
*/
|
|
refresh()
|
|
{
|
|
this._needUpdate = true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Setter for the size attribute.
|
|
*
|
|
* @name module:visual.VisualStim#setSize
|
|
* @public
|
|
* @param {number | number[]} size - the stimulus size
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setSize(size, log = false)
|
|
{
|
|
// size is either undefined or a tuple of numbers:
|
|
if (typeof size !== 'undefined') {
|
|
size = util.toNumerical(size);
|
|
if (!Array.isArray(size))
|
|
size = [size, size];
|
|
}
|
|
|
|
this._setAttribute('size', size, log);
|
|
|
|
this._needUpdate = 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)
|
|
{
|
|
this._setAttribute('ori', ori, log);
|
|
|
|
let radians = ori * 0.017453292519943295;
|
|
this._rotationMatrix = [[Math.cos(radians), -Math.sin(radians)],
|
|
[Math.sin(radians), Math.cos(radians)]];
|
|
|
|
//this._needVertexUpdate = true ; // need to update update vertices
|
|
this._needUpdate = 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)
|
|
{
|
|
this._setAttribute('pos', util.toNumerical(pos), log);
|
|
|
|
this._needUpdate = true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Setter for the opacity attribute.
|
|
*
|
|
* @name module:visual.VisualStim#setOpacity
|
|
* @public
|
|
* @param {number} opacity - the opacity: 0 is completely transparent, 1 is fully opaque
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setOpacity(opacity, log = false)
|
|
{
|
|
this._setAttribute('opacity', opacity, log);
|
|
|
|
this._needUpdate = true;
|
|
}
|
|
|
|
}
|
|
</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.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.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.3</a> on Fri Feb 14 2020 08:15:34 GMT+0100 (Central European Standard Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|