mirror of
https://github.com/psychopy/psychojs.git
synced 2025-05-10 10:40:54 +00:00
174 lines
7.8 KiB
HTML
174 lines
7.8 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: visual/Rect.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/Rect.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Rectangular Stimulus.
|
|
*
|
|
* @author Alain Pitiot
|
|
* @version 3.0.0b11
|
|
* @copyright (c) 2018 Ilixa Ltd. ({@link http://ilixa.com})
|
|
* @license Distributed under the terms of the MIT License
|
|
*/
|
|
|
|
|
|
import { ShapeStim } from './ShapeStim';
|
|
import { Color } from '../util/Color';
|
|
|
|
|
|
/**
|
|
* <p>Rectangular visual stimulus.</p>
|
|
*
|
|
* @name module:visual.Rect
|
|
* @class
|
|
* @extends ShapeStim
|
|
* @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= 1.5] - the line width
|
|
* @param {Color} [options.lineColor= Color('white')] the line color
|
|
* @param {Color} options.fillColor - the fill color
|
|
* @param {number} [options.opacity= 1.0] - the opacity
|
|
* @param {number} [options.width= 0.5] - the width of the rectangle
|
|
* @param {number} [options.height= 0.5] - the height of the rectangle
|
|
* @param {Array.<number>} [options.pos= [0, 0]] - the position
|
|
* @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 Rect extends ShapeStim {
|
|
constructor({
|
|
name,
|
|
win,
|
|
lineWidth = 1.5,
|
|
lineColor = new Color('white'),
|
|
fillColor,
|
|
opacity = 1.0,
|
|
width = 0.5,
|
|
height = 0.5,
|
|
pos = [0, 0],
|
|
size = 1.0,
|
|
ori = 0.0,
|
|
units,
|
|
contrast = 1.0,
|
|
depth = 0,
|
|
interpolate = true,
|
|
autoDraw,
|
|
autoLog
|
|
} = {}) {
|
|
super({ name, win, lineWidth, lineColor, fillColor, opacity, pos, ori, size, units, contrast, depth, interpolate, autoDraw, autoLog });
|
|
|
|
this._psychoJS.logger.debug('create a new Rect with name: ', name);
|
|
|
|
this._addAttributes(Rect, width, height);
|
|
|
|
this._updateVertices();
|
|
|
|
/*if (autoLog)
|
|
logging.exp("Created %s = %s" % (self.name, str(self)));*/
|
|
}
|
|
|
|
|
|
/**
|
|
* Setter for the width attribute.
|
|
*
|
|
* @name module:visual.Rect#setWidth
|
|
* @public
|
|
* @param {number} width - the rectange width
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setWidth(width, log = false) {
|
|
this._psychoJS.logger.debug('set the width of Rect: ', this.name, 'to: ', width);
|
|
|
|
this._setAttribute('width', width, log);
|
|
this._updateVertices();
|
|
}
|
|
|
|
|
|
/**
|
|
* Setter for the height attribute.
|
|
*
|
|
* @name module:visual.Rect#setHeight
|
|
* @public
|
|
* @param {number} height - the rectange height
|
|
* @param {boolean} [log= false] - whether of not to log
|
|
*/
|
|
setHeight(height, log = false) {
|
|
this._psychoJS.logger.debug('set the height of Rect: ', this.name, 'to: ', height);
|
|
|
|
this._setAttribute('height', height, log);
|
|
this._updateVertices();
|
|
}
|
|
|
|
|
|
/**
|
|
* Update the base shape vertices.
|
|
*
|
|
* @name module:visual.Rect#_updateVertices
|
|
* @private
|
|
*/
|
|
_updateVertices() {
|
|
this._psychoJS.logger.debug('update the vertices of Rect: ', this.name);
|
|
|
|
this.setVertices([
|
|
[-this._width / 2.0, -this._height / 2.0],
|
|
[this._width / 2.0, -this._height / 2.0],
|
|
[this._width / 2.0, this._height / 2.0],
|
|
[-this._width / 2.0, this._height / 2.0]
|
|
]);
|
|
}
|
|
|
|
}
|
|
</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.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.Logger.html">Logger</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.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>Mixins</h3><ul><li><a href="module-core.WindowMixin.html">WindowMixin</a></li><li><a href="module-util.ColorMixin.html">ColorMixin</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-sound.SoundPlayer.html">SoundPlayer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addInfoFromUrl">addInfoFromUrl</a></li><li><a href="global.html#detectBrowser">detectBrowser</a></li><li><a href="global.html#flattenArray">flattenArray</a></li><li><a href="global.html#getDateStr">getDateStr</a></li><li><a href="global.html#getErrorStack">getErrorStack</a></li><li><a href="global.html#getPositionFromObject">getPositionFromObject</a></li><li><a href="global.html#getUrlParameters">getUrlParameters</a></li><li><a href="global.html#isEmpty">isEmpty</a></li><li><a href="global.html#isInt">isInt</a></li><li><a href="global.html#IsPointInsidePolygon">IsPointInsidePolygon</a></li><li><a href="global.html#makeUuid">makeUuid</a></li><li><a href="global.html#mix">mix</a></li><li><a href="global.html#promiseToTupple">promiseToTupple</a></li><li><a href="global.html#selectFromArray">selectFromArray</a></li><li><a href="global.html#shuffle">shuffle</a></li><li><a href="global.html#sliceArray">sliceArray</a></li><li><a href="global.html#to_pixiPoint">to_pixiPoint</a></li><li><a href="global.html#to_px">to_px</a></li><li><a href="global.html#toNumerical">toNumerical</a></li><li><a href="global.html#toString">toString</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 28 2018 12:51:38 GMT+0100 (CET)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|