Files
JiboOs/docs/bt/behaviors/LookAt.js
2026-03-16 13:53:01 +02:00

23 lines
1.4 KiB
JavaScript

/**
* @class Point3D
* @memberof jibo.bt.behaviors.LookAt
* @description Defines a point in 3D space.
* @prop {number} x The forward-facing vector in Jibo's coordinate frame (meters).
* @prop {number} y The left-facing vector in Jibo's coordinate frame (meters).
* @prop {number} z The up-facing vector in Jibo's coordinate frame (meters).
*/
/**
* @class LookAt
* @extends jibo.bt.Behavior
* @memberof jibo.bt.behaviors
* @description Makes Jibo look at a 3D point in space.
* `LookAt` has two modes. In single-shot mode, this behavior makes Jibo look at the 3D point returned
* by `getTarget` and succeeds when Jibo reaches his this target. In continuous mode, `getTarget` is
* called every frame, and this behavior will remain in progress indefinitely until explicitly stopped by a
* parent bahevior or a decorator.
* @param {Object} options See {@link jibo.bt.Behavior|Behavior} for all options.
* @param {Function} options.getTarget Returns a {@link jibo.bt.behaviors.LookAt.Point3D} object.
* @param {boolean} [options.isContinuous=false] `true` if this behavior is in continous-mode. `false` if in single-shot look-at.
* @param {Function} options.config Called and passed a {@link LookatBuilder} object for configuration purposes. Do not call {@link LookatBuilder#startLookat}. This is called automatically by the behavior.
*/