Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-07 10:02:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update API examples to use "vircadia" in mapping names

Browse source
This commit is contained in:
David Rowe 2021-12-04 21:37:33 +13:00
parent b7734e32d0
commit 022dea7a58
5 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
interface/src/SpeechRecognizer.h
View file

@ -82,7 +82,7 @@ signals:
* return turnRate;
* }
*
* var MAPPING_NAME = "com.highfidelity.controllers.example.speechRecognizer";
* var MAPPING_NAME = "com.vircadia.controllers.example.speechRecognizer";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* mapping.from(getTurnRate).to(Controller.Actions.Yaw);

6
libraries/controllers/src/controllers/ScriptingInterface.h
View file

@ -276,7 +276,7 @@ namespace controller {
* by {@link Uuid(0).generate|Uuid.generate} is used.
* @returns {MappingObject} A controller mapping object.
* @example <caption>Create a simple mapping that makes the right trigger move your avatar up.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* mapping.from(Controller.Standard.RT).to(Controller.Actions.TranslateY);
@ -311,7 +311,7 @@ namespace controller {
* @returns {MappingObject} A controller mapping object.
* @example <caption>Create a simple mapping that makes the right trigger move your avatar up.</caption>
* var mappingJSON = {
* "name": "com.highfidelity.controllers.example.jsonMapping",
* "name": "com.vircadia.controllers.example.jsonMapping",
* "channels": [
* { "from": "Standard.RT", "to": "Actions.TranslateY" }
* ]
@ -463,7 +463,7 @@ namespace controller {
* {@link Controller.Hardware|Controller.Hardware.Keyboard} outputs.
* @function Controller.captureMouseEvents
* @example <caption>Disable Controller.Hardware.Keyboard mouse events for a short period.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Hardware.Keyboard.MouseX).to(function (x) {
* print("Mouse x = " + x);

4
libraries/controllers/src/controllers/impl/MappingBuilderProxy.h
View file

@ -71,7 +71,7 @@ class UserInputMapper;
* @property {Controller.MappingJSONRoute[]} channels - An array of routes.
* @example <caption>A simple mapping JSON that makes the right trigger move your avatar up after a dead zone.</caption>
* {
* "name": "com.highfidelity.controllers.example.jsonMapping",
* "name": "com.vircadia.controllers.example.jsonMapping",
* "channels": [
* {
* "from": "Standard.RT",
@ -176,7 +176,7 @@ public:
* @returns {RouteObject} A route ready for mapping to an action or function using {@link RouteObject} methods. The data
* value passed to the route is the combined value of <code>source2 - source1</code>.
* @example <caption>Make the Oculus Touch triggers move your avatar up and down.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping
* .makeAxis(Controller.Hardware.OculusTouch.LT, Controller.Hardware.OculusTouch.RT)

26
libraries/controllers/src/controllers/impl/RouteBuilderProxy.h
View file

@ -90,7 +90,7 @@ class RouteBuilderProxy : public QObject {
* an in-line function definition.
*
* @example <caption>Make the right trigger move your avatar up.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* mapping.from(Controller.Standard.RT).to(Controller.Actions.TranslateY);
@ -105,7 +105,7 @@ class RouteBuilderProxy : public QObject {
* print("Trigger value: " + value);
* }
*
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* mapping.from(Controller.Standard.RT).to(onRightTrigger);
@ -124,7 +124,7 @@ class RouteBuilderProxy : public QObject {
* otherwise it is disabled.
* @returns {RouteObject} The <code>RouteObject</code> with debug output enabled or disabled.
* @example <caption>Write debug information to the program log for a right trigger mapping.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* mapping.from(Controller.Standard.RT).debug().to(function (value) {
@ -175,7 +175,7 @@ class RouteBuilderProxy : public QObject {
* calls.</p>
* @returns {RouteObject} The <code>RouteObject</code> with the condition added.
* @example <caption>Process the right trigger differently in HMD and desktop modes.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* // Processed only if in HMD mode.
@ -203,7 +203,7 @@ class RouteBuilderProxy : public QObject {
* @param {number} max - The maximum value to pass through.
* @returns {RouteObject} The route object with the clamp filter added.
* @example <caption>Clamp right trigger values to between 0.3 and 0.7.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.RT).clamp(0.3, 0.7).to(function (value) {
* print("Value: " + value);
@ -225,7 +225,7 @@ class RouteBuilderProxy : public QObject {
* @param {number} max - When the input value rises above this value the output value changes to <code>1</code>.
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Round the right joystick forward/back values to 0 or 1 with hysteresis.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.RY).peek().to(function (value) {
* print("Raw value: " + value); // 0.0 - 1.0.
@ -247,7 +247,7 @@ class RouteBuilderProxy : public QObject {
* @param {number} interval - The interval between sending values, in seconds.
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Send right trigger values every half second.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.RT).pulse(0.5).to(function (value) {
* print("Value: " + value);
@ -266,7 +266,7 @@ class RouteBuilderProxy : public QObject {
* @param {number} multiplier - The scale to multiply the value by.
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Scale the value of the right joystick forward/back values by 10.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.LY).to(function (value) {
* print("L value: " + value); // -1.0 to 1.0 values.
@ -288,7 +288,7 @@ class RouteBuilderProxy : public QObject {
* @function RouteObject#invert
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Invert the value of the right joystick forward/back values.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.LY).to(function (value) {
* print("L value: " + value); // -1.0 to 1.0 values, forward to back.
@ -313,7 +313,7 @@ class RouteBuilderProxy : public QObject {
* negative of this value is used.
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Apply a dead-zone to the right joystick forward/back values.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.RY).deadZone(0.2).to(function (value) {
* print("Value: " + value); // 0.0 - 1.0 values once outside the dead-zone.
@ -334,7 +334,7 @@ class RouteBuilderProxy : public QObject {
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Round the right joystick forward/back values to <code>-1</code>, <code>0</code>, or
* <code>1</code>.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.RY).constrainToInteger().to(function (value) {
* print("Value: " + value); // -1, 0, or 1
@ -353,7 +353,7 @@ class RouteBuilderProxy : public QObject {
* @function RouteObject#constrainToPositiveInteger
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Round the right joystick forward/back values to <code>0</code> or <code>1</code>.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
* mapping.from(Controller.Standard.RY).constrainToPositiveInteger().to(function (value) {
* print("Value: " + value); // 0, or 1
@ -436,7 +436,7 @@ class RouteBuilderProxy : public QObject {
* @function RouteObject#logicalNot
* @returns {RouteObject} The <code>RouteObject</code> with the filter applied.
* @example <caption>Logical NOT of LSTouch value.</caption>
* var MAPPING_NAME = "com.highfidelity.controllers.example.newMapping";
* var MAPPING_NAME = "com.vircadia.controllers.example.newMapping";
* var mapping = Controller.newMapping(MAPPING_NAME);
*
* mapping.from(Controller.Standard.RSTouch).peek().to(function (value) {

8
libraries/networking/src/MessagesClient.h
View file

@ -64,7 +64,7 @@ public:
* from an assignment client script it is received only by that same assignment client script.</p>
* @example <caption>Send and receive a message.</caption>
* // Receiving script.
* var channelName = "com.highfidelity.example.messages-example";
* var channelName = "com.vircadia.example.messages-example";
*
* function onMessageReceived(channel, message, sender, localOnly) {
* print("Message received:");
@ -84,7 +84,7 @@ public:
*
*
* // Sending script.
* var channelName = "com.highfidelity.example.messages-example";
* var channelName = "com.vircadia.example.messages-example";
* var message = "Hello";
* Messages.sendMessage(channelName, message);
*/
@ -112,7 +112,7 @@ public:
* from an assignment client script it is received only by that same assignment client script.</p>
* @example <caption>Send and receive data.</caption>
* // Receiving script.
* var channelName = "com.highfidelity.example.messages-example";
* var channelName = "com.vircadia.example.messages-example";
*
* function onDataReceived(channel, data, sender, localOnly) {
* var int8data = new Int8Array(data);
@ -140,7 +140,7 @@ public:
*
*
* // Sending script.
* var channelName = "com.highfidelity.example.messages-example";
* var channelName = "com.vircadia.example.messages-example";
* var int8data = new Int8Array([1, 1, 2, 3, 5, 8, 13]);
* Messages.sendData(channelName, int8data.buffer);
*/