mirror of
https://github.com/lubosz/overte.git
synced 2025-04-08 04:42:20 +02:00
Merge branch 'master' into avatarSitAPI
This commit is contained in:
luiscuenca
commit
e7e864121f
39 changed files with 1649 additions and 952 deletions
|
|
@ -204,10 +204,8 @@ void AvatarMixerClientData::processSetTraitsMessage(ReceivedMessage& message,
|
|||
if (traitType == AvatarTraits::SkeletonModelURL) {
|
||||
// special handling for skeleton model URL, since we need to make sure it is in the whitelist
|
||||
checkSkeletonURLAgainstWhitelist(slaveSharedData, sendingNode, packetTraitVersion);
|
||||
#ifdef AVATAR_POP_CHECK
|
||||
// Deferred for UX work. With no PoP check, no need to get the .fst.
|
||||
_avatar->fetchAvatarFST();
|
||||
#endif
|
||||
}
|
||||
|
||||
anyTraitsChanged = true;
|
||||
|
|
|
|||
Binary file not shown.
BIN
interface/resources/avatar/animations/emote_clap01_all.fbx
Normal file
BIN
interface/resources/avatar/animations/emote_clap01_all.fbx
Normal file
Binary file not shown.
Binary file not shown.
BIN
interface/resources/avatar/animations/emote_point01_all.fbx
Normal file
BIN
interface/resources/avatar/animations/emote_point01_all.fbx
Normal file
Binary file not shown.
BIN
interface/resources/avatar/animations/emote_raisehand01_all.fbx
Normal file
BIN
interface/resources/avatar/animations/emote_raisehand01_all.fbx
Normal file
Binary file not shown.
File diff suppressed because it is too large
Load diff
|
|
@ -5,4 +5,6 @@ Text {
|
|||
style: Text.Outline;
|
||||
styleColor: "black";
|
||||
font.pixelSize: 12;
|
||||
font.bold: true;
|
||||
font.family: "monospace";
|
||||
}
|
||||
|
|
|
|||
|
|
@ -179,6 +179,18 @@ void AvatarBookmarks::updateAvatarEntities(const QVariantList &avatarEntities) {
|
|||
}
|
||||
}
|
||||
|
||||
/**jsdoc
|
||||
* Details of an avatar bookmark.
|
||||
* @typedef {object} AvatarBookmarks.BookmarkData
|
||||
* @property {number} version - The version of the bookmark data format.
|
||||
* @property {string} avatarUrl - The URL of the avatar model.
|
||||
* @property {number} avatarScale - The target scale of the avatar.
|
||||
* @property {Array<Object<"properties",Entities.EntityProperties>>} [avatarEntites] - The avatar entities included with the
|
||||
* bookmark.
|
||||
* @property {MyAvatar.AttachmentData[]} [attachments] - The attachments included with the bookmark.
|
||||
* <p class="important">Deprecated: Use avatar entities instead.
|
||||
*/
|
||||
|
||||
void AvatarBookmarks::loadBookmark(const QString& bookmarkName) {
|
||||
if (QThread::currentThread() != thread()) {
|
||||
BLOCKING_INVOKE_METHOD(this, "loadBookmark", Q_ARG(QString, bookmarkName));
|
||||
|
|
|
|||
|
|
@ -16,7 +16,9 @@
|
|||
#include "Bookmarks.h"
|
||||
|
||||
/**jsdoc
|
||||
* This API helps manage adding and deleting avatar bookmarks.
|
||||
* The <code>AvatarBookmarks</code> API provides facilities for working with avatar bookmarks ("favorites" in the Avatar app).
|
||||
* An avatar bookmark associates a name with an avatar model, scale, and avatar entities (wearables).
|
||||
*
|
||||
* @namespace AvatarBookmarks
|
||||
*
|
||||
* @hifi-interface
|
||||
|
|
@ -32,41 +34,100 @@ class AvatarBookmarks: public Bookmarks, public Dependency {
|
|||
public:
|
||||
AvatarBookmarks();
|
||||
void setupMenus(Menu* menubar, MenuWrapper* menu) override {};
|
||||
|
||||
/**jsdoc
|
||||
* Gets the details of an avatar bookmark.
|
||||
* @function AvatarBookmarks.getBookmark
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark (case sensitive).
|
||||
* @returns {AvatarBookmarks.BookmarkData|{}} The bookmark data if the bookmark exists, <code>{}</code> if it doesn't.
|
||||
*/
|
||||
Q_INVOKABLE QVariantMap getBookmark(const QString& bookmarkName);
|
||||
|
||||
public slots:
|
||||
/**jsdoc
|
||||
* Add the current Avatar to your avatar bookmarks.
|
||||
* @function AvatarBookmarks.addBookMark
|
||||
* Adds a new (or updates an existing) avatar bookmark with your current avatar model, scale, and avatar entities.
|
||||
* @function AvatarBookmarks.addBookmark
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark (case sensitive).
|
||||
* @example <caption>Add a new avatar bookmark and report the bookmark data.</caption>
|
||||
* var bookmarkName = "New Bookmark";
|
||||
* AvatarBookmarks.addBookmark(bookmarkName);
|
||||
* var bookmarkData = AvatarBookmarks.getBookmark(bookmarkName);
|
||||
* print("Bookmark data: " + JSON.stringify(bookmarkData));
|
||||
*/
|
||||
void addBookmark(const QString& bookmarkName);
|
||||
|
||||
/**jsdoc
|
||||
* Updates an existing bookmark with your current avatar model, scale, and wearables. No action is taken if the bookmark
|
||||
* doesn't exist.
|
||||
* @function AvatarBookmarks.saveBookmark
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark (case sensitive).
|
||||
*/
|
||||
void saveBookmark(const QString& bookmarkName);
|
||||
|
||||
/**jsdoc
|
||||
* Loads an avatar bookmark, setting your avatar model, scale, and avatar entities (or attachments if an old bookmark) to
|
||||
* those in the bookmark.
|
||||
* @function AvatarBookmarks.loadBookmark
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark to load (case sensitive).
|
||||
*/
|
||||
void loadBookmark(const QString& bookmarkName);
|
||||
|
||||
/**jsdoc
|
||||
* Deletes an avatar bookmark.
|
||||
* @function AvatarBookmarks.removeBookmark
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark to delete (case sensitive).
|
||||
*/
|
||||
void removeBookmark(const QString& bookmarkName);
|
||||
|
||||
/**jsdoc
|
||||
* Updates the avatar entities and their properties. Current avatar entities not included in the list provided are deleted.
|
||||
* @function AvatarBookmarks.updateAvatarEntities
|
||||
* @param {MyAvatar.AvatarEntityData[]} avatarEntities - The avatar entity IDs and properties.
|
||||
* @deprecated This function is deprecated and will be removed. Use the {@link MyAvatar} API instead.
|
||||
*/
|
||||
void updateAvatarEntities(const QVariantList& avatarEntities);
|
||||
|
||||
/**jsdoc
|
||||
* Gets the details of all avatar bookmarks.
|
||||
* @function AvatarBookmarks.getBookmarks
|
||||
* @returns {Object<string,AvatarBookmarks.BookmarkData>} The current avatar bookmarks in an object where the keys are the
|
||||
* bookmark names and the values are the bookmark details.
|
||||
* @example <caption>List the names and URLs of all the avatar bookmarks.</caption>
|
||||
* var bookmarks = AvatarBookmarks.getBookmarks();
|
||||
* print("Avatar bookmarks:");
|
||||
* for (var key in bookmarks) {
|
||||
* print("- " + key + " " + bookmarks[key].avatarUrl);
|
||||
* };
|
||||
*/
|
||||
QVariantMap getBookmarks() { return _bookmarks; }
|
||||
|
||||
signals:
|
||||
/**jsdoc
|
||||
* This function gets triggered after avatar loaded from bookmark
|
||||
* Triggered when an avatar bookmark is loaded, setting your avatar model, scale, and avatar entities (or attachments if an
|
||||
* old bookmark) to those in the bookmark.
|
||||
* @function AvatarBookmarks.bookmarkLoaded
|
||||
* @param {string} bookmarkName
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark loaded.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void bookmarkLoaded(const QString& bookmarkName);
|
||||
|
||||
/**jsdoc
|
||||
* This function gets triggered after avatar bookmark deleted
|
||||
* Triggered when an avatar bookmark is deleted.
|
||||
* @function AvatarBookmarks.bookmarkDeleted
|
||||
* @param {string} bookmarkName
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark deleted.
|
||||
* @returns {Signal}
|
||||
* @example <caption>Report when a bookmark is deleted.</caption>
|
||||
* AvatarBookmarks.bookmarkDeleted.connect(function (bookmarkName) {
|
||||
* print("Bookmark deleted: " + bookmarkName);
|
||||
* });
|
||||
*/
|
||||
void bookmarkDeleted(const QString& bookmarkName);
|
||||
|
||||
/**jsdoc
|
||||
* This function gets triggered after avatar bookmark added
|
||||
* Triggered when a new avatar bookmark is added or an existing avatar bookmark is updated, using
|
||||
* {@link AvatarBookmarks.addBookmark|addBookmark}.
|
||||
* @function AvatarBookmarks.bookmarkAdded
|
||||
* @param {string} bookmarkName
|
||||
* @param {string} bookmarkName - The name of the avatar bookmark added or updated.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void bookmarkAdded(const QString& bookmarkName);
|
||||
|
|
@ -77,6 +138,11 @@ protected:
|
|||
QVariantMap getAvatarDataToBookmark();
|
||||
|
||||
protected slots:
|
||||
/**jsdoc
|
||||
* Performs no action.
|
||||
* @function AvatarBookmarks.deleteBookmark
|
||||
* @deprecated This function is deprecated and will be removed.
|
||||
*/
|
||||
void deleteBookmark() override;
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -52,6 +52,7 @@ protected:
|
|||
|
||||
protected slots:
|
||||
/**jsdoc
|
||||
* Prompts the user to delete a bookmark. The user can select the bookmark to delete in the dialog that is opened.
|
||||
* @function LocationBookmarks.deleteBookmark
|
||||
*/
|
||||
virtual void deleteBookmark();
|
||||
|
|
|
|||
|
|
@ -17,6 +17,9 @@
|
|||
#include "Bookmarks.h"
|
||||
|
||||
/**jsdoc
|
||||
* The <code>LocationBookmarks</code> API provides facilities for working with location bookmarks. A location bookmark
|
||||
* associates a name with a metaverse address.
|
||||
*
|
||||
* @namespace LocationBookmarks
|
||||
*
|
||||
* @hifi-client-entity
|
||||
|
|
@ -35,28 +38,35 @@ public:
|
|||
static const QString HOME_BOOKMARK;
|
||||
|
||||
/**jsdoc
|
||||
* Gets the metaverse address associated with a bookmark.
|
||||
* @function LocationBookmarks.getAddress
|
||||
* @param {string} bookmarkName Name of the bookmark to get the address for.
|
||||
* @returns {string} The url for the specified bookmark. If the bookmark does not exist, the empty string will be returned.
|
||||
* @param {string} bookmarkName - Name of the bookmark to get the metaverse address for (case sensitive).
|
||||
* @returns {string} The metaverse address for the bookmark. If the bookmark does not exist, <code>""</code> is returned.
|
||||
* @example <caption>Report the "Home" bookmark's metaverse address.</caption>
|
||||
* print("Home bookmark's address: " + LocationBookmarks.getAddress("Home"));
|
||||
*/
|
||||
Q_INVOKABLE QString getAddress(const QString& bookmarkName);
|
||||
|
||||
public slots:
|
||||
|
||||
/**jsdoc
|
||||
* Prompts the user to bookmark their current location. The user can specify the name of the bookmark in the dialog that is
|
||||
* opened.
|
||||
* @function LocationBookmarks.addBookmark
|
||||
*/
|
||||
void addBookmark();
|
||||
|
||||
/**jsdoc
|
||||
* Sets the metaverse address associated with the "Home" bookmark.
|
||||
* @function LocationBookmarks.setHomeLocationToAddress
|
||||
* @param {string} address
|
||||
* @param {string} address - The metaverse address to set the "Home" bookmark to.
|
||||
*/
|
||||
void setHomeLocationToAddress(const QVariant& address);
|
||||
|
||||
/**jsdoc
|
||||
* Gets the metaverse address associated with the "Home" bookmark.
|
||||
* @function LocationBookmarks.getHomeLocationAddress
|
||||
* @returns {string} The url for the home location bookmark
|
||||
* @returns {string} The metaverse address for the "Home" bookmark.
|
||||
*/
|
||||
QString getHomeLocationAddress();
|
||||
|
||||
|
|
|
|||
|
|
@ -238,7 +238,7 @@ public:
|
|||
* @function AvatarManager.getPalData
|
||||
* @param {string[]} [avatarIDs=[]] - The IDs of the avatars to get the PAL data for. If empty, then PAL data is obtained
|
||||
* for all avatars.
|
||||
* @returns {object<"data", AvatarManager.PalData[]>} An array of objects, each object being the PAL data for an avatar.
|
||||
* @returns {Object<"data", AvatarManager.PalData[]>} An array of objects, each object being the PAL data for an avatar.
|
||||
* @example <caption>Report the PAL data for an avatar nearby.</caption>
|
||||
* var palData = AvatarManager.getPalData();
|
||||
* print("PAL data for one avatar: " + JSON.stringify(palData.data[0]));
|
||||
|
|
|
|||
|
|
@ -125,6 +125,18 @@ QString userRecenterModelToString(MyAvatar::SitStandModelType model) {
|
|||
}
|
||||
}
|
||||
|
||||
static const QStringList REACTION_NAMES = {
|
||||
QString("positive"),
|
||||
QString("negative"),
|
||||
QString("raiseHand"),
|
||||
QString("applaud"),
|
||||
QString("point")
|
||||
};
|
||||
|
||||
static int reactionNameToIndex(const QString& reactionName) {
|
||||
return REACTION_NAMES.indexOf(reactionName);
|
||||
}
|
||||
|
||||
MyAvatar::MyAvatar(QThread* thread) :
|
||||
Avatar(thread),
|
||||
_yawSpeed(YAW_SPEED_DEFAULT),
|
||||
|
|
@ -2751,19 +2763,23 @@ QString MyAvatar::getScriptedMotorMode() const {
|
|||
}
|
||||
|
||||
void MyAvatar::setScriptedMotorVelocity(const glm::vec3& velocity) {
|
||||
float MAX_SCRIPTED_MOTOR_SPEED = 500.0f;
|
||||
_scriptedMotorVelocity = velocity;
|
||||
float speed = glm::length(_scriptedMotorVelocity);
|
||||
if (speed > MAX_SCRIPTED_MOTOR_SPEED) {
|
||||
_scriptedMotorVelocity *= MAX_SCRIPTED_MOTOR_SPEED / speed;
|
||||
float newSpeed = glm::length(velocity);
|
||||
if (!glm::isnan(newSpeed)) {
|
||||
_scriptedMotorVelocity = velocity;
|
||||
constexpr float MAX_SCRIPTED_MOTOR_SPEED = 500.0f;
|
||||
if (newSpeed > MAX_SCRIPTED_MOTOR_SPEED) {
|
||||
_scriptedMotorVelocity *= MAX_SCRIPTED_MOTOR_SPEED / newSpeed;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void MyAvatar::setScriptedMotorTimescale(float timescale) {
|
||||
// we clamp the timescale on the large side (instead of just the low side) to prevent
|
||||
// obnoxiously large values from introducing NaN into avatar's velocity
|
||||
_scriptedMotorTimescale = glm::clamp(timescale, MIN_SCRIPTED_MOTOR_TIMESCALE,
|
||||
DEFAULT_SCRIPTED_MOTOR_TIMESCALE);
|
||||
if (!glm::isnan(timescale)) {
|
||||
// we clamp the timescale on the large side (instead of just the low side) to prevent
|
||||
// obnoxiously large values from introducing NaN into avatar's velocity
|
||||
_scriptedMotorTimescale = glm::clamp(timescale, MIN_SCRIPTED_MOTOR_TIMESCALE,
|
||||
DEFAULT_SCRIPTED_MOTOR_TIMESCALE);
|
||||
}
|
||||
}
|
||||
|
||||
void MyAvatar::setScriptedMotorFrame(QString frame) {
|
||||
|
|
@ -5808,6 +5824,53 @@ void MyAvatar::setModelScale(float scale) {
|
|||
}
|
||||
}
|
||||
|
||||
QStringList MyAvatar::getReactions() const {
|
||||
return REACTION_NAMES;
|
||||
}
|
||||
|
||||
bool MyAvatar::triggerReaction(QString reactionName) {
|
||||
int reactionIndex = reactionNameToIndex(reactionName);
|
||||
if (reactionIndex >= 0 && reactionIndex < (int)NUM_AVATAR_REACTIONS) {
|
||||
std::lock_guard<std::mutex> guard(_reactionLock);
|
||||
_reactionTriggers[reactionIndex] = true;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
bool MyAvatar::beginReaction(QString reactionName) {
|
||||
int reactionIndex = reactionNameToIndex(reactionName);
|
||||
if (reactionIndex >= 0 && reactionIndex < (int)NUM_AVATAR_REACTIONS) {
|
||||
std::lock_guard<std::mutex> guard(_reactionLock);
|
||||
_reactionEnabledRefCounts[reactionIndex]++;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
bool MyAvatar::endReaction(QString reactionName) {
|
||||
int reactionIndex = reactionNameToIndex(reactionName);
|
||||
if (reactionIndex >= 0 && reactionIndex < (int)NUM_AVATAR_REACTIONS) {
|
||||
std::lock_guard<std::mutex> guard(_reactionLock);
|
||||
_reactionEnabledRefCounts[reactionIndex]--;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void MyAvatar::updateRigControllerParameters(Rig::ControllerParameters& params) {
|
||||
std::lock_guard<std::mutex> guard(_reactionLock);
|
||||
for (int i = 0; i < NUM_AVATAR_REACTIONS; i++) {
|
||||
|
||||
// copy current state into params.
|
||||
params.reactionEnabledFlags[i] = _reactionEnabledRefCounts[i] > 0;
|
||||
params.reactionTriggers[i] = _reactionTriggers[i];
|
||||
|
||||
// clear reaction triggers here as well
|
||||
_reactionTriggers[i] = false;
|
||||
}
|
||||
}
|
||||
|
||||
SpatialParentTree* MyAvatar::getParentTree() const {
|
||||
auto entityTreeRenderer = qApp->getEntities();
|
||||
EntityTreePointer entityTree = entityTreeRenderer ? entityTreeRenderer->getTree() : nullptr;
|
||||
|
|
|
|||
|
|
@ -1369,9 +1369,9 @@ public:
|
|||
bool hasDriveInput() const;
|
||||
|
||||
/**jsdoc
|
||||
* Gets the list of avatar entities and their properties.
|
||||
* Gets the current avatar entity IDs and their properties.
|
||||
* @function MyAvatar.getAvatarEntitiesVariant
|
||||
* @returns {MyAvatar.AvatarEntityData[]} The list of avatar entities and their properties.
|
||||
* @returns {MyAvatar.AvatarEntityData[]} The current avatar entity IDs and their properties.
|
||||
*/
|
||||
Q_INVOKABLE QVariantList getAvatarEntitiesVariant();
|
||||
|
||||
|
|
@ -1855,6 +1855,10 @@ public:
|
|||
bool getFlowActive() const;
|
||||
bool getNetworkGraphActive() const;
|
||||
|
||||
// sets the reaction enabled and triggered parameters of the passed in params
|
||||
// also clears internal reaction triggers
|
||||
void updateRigControllerParameters(Rig::ControllerParameters& params);
|
||||
|
||||
public slots:
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -2208,6 +2212,33 @@ public slots:
|
|||
*/
|
||||
virtual void setModelScale(float scale) override;
|
||||
|
||||
/**jsdoc
|
||||
* MyAvatar.getReactions
|
||||
* @returns {string[]} Array of reaction names.
|
||||
*/
|
||||
QStringList getReactions() const;
|
||||
|
||||
/**jsdoc
|
||||
* MyAvatar.triggerReaction
|
||||
* @param {string} reactionName - reaction name
|
||||
* @returns {bool} false if the given reaction is not supported.
|
||||
*/
|
||||
bool triggerReaction(QString reactionName);
|
||||
|
||||
/**jsdoc
|
||||
* MyAvatar.beginReaction
|
||||
* @param {string} reactionName - reaction name
|
||||
* @returns {bool} false if the given reaction is not supported.
|
||||
*/
|
||||
bool beginReaction(QString reactionName);
|
||||
|
||||
/**jsdoc
|
||||
* MyAvatar.endReaction
|
||||
* @param {string} reactionName - reaction name
|
||||
* @returns {bool} false if the given reaction is not supported.
|
||||
*/
|
||||
bool endReaction(QString reactionName);
|
||||
|
||||
signals:
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -2842,6 +2873,10 @@ private:
|
|||
mutable std::mutex _scriptEngineLock;
|
||||
QScriptEngine* _scriptEngine { nullptr };
|
||||
bool _needToSaveAvatarEntitySettings { false };
|
||||
|
||||
int _reactionEnabledRefCounts[NUM_AVATAR_REACTIONS] { 0, 0, 0, 0, 0 };
|
||||
bool _reactionTriggers[NUM_AVATAR_REACTIONS] { false, false, false, false, false };
|
||||
mutable std::mutex _reactionLock;
|
||||
};
|
||||
|
||||
QScriptValue audioListenModeToScriptValue(QScriptEngine* engine, const AudioListenerMode& audioListenerMode);
|
||||
|
|
|
|||
|
|
@ -296,8 +296,6 @@ void MySkeletonModel::updateRig(float deltaTime, glm::mat4 parentTransform) {
|
|||
_prevIsEstimatingHips = false;
|
||||
}
|
||||
|
||||
params.isTalking = head->getTimeWithoutTalking() <= 1.5f;
|
||||
|
||||
// pass detailed torso k-dops to rig.
|
||||
int hipsJoint = _rig.indexOfJoint("Hips");
|
||||
if (hipsJoint >= 0) {
|
||||
|
|
@ -316,6 +314,10 @@ void MySkeletonModel::updateRig(float deltaTime, glm::mat4 parentTransform) {
|
|||
params.spine2ShapeInfo = hfmModel.joints[spine2Joint].shapeInfo;
|
||||
}
|
||||
|
||||
params.isTalking = head->getTimeWithoutTalking() <= 1.5f;
|
||||
|
||||
myAvatar->updateRigControllerParameters(params);
|
||||
|
||||
_rig.updateFromControllerParameters(params, deltaTime);
|
||||
|
||||
Rig::CharacterControllerState ccState = convertCharacterControllerState(myAvatar->getCharacterController()->getState());
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
* @property {FilterFlags} PICK_AVATAR_ENTITIES - Include avatar entities when intersecting. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_LOCAL_ENTITIES - Include local entities when intersecting. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_AVATARS - Include avatars when intersecting. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_HUD - Include the HUD sphere when intersecting in HMD mode. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_HUD - Include the HUD surface when intersecting in HMD mode. <em>Read-only.</em>
|
||||
*
|
||||
* @property {FilterFlags} PICK_ENTITIES - Include domain and avatar entities when intersecting. <em>Read-only.</em>
|
||||
* <p class="important">Deprecated: This property is deprecated and will be removed. Use <code>PICK_DOMAIN_ENTITIES |
|
||||
|
|
@ -61,7 +61,7 @@
|
|||
* <p class="important">Deprecated: This property is deprecated and will be removed. Use
|
||||
* <code>INTERSECTED_LOCAL_ENTITY</code> instead.</p>
|
||||
* @property {IntersectionType} INTERSECTED_AVATAR - Intersected an avatar. <em>Read-only.</em>
|
||||
* @property {IntersectionType} INTERSECTED_HUD - Intersected the HUD sphere. <em>Read-only.</em>
|
||||
* @property {IntersectionType} INTERSECTED_HUD - Intersected the HUD surface. <em>Read-only.</em>
|
||||
*
|
||||
* @property {number} perFrameTimeBudget - The maximum time, in microseconds, to spend per frame updating pick results.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@
|
|||
* <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_OVERLAYS - Include local entities when intersecting. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_AVATARS - Include avatars when intersecting. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_HUD - Include the HUD sphere when intersecting in HMD mode. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_HUD - Include the HUD surface when intersecting in HMD mode. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_PRECISE - Pick against exact meshes. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_INCLUDE_INVISIBLE - Include invisible objects when intersecting. <em>Read-only.</em>
|
||||
* @property {FilterFlags} PICK_INCLUDE_NONCOLLIDABLE - Include non-collidable objects when intersecting. <em>Read-only.</em>
|
||||
|
|
@ -43,7 +43,7 @@
|
|||
* @property {IntersectionType} INTERSECTED_LOCAL_ENTITY - Intersected a local entity. <em>Read-only.</em>
|
||||
* @property {IntersectionType} INTERSECTED_OVERLAY - Intersected an entity (3D Overlays no longer exist). <em>Read-only.</em>
|
||||
* @property {IntersectionType} INTERSECTED_AVATAR - Intersected an avatar. <em>Read-only.</em>
|
||||
* @property {IntersectionType} INTERSECTED_HUD - Intersected the HUD sphere. <em>Read-only.</em>
|
||||
* @property {IntersectionType} INTERSECTED_HUD - Intersected the HUD surface. <em>Read-only.</em>
|
||||
*/
|
||||
class RayPickScriptingInterface : public QObject, public Dependency {
|
||||
Q_OBJECT
|
||||
|
|
|
|||
|
|
@ -459,7 +459,7 @@ signals:
|
|||
/**jsdoc
|
||||
* Triggered when the server injector gain changes.
|
||||
* @function Audio.serverInjectorGainChanged
|
||||
* @param {float} gain - The new server injector gain value.
|
||||
* @param {number} gain - The new server injector gain value.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void serverInjectorGainChanged(float gain);
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ class QScriptEngine;
|
|||
* @property {Uuid} miniTabletScreenID - The UUID of the mini tablet's screen entity. <code>null</code> if not in HMD mode.
|
||||
* @property {number} miniTabletHand - The hand that the mini tablet is displayed on: <code>0</code> for left hand,
|
||||
* <code>1</code> for right hand, <code>-1</code> if not in HMD mode.
|
||||
* @property {bool} miniTabletEnabled=true - <code>true</code> if the mini tablet is enabled to be displayed, otherwise
|
||||
* @property {boolean} miniTabletEnabled=true - <code>true</code> if the mini tablet is enabled to be displayed, otherwise
|
||||
* <code>false</code>.
|
||||
* @property {Rect} playArea=0,0,0,0 - The size and position of the HMD play area in sensor coordinates. <em>Read-only.</em>
|
||||
* @property {Vec3[]} sensorPositions=[]] - The positions of the VR system sensors in sensor coordinates. <em>Read-only.</em>
|
||||
|
|
|
|||
|
|
@ -658,7 +658,8 @@ signals:
|
|||
/**jsdoc
|
||||
* Triggered when you try to visit a domain but are redirected into the error state.
|
||||
* @function Window.redirectErrorStateChanged
|
||||
* @param {boolean} isInErrorState - If <code>true</code>, the user has been redirected to the error URL.
|
||||
* @param {boolean} isInErrorState - <code>true</code> if the user has been redirected to the error URL, <code>false</code>
|
||||
* if they haven't.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void redirectErrorStateChanged(bool isInErrorState);
|
||||
|
|
@ -666,8 +667,8 @@ signals:
|
|||
/**jsdoc
|
||||
* Triggered when the interstitial mode changes.
|
||||
* @function Window.interstitialModeChanged
|
||||
* @param {bool} interstitialMode - The new interstitial mode value. If <code>true</code>, the interstitial graphics are
|
||||
* displayed when the domain is loading.
|
||||
* @param {boolean} interstitialMode - <code>true</code> if the interstitial graphics are displayed when the domain is
|
||||
* loading, <code>false</code> if they are not.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void interstitialModeChanged(bool interstitialMode);
|
||||
|
|
|
|||
|
|
@ -24,18 +24,31 @@ class AvatarInputs : public QObject {
|
|||
HIFI_QML_DECL
|
||||
|
||||
/**jsdoc
|
||||
* API to help manage your Avatar's input
|
||||
* The <code>AvatarInputs</code> API provides facilities to manage user inputs.
|
||||
*
|
||||
* @namespace AvatarInputs
|
||||
*
|
||||
* @hifi-interface
|
||||
* @hifi-client-entity
|
||||
* @hifi-avatar
|
||||
*
|
||||
* @property {boolean} cameraEnabled <em>Read-only.</em>
|
||||
* @property {boolean} cameraMuted <em>Read-only.</em>
|
||||
* @property {boolean} isHMD <em>Read-only.</em>
|
||||
* @property {boolean} showAudioTools
|
||||
* @property {boolean} showBubbleTools
|
||||
* @property {boolean} cameraEnabled - <code>true</code> if webcam face tracking is enabled, <code>false</code> if it is
|
||||
* disabled.
|
||||
* <em>Read-only.</em>
|
||||
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
|
||||
* @property {boolean} cameraMuted - <code>true</code> if webcam face tracking is muted (temporarily disabled),
|
||||
* <code>false</code> it if isn't.
|
||||
* <em>Read-only.</em>
|
||||
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
|
||||
* @property {boolean} ignoreRadiusEnabled - <code>true</code> if the privacy shield is enabled, <code>false</code> if it
|
||||
* is disabled.
|
||||
* <em>Read-only.</em>
|
||||
* @property {boolean} isHMD - <code>true</code> if the display mode is HMD, <code>false</code> if it isn't.
|
||||
* <em>Read-only.</em>
|
||||
* @property {boolean} showAudioTools - <code>true</code> if the microphone mute button and audio level meter are shown,
|
||||
* <code>false</code> if they are hidden.
|
||||
* @property {boolean} showBubbleTools - <code>true</code> if the privacy shield UI button is shown, <code>false</code> if
|
||||
* it is hidden.
|
||||
*/
|
||||
|
||||
AI_PROPERTY(bool, cameraEnabled, false)
|
||||
|
|
@ -51,9 +64,10 @@ public:
|
|||
static AvatarInputs* getInstance();
|
||||
|
||||
/**jsdoc
|
||||
* Converts non-linear audio loudness to a linear audio level.
|
||||
* @function AvatarInputs.loudnessToAudioLevel
|
||||
* @param {number} loudness
|
||||
* @returns {number}
|
||||
* @param {number} loudness - The non-linear audio loudness.
|
||||
* @returns {number} The linear audio level.
|
||||
*/
|
||||
Q_INVOKABLE float loudnessToAudioLevel(float loudness);
|
||||
|
||||
|
|
@ -67,76 +81,96 @@ public:
|
|||
public slots:
|
||||
|
||||
/**jsdoc
|
||||
* Sets whether or not the microphone mute button and audio level meter is shown.
|
||||
* @function AvatarInputs.setShowAudioTools
|
||||
* @param {boolean} showAudioTools
|
||||
* @param {boolean} showAudioTools - <code>true</code> to show the microphone mute button and audio level meter,
|
||||
* <code>false</code> to hide it.
|
||||
*/
|
||||
void setShowAudioTools(bool showAudioTools);
|
||||
|
||||
/**jsdoc
|
||||
* Sets whether or not the privacy shield button is shown.
|
||||
* @function AvatarInputs.setShowBubbleTools
|
||||
* @param {boolean} showBubbleTools
|
||||
* @param {boolean} showBubbleTools - <code>true</code> to show the privacy shield button, <code>false</code> to hide it.
|
||||
*/
|
||||
void setShowBubbleTools(bool showBubbleTools);
|
||||
|
||||
signals:
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when webcam face tracking is enabled or disabled.
|
||||
* @deprecated This signal is deprecated and will be removed.
|
||||
* @function AvatarInputs.cameraEnabledChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void cameraEnabledChanged();
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when webcam face tracking is muted (temporarily disabled) or unmuted.
|
||||
* @deprecated This signal is deprecated and will be removed.
|
||||
* @function AvatarInputs.cameraMutedChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void cameraMutedChanged();
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when the display mode changes between desktop and HMD.
|
||||
* @function AvatarInputs.isHMDChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void isHMDChanged();
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when the visibility of the microphone mute button and audio level meter changes.
|
||||
* @function AvatarInputs.showAudioToolsChanged
|
||||
* @param {boolean} show
|
||||
* @param {boolean} show - <code>true</code> if the microphone mute button and audio level meter are shown,
|
||||
* <code>false</code> if they are is hidden.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void showAudioToolsChanged(bool show);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when the visibility of the privacy shield button changes.
|
||||
* @function AvatarInputs.showBubbleToolsChanged
|
||||
* @param {boolean} show
|
||||
* @param {boolean} show - <code>true</code> if the privacy shield UI button is shown, <code>false</code> if
|
||||
* it is hidden.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void showBubbleToolsChanged(bool show);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when another user enters the privacy shield.
|
||||
* @function AvatarInputs.avatarEnteredIgnoreRadius
|
||||
* @param {QUuid} avatarID
|
||||
* @param {QUuid} avatarID - The session ID of the user that entered the privacy shield.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
* @example <caption>Report when a user enters the privacy shield.</caption>
|
||||
* AvatarInputs.avatarEnteredIgnoreRadius.connect(function(avatarID) {
|
||||
* print("User entered the privacy shield: " + avatarID);
|
||||
* };
|
||||
*/
|
||||
void avatarEnteredIgnoreRadius(QUuid avatarID);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when another user leaves the privacy shield.
|
||||
* <p><strong>Note:</strong> Currently doesn't work.</p>
|
||||
* @function AvatarInputs.avatarLeftIgnoreRadius
|
||||
* @param {QUuid} avatarID
|
||||
* @param {QUuid} avatarID - The session ID of the user that exited the privacy shield.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
* @deprecated This signal is deprecated and will be removed.
|
||||
*/
|
||||
void avatarLeftIgnoreRadius(QUuid avatarID);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when the privacy shield is enabled or disabled.
|
||||
* @function AvatarInputs.ignoreRadiusEnabledChanged
|
||||
* @param {boolean} enabled
|
||||
* @param {boolean} enabled - <code>true</code> if the privacy shield is enabled, <code>false</code> if it is disabled.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void ignoreRadiusEnabledChanged(bool enabled);
|
||||
|
||||
/**jsdoc
|
||||
* Triggered when another user enters the privacy shield.
|
||||
* @function AvatarInputs.enteredIgnoreRadiusChanged
|
||||
* @param {boolean} enabled
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void enteredIgnoreRadiusChanged();
|
||||
|
|
@ -144,11 +178,14 @@ signals:
|
|||
protected:
|
||||
|
||||
/**jsdoc
|
||||
* Resets sensors, audio, avatar animations, and the avatar rig.
|
||||
* @function AvatarInputs.resetSensors
|
||||
*/
|
||||
Q_INVOKABLE void resetSensors();
|
||||
|
||||
/**jsdoc
|
||||
* Toggles the muting (temporary disablement) of webcam face tracking on/off.
|
||||
* <p class="important">Deprecated: This function is deprecated and will be removed.</p>
|
||||
* @function AvatarInputs.toggleCameraMute
|
||||
*/
|
||||
Q_INVOKABLE void toggleCameraMute();
|
||||
|
|
|
|||
|
|
@ -1333,127 +1333,170 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <p>An overlay may be one of the following types:</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
* <tr><th>Value</th><th>2D/3D</th><th>Description</th></tr>
|
||||
* <tr><th>Value</th><th>2D/3D</th><th>Description</th><th>Properties</th></tr>
|
||||
* </thead>
|
||||
* <tbody>
|
||||
* <tr><td><code>image</code></td><td>2D</td><td>An image. Synonym: <code>billboard</code>.</td></tr>
|
||||
* <tr><td><code>rectangle</code></td><td>2D</td><td>A rectangle.</td></tr>
|
||||
* <tr><td><code>text</code></td><td>2D</td><td>Text.</td></tr>
|
||||
* <tr><td><code>cube</code></td><td>3D</td><td>A cube. Can also use a <code>shape</code> overlay to create a cube.</td></tr>
|
||||
* <tr><td><code>sphere</code></td><td>3D</td><td>A sphere. Can also use a <code>shape</code> overlay to create a sphere.</td></tr>
|
||||
* <tr><td><code>rectangle3d</code></td><td>3D</td><td>A rectangle.</td></tr>
|
||||
* <tr><td><code>shape</code></td><td>3D</td><td>A geometric shape, such as a cube, sphere, or cylinder.</td></tr>
|
||||
* <tr><td><code>model</code></td><td>3D</td><td>A model.</td></tr>
|
||||
* <tr><td><code>text3d</code></td><td>3D</td><td>Text.</td></tr>
|
||||
* <tr><td><code>image3d</code></td><td>3D</td><td>An image.</td></tr>
|
||||
* <tr><td><code>web3d</code></td><td>3D</td><td>Web content.</td></tr>
|
||||
* <tr><td><code>line3d</code></td><td>3D</td><td>A line.</td></tr>
|
||||
* <tr><td><code>grid</code></td><td>3D</td><td>A grid of lines in a plane.</td></tr>
|
||||
* <tr><td><code>circle3d</code></td><td>3D</td><td>A circle.</td></tr>
|
||||
* <tr><td><code>"rectangle"</code></td><td>2D</td>
|
||||
* <td>A rectangle.</td>
|
||||
* <td>{@link Overlays.OverlayProperties-Rectangle|OverlayProperties-Rectangle}</td></tr>
|
||||
* <tr><td><code>"image"</code></td><td>2D</td>
|
||||
* <td>An image.</td>
|
||||
* <td>{@link Overlays.OverlayProperties-Image|OverlayProperties-Image}</td></tr>
|
||||
* <tr><td><code>"text"</code></td><td>2D</td>
|
||||
* <td>Some text.</td>
|
||||
* <td>{@link Overlays.OverlayProperties-Text|OverlayProperties-Text}</td></tr>
|
||||
* <tr><td><code>"cube"</code></td><td>3D</td>
|
||||
* <td>A cube. A <code>"shape"</code> overlay can also be used to create a cube.<br/>
|
||||
* <span class="important">Deprecated.</span>
|
||||
* </td>
|
||||
* <td>{@link Overlays.OverlayProperties-Cube|OverlayProperties-Cube}</td></tr>
|
||||
* <tr><td><code>"sphere"</code></td><td>3D</td>
|
||||
* <td>A sphere. A <code>"shape"</code> overlay can also be used to create a sphere.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere}</td></tr>
|
||||
* <tr><td><code>"shape"</code></td><td>3D</td>
|
||||
* <td>A geometric shape, such as a cube, sphere, or cylinder.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape}</td></tr>
|
||||
* <tr><td><code>"model"</code></td><td>3D</td>
|
||||
* <td>A model.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Model|OverlayProperties-Model}</td></tr>
|
||||
* <tr><td><code>"image3d"</code></td><td>3D</td>
|
||||
* <td>An image. Synonym: <code>"billboard"</code>.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D}</td></tr>
|
||||
* <tr><td><code>"rectangle3d"</code></td><td>3D</td>
|
||||
* <td>A rectangle.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D}</td></tr>
|
||||
* <tr><td><code>"text3d"</code></td><td>3D</td>
|
||||
* <td>Some text.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D}</td></tr>
|
||||
* <tr><td><code>"web3d"</code></td><td>3D</td>
|
||||
* <td>Web content.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Web3D|OverlayProperties-Web3D}</td></tr>
|
||||
* <tr><td><code>"line3d"</code></td><td>3D</td>
|
||||
* <td>A line.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Line3D|OverlayProperties-Line3D}</td></tr>
|
||||
* <tr><td><code>"grid"</code></td><td>3D</td>
|
||||
* <td>A grid of lines in a plane.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid}</td></tr>
|
||||
* <tr><td><code>"circle3d"</code></td><td>3D</td>
|
||||
* <td>A circle.<br/>
|
||||
* <span class="important">Deprecated.</span></td>
|
||||
* <td>{@link Overlays.OverlayProperties-Circle3D|OverlayProperties-Circle3D}</td></tr>
|
||||
* </tbody>
|
||||
* </table>
|
||||
* <p>2D overlays are rendered on the display surface in desktop mode and on the HUD surface in HMD mode. 3D overlays are
|
||||
* rendered at a position and orientation in-world, but are deprecated (use local entities instead).<p>
|
||||
* <p>Each overlay type has different {@link Overlays.OverlayProperties|OverlayProperties}.</p>
|
||||
* rendered at a position and orientation in-world.</p>
|
||||
* <p class="important">3D overlays are deprecated. Use local {@link Entities} instead.</p>
|
||||
* @typedef {string} Overlays.OverlayType
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Different overlay types have different properties: some common to all overlays (listed below) and some specific to each
|
||||
* {@link Overlays.OverlayType|OverlayType} (linked to below). The properties are accessed as an object of property names and
|
||||
* values. 3D Overlays are local entities, internally, so they also support the corresponding entity properties.
|
||||
*
|
||||
* Different overlay types have different properties: some common to all overlays (listed in the table) and some specific to
|
||||
* each {@link Overlays.OverlayType|OverlayType} (linked to below).
|
||||
* <p>3D overlays are local entities, internally, so they also support the relevant entity's properties.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties
|
||||
* @property {Uuid} id - The ID of the overlay. <em>Read-only.</em>
|
||||
* @property {Overlays.OverlayType} type - The overlay type. <em>Read-only.</em>
|
||||
* @property {boolean} visible=true - If <code>true</code>, the overlay is rendered, otherwise it is not rendered.
|
||||
* @property {Overlays.OverlayType} type - The overlay's type. <em>Read-only.</em>
|
||||
* @property {boolean} visible=true - <code>true</code> if the overlay is rendered, <code>false</code> if it isn't.
|
||||
*
|
||||
* @see The different entity types have additional properties as follows:
|
||||
* @see {@link Overlays.OverlayProperties-Rectangle|OverlayProperties-Rectangle}
|
||||
* @see {@link Overlays.OverlayProperties-Image|OverlayProperties-Image}
|
||||
* @see {@link Overlays.OverlayProperties-Text|OverlayProperties-Text}
|
||||
* @see {@link Overlays.OverlayProperties-Rectangle|OverlayProperties-Rectangle}
|
||||
* @see {@link Overlays.OverlayProperties-Cube|OverlayProperties-Cube}
|
||||
* @see {@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere}
|
||||
* @see {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D}
|
||||
* @see {@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape}
|
||||
* @see {@link Overlays.OverlayProperties-Model|OverlayProperties-Model}
|
||||
* @see {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D}
|
||||
* @see {@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D}
|
||||
* @see {@link Overlays.OverlayProperties-Web|OverlayProperties-Web}
|
||||
* @see {@link Overlays.OverlayProperties-Line|OverlayProperties-Line}
|
||||
* @see {@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid}
|
||||
* @see {@link Overlays.OverlayProperties-Circle|OverlayProperties-Circle}
|
||||
* @see {@link Overlays.OverlayProperties-Cube|OverlayProperties-Cube} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Model|OverlayProperties-Model} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Web3D|OverlayProperties-Web3D} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Line3D|OverlayProperties-Line3D} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid} <span class="important">Deprecated.</span>
|
||||
* @see {@link Overlays.OverlayProperties-Circle3D|OverlayProperties-Circle3D} <span class="important">Deprecated.</span>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Image"</code> {@link Overlays.OverlayType|OverlayType} is a 2D image.
|
||||
* The <code>"image"</code> {@link Overlays.OverlayType|OverlayType} is for 2D images.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* @typedef {object} Overlays.OverlayProperties-Image
|
||||
* @property {Rect} bounds - The position and size of the image display area, in pixels. <em>Write-only.</em>
|
||||
* @property {number} x - Integer left, x-coordinate value of the image display area = <code>bounds.x</code>.
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} y - Integer top, y-coordinate value of the image display area = <code>bounds.y</code>.
|
||||
* @property {number} y - Integer top, y-coordinate value of the image display area = <code>bounds.y</code>.
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} width - Integer width of the image display area = <code>bounds.width</code>. <em>Write-only.</em>
|
||||
* @property {number} height - Integer height of the image display area = <code>bounds.height</code>. <em>Write-only.</em>
|
||||
* @property {number} height - Integer height of the image display area = <code>bounds.height</code>. <em>Write-only.</em>
|
||||
* @property {string} imageURL - The URL of the image file to display. The image is scaled to fit to the <code>bounds</code>.
|
||||
* <em>Write-only.</em>
|
||||
* @property {Vec2} subImage=0,0 - Integer coordinates of the top left pixel to start using image content from.
|
||||
* @property {Rect} subImage - The portion of the image to use. If not specified, the whole image is used.
|
||||
* <em>Write-only.</em>
|
||||
* @property {Color} color=0,0,0 - The color to apply over the top of the image to colorize it. <em>Write-only.</em>
|
||||
* @property {number} alpha=0.0 - The opacity of the color applied over the top of the image, <code>0.0</code> -
|
||||
* @property {number} alpha=0.0 - The opacity of the color applied over the top of the image, <code>0.0</code> –
|
||||
* <code>1.0</code>. <em>Write-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Text"</code> {@link Overlays.OverlayType|OverlayType} is for 2D text.
|
||||
* The <code>"text"</code> {@link Overlays.OverlayType|OverlayType} is for 2D text.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* @typedef {object} Overlays.OverlayProperties-Text
|
||||
* @property {Rect} bounds - The position and size of the rectangle, in pixels. <em>Write-only.</em>
|
||||
* @property {number} x - Integer left, x-coordinate value = <code>bounds.x</code>. <em>Write-only.</em>
|
||||
* @property {number} y - Integer top, y-coordinate value = <code>bounds.y</code>. <em>Write-only.</em>
|
||||
* @property {number} width - Integer width of the rectangle = <code>bounds.width</code>. <em>Write-only.</em>
|
||||
* @property {number} height - Integer height of the rectangle = <code>bounds.height</code>. <em>Write-only.</em>
|
||||
*
|
||||
* @property {number} margin=0 - Sets the <code>leftMargin</code> and <code>topMargin</code> values, in pixels.
|
||||
* @property {number} margin=0 - The <code>leftMargin</code> and <code>topMargin</code> values, in pixels.
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} leftMargin=0 - The left margin's size, in pixels. This value is also used for the right margin.
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} topMargin=0 - The top margin's size, in pixels. This value is also used for the bottom margin.
|
||||
* <em>Write-only.</em>
|
||||
* @property {string} text="" - The text to display. Text does not automatically wrap; use <code>\n</code> for a line break. Text
|
||||
* is clipped to the <code>bounds</code>. <em>Write-only.</em>
|
||||
* @property {string} text="" - The text to display. Text does not automatically wrap; use <code>"\n"</code> for a line break.
|
||||
* Text is clipped to the <code>bounds</code>. <em>Write-only.</em>
|
||||
* @property {number} font.size=18 - The size of the text, in pixels. <em>Write-only.</em>
|
||||
* @property {number} lineHeight=18 - The height of a line of text, in pixels. <em>Write-only.</em>
|
||||
* @property {Color} color=255,255,255 - The color of the text. Synonym: <code>textColor</code>. <em>Write-only.</em>
|
||||
* @property {number} alpha=1.0 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>. <em>Write-only.</em>
|
||||
* @property {number} alpha=1.0 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>. <em>Write-only.</em>
|
||||
* @property {Color} backgroundColor=0,0,0 - The color of the background rectangle. <em>Write-only.</em>
|
||||
* @property {number} backgroundAlpha=0.7 - The opacity of the background rectangle. <em>Write-only.</em>
|
||||
* @property {number} backgroundAlpha=0.7 - The opacity of the background rectangle, <code>0.0</code> – <code>1.0</code>.
|
||||
* <em>Write-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Rectangle"</code> {@link Overlays.OverlayType|OverlayType} is for 2D rectangles.
|
||||
* The <code>"rectangle"</code> {@link Overlays.OverlayType|OverlayType} is for 2D rectangles.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* @typedef {object} Overlays.OverlayProperties-Rectangle
|
||||
* @property {Rect} bounds - The position and size of the rectangle, in pixels. <em>Write-only.</em>
|
||||
* @property {number} x - Integer left, x-coordinate value = <code>bounds.x</code>. <em>Write-only.</em>
|
||||
* @property {number} y - Integer top, y-coordinate value = <code>bounds.y</code>. <em>Write-only.</em>
|
||||
* @property {number} width - Integer width of the rectangle = <code>bounds.width</code>. <em>Write-only.</em>
|
||||
* @property {number} height - Integer height of the rectangle = <code>bounds.height</code>. <em>Write-only.</em>
|
||||
*
|
||||
* @property {number} radius=0 - Integer corner radius, in pixels. <em>Write-only.</em>
|
||||
* @property {Color} color=0,0,0 - The color of the overlay. <em>Write-only.</em>
|
||||
* @property {number} alpha=1.0 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>. <em>Write-only.</em>
|
||||
* @property {number} alpha=1.0 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>. <em>Write-only.</em>
|
||||
* @property {number} borderWidth=1 - Integer width of the border, in pixels. The border is drawn within the rectangle's bounds.
|
||||
* It is not drawn unless either <code>borderColor</code> or <code>borderAlpha</code> are specified. <em>Write-only.</em>
|
||||
* @property {number} radius=0 - Integer corner radius, in pixels. <em>Write-only.</em>
|
||||
* @property {Color} borderColor=0,0,0 - The color of the border. <em>Write-only.</em>
|
||||
* @property {number} borderAlpha=1.0 - The opacity of the border, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} borderAlpha=1.0 - The opacity of the border, <code>0.0</code> – <code>1.0</code>.
|
||||
* <em>Write-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Cube"</code> {@link Overlays.OverlayType|OverlayType} is for 3D cubes.
|
||||
* The <code>"cube"</code> {@link Overlays.OverlayType|OverlayType} is for 3D cubes.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Box|Box} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Cube
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1475,24 +1518,33 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} isSolid=false - Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* @property {boolean} isSolid=false - <code>true</code> if the overlay is rendered as a solid, <code>false</code> if it is
|
||||
* rendered as a wire frame.
|
||||
* Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* Antonyms: <code>isWire</code> and <code>wire</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
*
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Sphere"</code> {@link Overlays.OverlayType|OverlayType} is for 3D spheres.
|
||||
* The <code>"sphere"</code> {@link Overlays.OverlayType|OverlayType} is for 3D spheres.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Sphere|Sphere} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Sphere
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1514,24 +1566,34 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} isSolid=false - Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* @property {boolean} isSolid=false - <code>true</code> if the overlay is rendered as a solid, <code>false</code> if it is
|
||||
* rendered as a wire frame.
|
||||
* Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* Antonyms: <code>isWire</code> and <code>wire</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
*
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Rectangle3D"</code> {@link Overlays.OverlayType|OverlayType} is for 3D rectangles.
|
||||
* The <code>"rectangle3D"</code> {@link Overlays.OverlayType|OverlayType} is for 3D rectangles.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Shape|Shape} entity, with the <code>shape</code>
|
||||
* property value being <code>"Quad"</code>.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Rectangle3D
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1553,20 +1615,27 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} isSolid=false - Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* @property {boolean} isSolid=false - <code>true</code> if the overlay is rendered as a solid, <code>false</code> if it is
|
||||
* rendered as a wire frame.
|
||||
* Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* Antonyms: <code>isWire</code> and <code>wire</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
*
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* <p>A <code>shape</code> {@link Overlays.OverlayType|OverlayType} may display as one of the following geometrical shapes:</p>
|
||||
* <p>A <code>"shape"</code> {@link Overlays.OverlayType|OverlayType} may display as one of the following geometrical
|
||||
* shapes:</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
* <tr><th>Value</th><th>Dimensions</th><th>Description</th></tr>
|
||||
|
|
@ -1579,7 +1648,6 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <tr><td><code>"Dodecahedron"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Hexagon"</code></td><td>3D</td><td>A hexagonal prism.</td></tr>
|
||||
* <tr><td><code>"Icosahedron"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Line"</code></td><td>1D</td><td>A line oriented in 3D.</td></tr>
|
||||
* <tr><td><code>"Octagon"</code></td><td>3D</td><td>An octagonal prism.</td></tr>
|
||||
* <tr><td><code>"Octahedron"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Quad"</code></td><td>2D</td><td>A square oriented in 3D.</tr>
|
||||
|
|
@ -1593,11 +1661,14 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Shape"</code> {@link Overlays.OverlayType|OverlayType} is for 3D shapes.
|
||||
* The <code>"shape"</code> {@link Overlays.OverlayType|OverlayType} is for 3D shapes.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Shape|Shape} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Shape
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1619,21 +1690,31 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} isSolid=false - Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* @property {boolean} isSolid=false - <code>true</code> if the overlay is rendered as a solid, <code>false</code> if it is
|
||||
* rendered as a wire frame.
|
||||
* Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* Antonyms: <code>isWire</code> and <code>wire</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*
|
||||
* @property {Overlays.Shape} shape=Hexagon - The geometrical shape of the overlay.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Model"</code> {@link Overlays.OverlayType|OverlayType} is for 3D models.
|
||||
* The <code>"model"</code> {@link Overlays.OverlayType|OverlayType} is for 3D models.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Model|Model} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Model
|
||||
* @property {string} name - The name of the overlay.
|
||||
*
|
||||
|
|
@ -1646,42 +1727,39 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*
|
||||
* @property {string} url - The URL of the FBX or OBJ model used for the overlay.
|
||||
* @property {number} loadPriority=0.0 - The priority for loading and displaying the overlay. Overlays with higher values load
|
||||
* first. <CURRENTLY NOT USED>
|
||||
* @property {object.<name, url>} textures - Maps the named textures in the model to the JPG or PNG images in the urls.
|
||||
* @property {string[]} jointNames - The names of the joints - if any - in the model. <em>Read-only.</em>
|
||||
* @property {Quat[]} jointRotations - The relative rotations of the model's joints.
|
||||
* @property {Vec3[]} jointTranslations - The relative translations of the model's joints.
|
||||
* @property {Quat[]} jointOrientations - The absolute orientations of the model's joints, in world coordinates. <em>Read-only.</em>
|
||||
* @property {Vec3[]} jointPositions - The absolute positions of the model's joints, in world coordinates. <em>Read-only.</em>
|
||||
* @property {string} animationSettings.url="" - The URL of an FBX file containing an animation to play.
|
||||
* @property {number} animationSettings.fps=0 - The frame rate (frames/sec) to play the animation at.
|
||||
* @property {number} animationSettings.firstFrame=0 - The frame to start playing at.
|
||||
* @property {number} animationSettings.lastFrame=0 - The frame to finish playing at.
|
||||
* @property {number} animationSettings.currentFrame=0 - The current frame being played.
|
||||
* @property {boolean} animationSettings.running=false - Whether or not the animation is playing.
|
||||
* @property {boolean} animationSettings.loop=false - Whether or not the animation should repeat in a loop.
|
||||
* @property {boolean} animationSettings.hold=false - Whether or not when the animation finishes, the rotations and
|
||||
* translations of the last frame played should be maintained.
|
||||
* @property {boolean} animationSettings.allowTranslation=false - Whether or not translations contained in the animation should
|
||||
* be played.
|
||||
* first. <em>Currently not used.</em>
|
||||
* @property {Object.<string, string>|string} textures - Texture name, URL pairs used when rendering the model in place of the
|
||||
* model's original textures, per the {@link Entities.EntityProperties-Model} property of the same name.
|
||||
* <p>The value can be an object or a JSON string when setting the value; it is a JSON string when getting the value.</p>
|
||||
* @property {Entities.AnimationProperties} animationSettings - An animation to play on the model.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Text3D"</code> {@link Overlays.OverlayType|OverlayType} is for 3D text.
|
||||
* The <code>"text3D"</code> {@link Overlays.OverlayType|OverlayType} is for 3D text.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Text|Text} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Text3D
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay text. Synonym: <code>textColor</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay text, <code>0.0</code> – <code>1.0</code>.
|
||||
* <p><em>Currently not used; use <code>textAlpha</code> instead.</em></p>
|
||||
* <CURRENTLY BROKEN>
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1703,33 +1781,29 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
*
|
||||
* @property {boolean} isFacingAvatar - If <code>true</code>, the overlay is rotated to face the user's camera about an axis
|
||||
* parallel to the user's avatar's "up" direction.
|
||||
* @property {string} text="" - The text to display.Text does not automatically wrap; use <code>\n</code> for a line break.
|
||||
* @property {number} textAlpha=1 - The text alpha value.
|
||||
* @property {Color} backgroundColor=0,0,0 - The background color.
|
||||
* @property {number} backgroundAlpha=0.7 - The background alpha value.
|
||||
* @property {number} lineHeight=1 - The height of a line of text in meters.
|
||||
* @property {number} leftMargin=0.1 - The left margin, in meters.
|
||||
* @property {number} topMargin=0.1 - The top margin, in meters.
|
||||
* @property {number} rightMargin=0.1 - The right margin, in meters.
|
||||
* @property {number} bottomMargin=0.1 - The bottom margin, in meters.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Image3D"</code> {@link Overlays.OverlayType|OverlayType} is for 3D images.
|
||||
* The <code>"image3D"</code> {@link Overlays.OverlayType|OverlayType} is for 3D images.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Image|Image} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Image3D
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1751,29 +1825,31 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*
|
||||
* @property {boolean} isFacingAvatar - If <code>true</code>, the overlay is rotated to face the user's camera about an axis
|
||||
* parallel to the user's avatar's "up" direction.
|
||||
* @property {string} url - The URL of the PNG or JPG image to display.
|
||||
* @property {Rect} subImage - The portion of the image to display. Defaults to the full image.
|
||||
* @property {boolean} emissive - If <code>true</code>, the overlay is displayed at full brightness, otherwise it is rendered
|
||||
* with scene lighting.
|
||||
* @property {bool} keepAspectRatio=true - overlays will maintain the aspect ratio when the subImage is applied.
|
||||
* @property {string} url - The URL of the image to display.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Web"</code> {@link Overlays.OverlayType|OverlayType} is for 3D web surfaces.
|
||||
* @typedef {object} Overlays.OverlayProperties-Web
|
||||
* The <code>"web3d"</code> {@link Overlays.OverlayType|OverlayType} is for 3D web surfaces.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Web|Web} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Web3D
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1795,29 +1871,31 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*
|
||||
* @property {boolean} isFacingAvatar - If <code>true</code>, the overlay is rotated to face the user's camera about an axis
|
||||
* parallel to the user's avatar's "up" direction.
|
||||
* @property {string} url - The URL of the Web page to display.
|
||||
* @property {string} scriptURL="" - The URL of a JavaScript file to inject into the Web page.
|
||||
* @property {number} dpi=30 - The dots per inch to display the Web page at, on the overlay.
|
||||
* @property {number} maxFPS=10 - The maximum update rate for the Web overlay content, in frames/second.
|
||||
* @property {string} inputMode=Touch - The user input mode to use - either <code>"Touch"</code> or <code>"Mouse"</code>.
|
||||
* @property {string} url - The URL of the web page to display.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Line"</code> {@link Overlays.OverlayType|OverlayType} is for 3D lines.
|
||||
* @typedef {object} Overlays.OverlayProperties-Line
|
||||
* The <code>"line3d"</code> {@link Overlays.OverlayType|OverlayType} is for 3D lines.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-PolyLine|PolyLine} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Line3D
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
*
|
||||
* @property {Vec3} position - The position of the overlay center. Synonyms: <code>p1</code>, <code>point</code>, and
|
||||
* <code>start</code>.
|
||||
|
|
@ -1827,35 +1905,61 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*
|
||||
* @property {Uuid} endParentID=null - The avatar, entity, or overlay that the end point of the line is parented to.
|
||||
* <p><em>Currently doesn't work.</em></p>
|
||||
* <CURRENTLY BROKEN>
|
||||
* @property {number} endParentJointIndex=65535 - Integer value specifying the skeleton joint that the end point of the line is
|
||||
* attached to if <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint". <CURRENTLY BROKEN>
|
||||
* attached to if <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* <p><em>Currently doesn't work.</em></p>
|
||||
* <CURRENTLY BROKEN>
|
||||
|
||||
* @property {Vec3} start - The start point of the line. Synonyms: <code>startPoint</code> and <code>p1</code>.
|
||||
* <p><em>If <code>parentID<code> is set, use <code>localStart</code> to set the local position of the start point.</em></p>
|
||||
* <CURRENTLY BROKEN>
|
||||
* @property {Vec3} end - The end point of the line. Synonyms: <code>endPoint</code> and <code>p2</code>.
|
||||
* <p><em>If <code>parentID<code> is set, use <code>localEnd</code> to set the local position of the end point.</em></p>
|
||||
* <CURRENTLY BROKEN>
|
||||
|
||||
* @property {Vec3} localStart - The local position of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>start</code>. Synonym: <code>localPosition</code>.
|
||||
* <code>parentID</code> set, otherwise the same value as <code>start</code>.
|
||||
* <CURRENTLY BROKEN>
|
||||
* @property {Vec3} localEnd - The local position of the overlay relative to its parent if the overlay has a
|
||||
* <code>endParentID</code> set, otherwise the same value as <code>end</code>. <CURRENTLY BROKEN>
|
||||
* <code>endParentID</code> set, otherwise the same value as <code>end</code>.
|
||||
* <CURRENTLY BROKEN>
|
||||
|
||||
* @property {number} length - The length of the line, in meters. This can be set after creating a line with start and end
|
||||
* points. <CURRENTLY BROKEN>
|
||||
* points.
|
||||
* <p><em>Currently doesn't work.</em></p>
|
||||
* <CURRENTLY BROKEN>
|
||||
|
||||
* @property {number} glow=0 - If <code>glow > 0</code>, the line is rendered with a glow.
|
||||
* @property {number} lineWidth=0.02 - Width of the line, in meters.
|
||||
* <p><em>You can set this property's value but currently cannot retrieve its value. Use the <code>strokeWidths</code>
|
||||
* property to retrieve its value instead.</p>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Grid"</code> {@link Overlays.OverlayType|OverlayType} is for 3D grid.
|
||||
* The <code>"grid"</code> {@link Overlays.OverlayType|OverlayType} is for 3D grids.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Grid|Grid} entity.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Grid
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> – <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1877,25 +1981,28 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
*
|
||||
* @property {boolean} followCamera=true - If <code>true</code>, the grid is always visible even as the camera moves to another position.
|
||||
* @property {number} majorGridEvery=5 - Integer number of <code>minorGridEvery</code> intervals at which to draw a thick grid line. Minimum value = <code>1</code>.
|
||||
* @property {number} minorGridEvery=1 - Real number of meters at which to draw thin grid lines. Minimum value = <code>0.001</code>.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* The <code>"Circle"</code> {@link Overlays.OverlayType|OverlayType} is for 3D circle.
|
||||
* @typedef {object} Overlays.OverlayProperties-Circle
|
||||
* The <code>"circle3d"</code> {@link Overlays.OverlayType|OverlayType} is for 3D circles.
|
||||
* It has properties in addition to the common {@link Overlays.OverlayProperties|OverlayProperties}.
|
||||
* It additionally has properties per the {@link Entities.EntityProperties-Gizmo|Gizmo} entity, with the
|
||||
* <code>gizmoType</code> property value being <code>"ring"</code>.
|
||||
* <p class="important">Deprecated: Use local {@link Entities} instead.</p>
|
||||
* @typedef {object} Overlays.OverlayProperties-Circle3D
|
||||
* @property {string} name - The name of the overlay.
|
||||
* @property {Color} color=255,255,255 - The color of the overlay.
|
||||
* @property {number} alpha=0.7 - The opacity of the overlay, <code>0.0</code> - <code>1.0</code>.
|
||||
* @property {number} pulseMax=0 - The maximum value of the pulse multiplier.
|
||||
* @property {number} pulseMin=0 - The minimum value of the pulse multiplier.
|
||||
* @property {number} pulsePeriod=1 - The duration of the color and alpha pulse, in seconds. A pulse multiplier value goes from
|
||||
|
|
@ -1912,62 +2019,75 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
|
|||
* @property {Vec3} position - The position of the overlay center. Synonyms: <code>p1</code>, <code>point</code>, and
|
||||
* <code>start</code>.
|
||||
* @property {Vec3} dimensions - The dimensions of the overlay. Synonyms: <code>scale</code>, <code>size</code>.
|
||||
* <em>Read-only.</em>
|
||||
* @property {Quat} rotation - The orientation of the overlay. Synonym: <code>orientation</code>.
|
||||
* @property {Vec3} localPosition - The local position of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>position</code>.
|
||||
* @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a
|
||||
* <code>parentID</code> set, otherwise the same value as <code>rotation</code>. Synonym: <code>localOrientation</code>.
|
||||
* @property {boolean} isSolid=false - Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* @property {boolean} isSolid=false - <code>true</code> if the overlay is rendered as a solid, <code>false</code> if it is
|
||||
* rendered as a wire frame.
|
||||
* Synonyms: <ode>solid</code>, <code>isFilled</code>, and <code>filled</code>.
|
||||
* Antonyms: <code>isWire</code> and <code>wire</code>.
|
||||
* @property {boolean} ignorePickIntersection=false - If <code>true</code>, picks ignore the overlay. <code>ignoreRayIntersection</code> is a synonym.
|
||||
* @property {boolean} drawInFront=false - If <code>true</code>, the overlay is rendered in front of objects in the world, but behind the HUD.
|
||||
* @property {boolean} drawHUDLayer=false - If <code>true</code>, the overlay is rendered in front of everything, including the HUD.
|
||||
* @property {boolean} grabbable=false - Signal to grabbing scripts whether or not this overlay can be grabbed.
|
||||
* @property {boolean} ignorePickIntersection=false - <code>true</code> if {@link Picks} ignore the overlay, <code>false</code>
|
||||
* if they don't.
|
||||
* Synonym: <code>ignoreRayIntersection</code>.
|
||||
* @property {boolean} drawInFront=false - <code>true</code> if the overlay is rendered on top of the world layer but behind
|
||||
* the HUD surface.
|
||||
* @property {boolean} drawHUDLayer=false - <code>true</code> if the overlay is rendered in front of everything, including the
|
||||
* HUD surface.
|
||||
* @property {boolean} grabbable=false - <code>true</code> if the overlay can be grabbed, <code>false</code> if it can't be.
|
||||
* @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to.
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the skeleton joint that the overlay is attached to if
|
||||
* <code>parentID</code> is an avatar skeleton. A value of <code>65535</code> means "no joint".
|
||||
* @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is
|
||||
* parented to if <code>parentID</code> is set. Use 65535 or -1 to parent to the parent's position and orientation rather
|
||||
* than a joint.
|
||||
*
|
||||
* @property {number} startAt = 0 - The counter - clockwise angle from the overlay's x-axis that drawing starts at in degrees.
|
||||
* @property {number} endAt = 360 - The counter - clockwise angle from the overlay's x-axis that drawing ends at in degrees.
|
||||
* @property {number} outerRadius = 1 - The outer radius of the overlay in meters. Synonym: <code>radius</code>.
|
||||
* @property {number} innerRadius = 0 - The inner radius of the overlay in meters.
|
||||
* @property {Color} color = 255, 255, 255 - The color of the overlay. Setting this value also sets the values of
|
||||
* <code>innerStartColor</code>, <code>innerEndColor</code>, <code>outerStartColor</code>, and <code>outerEndColor</code>.
|
||||
* @property {number} startAt=0 - The counter-clockwise angle from the overlay's x-axis that drawing starts at, in degrees.
|
||||
* @property {number} endAt=360 - The counter-clockwise angle from the overlay's x-axis that drawing ends at, in degrees.
|
||||
* @property {number} outerRadius=1 - The outer radius of the overlay in meters. Synonym: <code>radius</code>.
|
||||
* @property {number} innerRadius=0 - The inner radius of the overlay in meters.
|
||||
* @property {Color} color - Sets the color of the overlay. Setting this value sets the values of <code>innerStartColor</code>,
|
||||
* <code>innerEndColor</code>, <code>outerStartColor</code>, and <code>outerEndColor</code>.
|
||||
* <em>Write-only.</em>
|
||||
* @property {Color} startColor - Sets the values of <code>innerStartColor</code> and <code>outerStartColor</code>.
|
||||
* <em>Write - only.</em>
|
||||
* <em>Write-only.</em>
|
||||
* @property {Color} endColor - Sets the values of <code>innerEndColor</code> and <code>outerEndColor</code>.
|
||||
* <em>Write - only.</em>
|
||||
* <em>Write-only.</em>
|
||||
* @property {Color} innerColor - Sets the values of <code>innerStartColor</code> and <code>innerEndColor</code>.
|
||||
* <em>Write - only.</em>
|
||||
* <em>Write-only.</em>
|
||||
* @property {Color} outerColor - Sets the values of <code>outerStartColor</code> and <code>outerEndColor</code>.
|
||||
* <em>Write - only.</em>
|
||||
* @property {Color} innerStartcolor - The color at the inner start point of the overlay.
|
||||
* @property {Color} innerEndColor - The color at the inner end point of the overlay.
|
||||
* @property {Color} outerStartColor - The color at the outer start point of the overlay.
|
||||
* @property {Color} outerEndColor - The color at the outer end point of the overlay.
|
||||
* @property {number} alpha = 0.5 - The opacity of the overlay, <code>0.0</code> -<code>1.0</code>. Setting this value also sets
|
||||
* the values of <code>innerStartAlpha</code>, <code>innerEndAlpha</code>, <code>outerStartAlpha</code>, and
|
||||
* <code>outerEndAlpha</code>. Synonym: <code>Alpha</code>; <em>write - only</em>.
|
||||
* <em>Write-only.</em>
|
||||
* @property {Color} innerStartcolor=255,255,255 - The color at the inner start point of the overlay.
|
||||
* @property {Color} innerEndColor=255,255,255 - The color at the inner end point of the overlay.
|
||||
* @property {Color} outerStartColor=255,255,255 - The color at the outer start point of the overlay.
|
||||
* @property {Color} outerEndColor=255,255,255 - The color at the outer end point of the overlay.
|
||||
* @property {number} alpha - Sets the opacity of the overlay, <code>0.0</code> – <code>1.0</code>. Setting this value
|
||||
* sets the values of <code>innerStartAlpha</code>, <code>innerEndAlpha</code>, <code>outerStartAlpha</code>, and
|
||||
* <code>outerEndAlpha</code>. Synonym: <code>Alpha</code>.
|
||||
* @property {number} startAlpha - Sets the values of <code>innerStartAlpha</code> and <code>outerStartAlpha</code>.
|
||||
* <em>Write - only.</em>
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} endAlpha - Sets the values of <code>innerEndAlpha</code> and <code>outerEndAlpha</code>.
|
||||
* <em>Write - only.</em>
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} innerAlpha - Sets the values of <code>innerStartAlpha</code> and <code>innerEndAlpha</code>.
|
||||
* <em>Write - only.</em>
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} outerAlpha - Sets the values of <code>outerStartAlpha</code> and <code>outerEndAlpha</code>.
|
||||
* <em>Write - only.</em>
|
||||
* @property {number} innerStartAlpha = 0 - The alpha at the inner start point of the overlay.
|
||||
* @property {number} innerEndAlpha = 0 - The alpha at the inner end point of the overlay.
|
||||
* @property {number} outerStartAlpha = 0 - The alpha at the outer start point of the overlay.
|
||||
* @property {number} outerEndAlpha = 0 - The alpha at the outer end point of the overlay.
|
||||
* <em>Write-only.</em>
|
||||
* @property {number} innerStartAlpha=0.7 - The opacity at the inner start point of the overlay, <code>0.0</code> –
|
||||
* <code>1.0</code>.
|
||||
* @property {number} innerEndAlpha=0.7 - The opacity at the inner end point of the overlay, <code>0.0</code> –
|
||||
* <code>1.0</code>.
|
||||
* @property {number} outerStartAlpha=0.7 - The opacity at the outer start point of the overlay, <code>0.0</code> –
|
||||
* <code>1.0</code>.
|
||||
* @property {number} outerEndAlpha=0.7 - The opacity at the outer end point of the overlay, <code>0.0</code> –
|
||||
* <code>1.0</code>.
|
||||
*
|
||||
* @property {boolean} hasTickMarks = false - If <code>true</code>, tick marks are drawn.
|
||||
* @property {number} majorTickMarksAngle = 0 - The angle between major tick marks, in degrees.
|
||||
* @property {number} minorTickMarksAngle = 0 - The angle between minor tick marks, in degrees.
|
||||
* @property {number} majorTickMarksLength = 0 - The length of the major tick marks, in meters. A positive value draws tick marks
|
||||
* @property {boolean} hasTickMarks=false - <code>true</code> if tick marks are drawn, <code>false</code> if they aren't.
|
||||
* @property {number} majorTickMarksAngle=0 - The angle between major tick marks, in degrees.
|
||||
* @property {number} minorTickMarksAngle=0 - The angle between minor tick marks, in degrees.
|
||||
* @property {number} majorTickMarksLength=0 - The length of the major tick marks, in meters. A positive value draws tick marks
|
||||
* outwards from the inner radius; a negative value draws tick marks inwards from the outer radius.
|
||||
* @property {number} minorTickMarksLength = 0 - The length of the minor tick marks, in meters. A positive value draws tick marks
|
||||
* @property {number} minorTickMarksLength=0 - The length of the minor tick marks, in meters. A positive value draws tick marks
|
||||
* outwards from the inner radius; a negative value draws tick marks inwards from the outer radius.
|
||||
* @property {Color} majorTickMarksColor = 0, 0, 0 - The color of the major tick marks.
|
||||
* @property {Color} minorTickMarksColor = 0, 0, 0 - The color of the minor tick marks.
|
||||
* @property {Color} majorTickMarksColor=0,0,0 - The color of the major tick marks.
|
||||
* @property {Color} minorTickMarksColor=0,0,0 - The color of the minor tick marks.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -68,17 +68,23 @@ public:
|
|||
};
|
||||
|
||||
/**jsdoc
|
||||
* (Note: 3D Overlays are deprecated. Use local entities instead.) The Overlays API provides facilities to create and interact with overlays. Overlays are 2D and 3D objects visible only to
|
||||
* yourself and that aren't persisted to the domain. They are used for UI.
|
||||
* The <code>Overlays</code> API provides facilities to create and interact with overlays. These are 2D and 3D objects visible
|
||||
* only to yourself and that aren't persisted to the domain. They are used for UI.
|
||||
*
|
||||
* <p><strong>Note:</strong> 3D overlays are local {@link Entities}, internally, so many of the methods also work with
|
||||
* entities.</p>
|
||||
*
|
||||
* <p class="important">3D overlays are deprecated: Use local {@link Entities} for these instead.</p>
|
||||
*
|
||||
* @namespace Overlays
|
||||
*
|
||||
* @hifi-interface
|
||||
* @hifi-client-entity
|
||||
* @hifi-avatar
|
||||
*
|
||||
* @property {Uuid} keyboardFocusOverlay - Get or set the {@link Entities.EntityTypes|Web} entity that has keyboard focus.
|
||||
* If no entity has keyboard focus, returns <code>null</code>; set to <code>null</code> or {@link Uuid(0)|Uuid.NULL} to
|
||||
* clear keyboard focus.
|
||||
* @property {Uuid} keyboardFocusOverlay - The <code>{@link Overlays.OverlayProperties-Web3D|"web3d"}</code> overlay
|
||||
* ({@link Entities.EntityProperties-Web|Web} entity) that has keyboard focus. If no overlay (entity) has keyboard focus,
|
||||
* returns <code>null</code>; set to <code>null</code> or {@link Uuid(0)|Uuid.NULL} to clear keyboard focus.
|
||||
*/
|
||||
|
||||
class Overlays : public QObject {
|
||||
|
|
@ -118,7 +124,7 @@ public:
|
|||
|
||||
public slots:
|
||||
/**jsdoc
|
||||
* Add an overlay to the scene.
|
||||
* Adds an overlay to the scene.
|
||||
* @function Overlays.addOverlay
|
||||
* @param {Overlays.OverlayType} type - The type of the overlay to add.
|
||||
* @param {Overlays.OverlayProperties} properties - The properties of the overlay to add.
|
||||
|
|
@ -134,19 +140,21 @@ public slots:
|
|||
QUuid addOverlay(const QString& type, const QVariant& properties);
|
||||
|
||||
/**jsdoc
|
||||
* Create a clone of an existing entity (or 2D overlay).
|
||||
* Creates a clone of an existing overlay (or entity).
|
||||
* <p>Note: For cloning behavior of 3D overlays and entities, see {@link Entities.cloneEntity}.</p>
|
||||
* @function Overlays.cloneOverlay
|
||||
* @param {Uuid} id - The ID of the entity/2D overlay to clone.
|
||||
* @returns {Uuid} The ID of the new object if successful, otherwise {@link Uuid(0)|Uuid.NULL}.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) to clone.
|
||||
* @returns {Uuid} The ID of the new overlay (or entity) if successful, otherwise {@link Uuid(0)|Uuid.NULL}.
|
||||
*/
|
||||
QUuid cloneOverlay(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Edit an overlay's properties.
|
||||
* Edits an overlay's (or entity's) properties.
|
||||
* @function Overlays.editOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to edit.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) to edit.
|
||||
* @param {Overlays.OverlayProperties} properties - The properties changes to make.
|
||||
* @returns {boolean} <code>true</code> if the overlay was found and edited, otherwise <code>false</code>.
|
||||
* @returns {boolean} <code>false</code> if Interface is exiting. Otherwise, if a 2D overlay then <code>true</code> always,
|
||||
* and if a 3D overlay then <code>true</code> if the overlay was found and edited, otherwise <code>false</code>.
|
||||
* @example <caption>Add an overlay in front of your avatar then change its color.</caption>
|
||||
* var overlay = Overlays.addOverlay("cube", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),
|
||||
|
|
@ -163,12 +171,11 @@ public slots:
|
|||
bool editOverlay(const QUuid& id, const QVariant& properties);
|
||||
|
||||
/**jsdoc
|
||||
* Edit multiple overlays' properties.
|
||||
* Edits the properties of multiple overlays (or entities).
|
||||
* @function Overlays.editOverlays
|
||||
* @param propertiesById {object.<Uuid, Overlays.OverlayProperties>} - An object with overlay IDs as keys and
|
||||
* @param propertiesById {object.<Uuid, Overlays.OverlayProperties>} - An object with overlay (or entity) IDs as keys and
|
||||
* {@link Overlays.OverlayProperties|OverlayProperties} edits to make as values.
|
||||
* @returns {boolean} <code>true</code> if all overlays were found and edited, otherwise <code>false</code> (some may have
|
||||
* been found and edited).
|
||||
* @returns {boolean} <code>false</code> if Interface is exiting, otherwise <code>true</code>.
|
||||
* @example <caption>Create two overlays in front of your avatar then change their colors.</caption>
|
||||
* var overlayA = Overlays.addOverlay("cube", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: -0.3, y: 0, z: -3 })),
|
||||
|
|
@ -192,18 +199,18 @@ public slots:
|
|||
bool editOverlays(const QVariant& propertiesById);
|
||||
|
||||
/**jsdoc
|
||||
* Delete an entity or 2D overlay.
|
||||
* Deletes an overlay (or entity).
|
||||
* @function Overlays.deleteOverlay
|
||||
* @param {Uuid} id - The ID of the object to delete.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) to delete.
|
||||
*/
|
||||
void deleteOverlay(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Get the type of an entity or 2D overlay.
|
||||
* Gets the type of an overlay.
|
||||
* @function Overlays.getOverlayType
|
||||
* @param {Uuid} id - The ID of the object to get the type of.
|
||||
* @returns {string} The type of the object if found, otherwise an empty string.
|
||||
* @example <caption>Create an object in front of your avatar then get and report its type.</caption>
|
||||
* @param {Uuid} id - The ID of the overlay to get the type of.
|
||||
* @returns {Overlays.OverlayType} The type of the overlay if found, otherwise <code>"unknown"</code>.
|
||||
* @example <caption>Create an overlay in front of your avatar then get and report its type.</caption>
|
||||
* var overlay = Overlays.addOverlay("cube", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),
|
||||
* rotation: MyAvatar.orientation,
|
||||
|
|
@ -211,56 +218,82 @@ public slots:
|
|||
* solid: true
|
||||
* });
|
||||
* var type = Overlays.getOverlayType(overlay);
|
||||
* print("Type: " + type);
|
||||
* print("Type: " + type); // cube
|
||||
*/
|
||||
QString getOverlayType(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Get the overlay script object. In particular, this is useful for accessing the event bridge for a <code>web3d</code>
|
||||
* overlay.
|
||||
* Gets an overlay's (or entity's) script object. In particular, this is useful for accessing a
|
||||
* <code>{@link Overlays.OverlayProperties-Web3D|"web3d"}</code> overlay's <code>EventBridge</code> script object to
|
||||
* exchange messages with the web page script.
|
||||
* <p>To send a message from an Interface script to a <code>"web3d"</code> overlay over its event bridge:</p>
|
||||
* <pre class="prettyprint"><code>var overlayObject = Overlays.getOverlayObject(overlayID);
|
||||
* overlayObject.emitScriptEvent(message);</code></pre>
|
||||
* <p>To receive a message from a <code>"web3d"</code> overlay over its event bridge in an Interface script:</p>
|
||||
* <pre class="prettyprint"><code>var overlayObject = Overlays.getOverlayObject(overlayID);
|
||||
* overlayObject.webEventReceived.connect(function(message) {
|
||||
* ...
|
||||
* };</code></pre>
|
||||
* @function Overlays.getOverlayObject
|
||||
* @param {Uuid} overlayID - The ID of the overlay to get the script object of.
|
||||
* @returns {object} The script object for the overlay if found.
|
||||
* @example <caption>Receive "hello" messages from a <code>web3d</code> overlay.</caption>
|
||||
* // HTML file: name "web3d.html".
|
||||
* @example <caption>Exchange messages with a <code>"web3d"</code> overlay.</caption>
|
||||
* // HTML file, name: "web3d.html".
|
||||
* <!DOCTYPE html>
|
||||
* <html>
|
||||
* <head>
|
||||
* <title>HELLO</title>
|
||||
* </head>
|
||||
* <body>
|
||||
* <h1>HELLO</h1></h1>
|
||||
* <h1>HELLO</h1>
|
||||
* <script>
|
||||
* function onScriptEventReceived(message) {
|
||||
* // Message received from the script.
|
||||
* console.log("Message received: " + message);
|
||||
* }
|
||||
*
|
||||
* EventBridge.scriptEventReceived.connect(onScriptEventReceived);
|
||||
*
|
||||
* setInterval(function () {
|
||||
* // Send a message to the script.
|
||||
* EventBridge.emitWebEvent("hello");
|
||||
* }, 2000);
|
||||
* </script>
|
||||
* </body>
|
||||
* </html>
|
||||
*
|
||||
* // Script file.
|
||||
* var web3dOverlay = Overlays.addOverlay("web3d", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, {x: 0, y: 0.5, z: -3 })),
|
||||
* rotation: MyAvatar.orientation,
|
||||
* url: Script.resolvePath("web3d.html"),
|
||||
* alpha: 1.0
|
||||
* });
|
||||
*
|
||||
* function onWebEventReceived(event) {
|
||||
* print("onWebEventReceived() : " + JSON.stringify(event));
|
||||
*
|
||||
* // Interface script file.
|
||||
* var web3DOverlay = Overlays.addOverlay("web3d", {
|
||||
* type: "Web",
|
||||
* position : Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y : 0.5, z : -3 })),
|
||||
* rotation : MyAvatar.orientation,
|
||||
* sourceUrl : Script.resolvePath("web3d.html"),
|
||||
* alpha : 1.0
|
||||
* });
|
||||
*
|
||||
* var overlayObject;
|
||||
*
|
||||
* function onWebEventReceived(message) {
|
||||
* // Message received.
|
||||
* print("Message received: " + message);
|
||||
*
|
||||
* // Send a message back.
|
||||
* overlayObject.emitScriptEvent(message + " back");
|
||||
* }
|
||||
*
|
||||
* overlayObject = Overlays.getOverlayObject(web3dOverlay);
|
||||
* overlayObject.webEventReceived.connect(onWebEventReceived);
|
||||
*
|
||||
* Script.scriptEnding.connect(function () {
|
||||
* Overlays.deleteOverlay(web3dOverlay);
|
||||
*
|
||||
* Script.setTimeout(function() {
|
||||
* overlayObject = Overlays.getOverlayObject(web3DOverlay);
|
||||
* overlayObject.webEventReceived.connect(onWebEventReceived);
|
||||
* }, 500);
|
||||
*
|
||||
* Script.scriptEnding.connect(function() {
|
||||
* Overlays.deleteOverlay(web3DOverlay);
|
||||
* });
|
||||
*/
|
||||
QObject* getOverlayObject(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Get the ID of the 2D overlay at a particular point on the screen or HUD.
|
||||
* Gets the ID of the 2D overlay at a particular point on the desktop screen or HUD surface.
|
||||
* @function Overlays.getOverlayAtPoint
|
||||
* @param {Vec2} point - The point to check for an overlay.
|
||||
* @returns {Uuid} The ID of the 2D overlay at the specified point if found, otherwise <code>null</code>.
|
||||
|
|
@ -279,10 +312,11 @@ public slots:
|
|||
QUuid getOverlayAtPoint(const glm::vec2& point);
|
||||
|
||||
/**jsdoc
|
||||
* Get the value of a 3D overlay's property.
|
||||
* Gets a specified property value of a 3D overlay (or entity).
|
||||
* <p><strong>Note:</strong> 2D overlays' property values cannot be retrieved.</p>
|
||||
* @function Overlays.getProperty
|
||||
* @param {Uuid} id - The ID of the overlay. <em>Must be for a 3D {@link Overlays.OverlayType|OverlayType}.</em>
|
||||
* @param {string} property - The name of the property value to get.
|
||||
* @param {Uuid} id - The ID of the 3D overlay (or entity).
|
||||
* @param {string} property - The name of the property to get the value of.
|
||||
* @returns {object} The value of the property if the 3D overlay and property can be found, otherwise
|
||||
* <code>undefined</code>.
|
||||
* @example <caption>Create an overlay in front of your avatar then report its alpha property value.</caption>
|
||||
|
|
@ -298,12 +332,13 @@ public slots:
|
|||
QVariant getProperty(const QUuid& id, const QString& property);
|
||||
|
||||
/**jsdoc
|
||||
* Get the values of an overlay's properties.
|
||||
* Gets specified property values of a 3D overlay (or entity).
|
||||
* <p><strong>Note:</strong> 2D overlays' property values cannot be retrieved.</p>
|
||||
* @function Overlays.getProperties
|
||||
* @param {Uuid} id - The ID of the overlay.
|
||||
* @param {Array.<string>} properties - An array of names of properties to get the values of.
|
||||
* @returns {Overlays.OverlayProperties} The values of valid properties if the overlay can be found, otherwise
|
||||
* <code>undefined</code>.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity).
|
||||
* @param {Array.<string>} properties - The names of the properties to get the values of.
|
||||
* @returns {Overlays.OverlayProperties} The values of valid properties if the overlay can be found, otherwise an empty
|
||||
* object.
|
||||
* @example <caption>Create an overlay in front of your avatar then report some of its properties.</caption>
|
||||
* var overlay = Overlays.addOverlay("cube", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),
|
||||
|
|
@ -317,11 +352,11 @@ public slots:
|
|||
QVariantMap getProperties(const QUuid& id, const QStringList& properties);
|
||||
|
||||
/**jsdoc
|
||||
* Get the values of multiple overlays' properties.
|
||||
* Gets the values of multiple overlays' (or entities') properties.
|
||||
* @function Overlays.getOverlaysProperties
|
||||
* @param propertiesById {object.<Uuid, Array.<string>>} - An object with overlay IDs as keys and arrays of the names of
|
||||
* properties to get for each as values.
|
||||
* @returns {object.<Uuid, Overlays.OverlayProperties>} An object with overlay IDs as keys and
|
||||
* @param propertiesById {object.<Uuid, Array.<string>>} - An object with overlay (or entity) IDs as keys and arrays of the
|
||||
* names of properties to get for each as values.
|
||||
* @returns {object.<Uuid, Overlays.OverlayProperties>} An object with overlay (or entity) IDs as keys and
|
||||
* {@link Overlays.OverlayProperties|OverlayProperties} as values.
|
||||
* @example <caption>Create two cube overlays in front of your avatar then get some of their properties.</caption>
|
||||
* var overlayA = Overlays.addOverlay("cube", {
|
||||
|
|
@ -345,22 +380,20 @@ public slots:
|
|||
QVariantMap getOverlaysProperties(const QVariant& overlaysProperties);
|
||||
|
||||
/**jsdoc
|
||||
* Find the closest 3D overlay intersected by a {@link PickRay}. Overlays with their <code>drawInFront</code> property set
|
||||
* to <code>true</code> have priority over overlays that don't, except that tablet overlays have priority over any
|
||||
* <code>drawInFront</code> overlays behind them. I.e., if a <code>drawInFront</code> overlay is behind one that isn't
|
||||
* <code>drawInFront</code>, the <code>drawInFront</code> overlay is returned, but if a tablet overlay is in front of a
|
||||
* <code>drawInFront</code> overlay, the tablet overlay is returned.
|
||||
* Finds the closest 3D overlay (or local entity) intersected by a {@link PickRay}.
|
||||
* @function Overlays.findRayIntersection
|
||||
* @param {PickRay} pickRay - The PickRay to use for finding overlays.
|
||||
* @param {boolean} [precisionPicking=false] - <em>Unused</em>; exists to match Entity API.
|
||||
* @param {Array.<Uuid>} [include=[]] - If not empty then the search is restricted to these overlays.
|
||||
* @param {Array.<Uuid>} [discard=[]] - Overlays to ignore during the search.
|
||||
* @param {boolean} [visibleOnly=false] - If <code>true</code> then only entities that are
|
||||
* <code>{@link Entities.EntityProperties|visible}<code> are searched.
|
||||
* @param {boolean} [collideableOnly=false] - If <code>true</code> then only entities that are not
|
||||
* <code>{@link Entities.EntityProperties|collisionless}</code> are searched.
|
||||
* @returns {Overlays.RayToOverlayIntersectionResult} The closest 3D overlay intersected by <code>pickRay</code>, taking
|
||||
* into account <code>overlayIDsToInclude</code> and <code>overlayIDsToExclude</code> if they're not empty.
|
||||
* @param {boolean} [precisionPicking=false] - <code>true</code> to pick against precise meshes, <code>false</code> to pick
|
||||
* against coarse meshes. If <code>true</code> and the intersected entity is a model, the result's
|
||||
* <code>extraInfo</code> property includes more information than it otherwise would.
|
||||
* @param {Array.<Uuid>} [include=[]] - If not empty, then the search is restricted to these overlays (and local entities).
|
||||
* @param {Array.<Uuid>} [discard=[]] - Overlays (and local entities) to ignore during the search.
|
||||
* @param {boolean} [visibleOnly=false] - <code>true</code> if only overlays (and local entities) that are
|
||||
* <code>{@link Overlays.OverlayProperties|visible}</code> should be searched.
|
||||
* @param {boolean} [collideableOnly=false] - <code>true</code> if only local entities that are not
|
||||
* <code>{@link Entities.EntityProperties|collisionless}</code> should be searched.
|
||||
* @returns {Overlays.RayToOverlayIntersectionResult} The result of the search for the first intersected overlay (or local
|
||||
* entity.
|
||||
* @example <caption>Create a cube overlay in front of your avatar. Report 3D overlay intersection details for mouse
|
||||
* clicks.</caption>
|
||||
* var overlay = Overlays.addOverlay("cube", {
|
||||
|
|
@ -384,12 +417,13 @@ public slots:
|
|||
bool collidableOnly = false);
|
||||
|
||||
/**jsdoc
|
||||
* Return a list of local entities with bounding boxes that touch a search sphere.
|
||||
* Gets a list of visible 3D overlays (local entities) with bounding boxes that touch a search sphere.
|
||||
* @function Overlays.findOverlays
|
||||
* @param {Vec3} center - The center of the search sphere.
|
||||
* @param {number} radius - The radius of the search sphere.
|
||||
* @returns {Uuid[]} An array of entity IDs with bounding boxes that touch a search sphere.
|
||||
* @example <caption>Create two cube entities in front of your avatar then search for entities near your avatar.</caption>
|
||||
* @returns {Uuid[]} The IDs of the overlays (local entities) that are visible and have bounding boxes that touch a search
|
||||
* sphere.
|
||||
* @example <caption>Create two overlays in front of your avatar then search for overlays near your avatar.</caption>
|
||||
* var overlayA = Overlays.addOverlay("cube", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: -0.3, y: 0, z: -3 })),
|
||||
* rotation: MyAvatar.orientation,
|
||||
|
|
@ -411,11 +445,13 @@ public slots:
|
|||
QVector<QUuid> findOverlays(const glm::vec3& center, float radius);
|
||||
|
||||
/**jsdoc
|
||||
* Check whether an overlay's assets have been loaded. For example, for an <code>image</code> overlay the result indicates
|
||||
* whether its image has been loaded.
|
||||
* Checks whether an overlay's (or entity's) assets have been loaded. For example, for an
|
||||
* <code>{@link Overlays.OverlayProperties-Image|"image"}</code> overlay, the result indicates whether its image has been
|
||||
* loaded.
|
||||
* @function Overlays.isLoaded
|
||||
* @param {Uuid} id - The ID of the overlay to check.
|
||||
* @returns {boolean} <code>true</code> if the overlay's assets have been loaded, otherwise <code>false</code>.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) to check.
|
||||
* @returns {boolean} <code>true</code> if the overlay's (or entity's) assets have been loaded, otherwise
|
||||
* <code>false</code>.
|
||||
* @example <caption>Create an image overlay and report whether its image is loaded after 1s.</caption>
|
||||
* var overlay = Overlays.addOverlay("image", {
|
||||
* bounds: { x: 100, y: 100, width: 200, height: 200 },
|
||||
|
|
@ -429,55 +465,60 @@ public slots:
|
|||
bool isLoaded(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Calculates the size of the given text in the specified object if it is a text entity or overlay.
|
||||
* Calculates the size of some text in a text overlay (or entity). The overlay (or entity) need not be set visible.
|
||||
* <p><strong>Note:</strong> The size of text in a 3D overlay (or entity) cannot be calculated immediately after the
|
||||
* overlay (or entity) is created; a short delay is required while the overlay (or entity) finishes being created.</p>
|
||||
* @function Overlays.textSize
|
||||
* @param {Uuid} id - The ID of the object to use for calculation.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) to use for calculation.
|
||||
* @param {string} text - The string to calculate the size of.
|
||||
* @returns {Size} The size of the <code>text</code> if the object is a text entity or overlay, otherwise
|
||||
* <code>{ height: 0, width : 0 }</code>. If the object is a 2D overlay, the size is in pixels; if the object is an entity,
|
||||
* the size is in meters.
|
||||
* @returns {Size} The size of the <code>text</code> if the object is a text overlay (or entity), otherwise
|
||||
* <code>{ height: 0, width : 0 }</code>. If the object is a 2D overlay, the size is in pixels; if the object is a 3D
|
||||
* overlay (or entity), the size is in meters.
|
||||
* @example <caption>Calculate the size of "hello" in a 3D text entity.</caption>
|
||||
* var overlay = Overlays.addOverlay("text3d", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -2 })),
|
||||
* rotation: MyAvatar.orientation,
|
||||
* text: "hello",
|
||||
* lineHeight: 0.2
|
||||
* lineHeight: 0.2,
|
||||
* visible: false
|
||||
* });
|
||||
* var textSize = Overlays.textSize(overlay, "hello");
|
||||
* print("Size of \"hello\": " + JSON.stringify(textSize));
|
||||
*
|
||||
* Script.setTimeout(function() {
|
||||
* var textSize = Overlays.textSize(overlay, "hello");
|
||||
* print("Size of \"hello\": " + JSON.stringify(textSize));
|
||||
* }, 500);
|
||||
*/
|
||||
QSizeF textSize(const QUuid& id, const QString& text);
|
||||
|
||||
/**jsdoc
|
||||
* Get the width of the window or HUD.
|
||||
* Gets the width of the Interface window or HUD surface.
|
||||
* @function Overlays.width
|
||||
* @returns {number} The width, in pixels, of the Interface window if in desktop mode or the HUD if in HMD mode.
|
||||
* @returns {number} The width, in pixels, of the Interface window if in desktop mode or the HUD surface if in HMD mode.
|
||||
*/
|
||||
float width();
|
||||
|
||||
/**jsdoc
|
||||
* Get the height of the window or HUD.
|
||||
* Gets the height of the Interface window or HUD surface.
|
||||
* @function Overlays.height
|
||||
* @returns {number} The height, in pixels, of the Interface window if in desktop mode or the HUD if in HMD mode.
|
||||
* @returns {number} The height, in pixels, of the Interface window if in desktop mode or the HUD surface if in HMD mode.
|
||||
*/
|
||||
float height();
|
||||
|
||||
/**jsdoc
|
||||
* Check if there is an object of a given ID.
|
||||
* Checks if an overlay (or entity) exists.
|
||||
* @function Overlays.isAddedOverlay
|
||||
* @param {Uuid} id - The ID to check.
|
||||
* @returns {boolean} <code>true</code> if an object with the given ID exists, <code>false</code> otherwise.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) to check.
|
||||
* @returns {boolean} <code>true</code> if an overlay (or entity) with the given ID exists, <code>false</code> if it doesn't.
|
||||
*/
|
||||
bool isAddedOverlay(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Generate a mouse press event on an overlay.
|
||||
* Generates a mouse press event on an overlay (or local entity).
|
||||
* @function Overlays.sendMousePressOnOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to generate a mouse press event on.
|
||||
* @param {Uuid} id - The ID of the overlay (or local entity) to generate a mouse press event on.
|
||||
* @param {PointerEvent} event - The mouse press event details.
|
||||
* @example <caption>Create a 2D rectangle overlay plus a 3D cube overlay and generate mousePressOnOverlay events for the 2D
|
||||
* overlay.</caption>
|
||||
* var overlay = Overlays.addOverlay("cube", {
|
||||
* @example <caption>Create a 2D rectangle overlay plus a 3D cube overlay and generate mousePressOnOverlay events for the
|
||||
* 2D overlay.</caption>
|
||||
* var overlay3D = Overlays.addOverlay("cube", {
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),
|
||||
* rotation: MyAvatar.orientation,
|
||||
* dimensions: { x: 0.3, y: 0.3, z: 0.3 },
|
||||
|
|
@ -485,7 +526,7 @@ public slots:
|
|||
* });
|
||||
* print("3D overlay: " + overlay);
|
||||
*
|
||||
* var overlay = Overlays.addOverlay("rectangle", {
|
||||
* var overlay2D = Overlays.addOverlay("rectangle", {
|
||||
* bounds: { x: 100, y: 100, width: 200, height: 100 },
|
||||
* color: { red: 255, green: 255, blue: 255 }
|
||||
* });
|
||||
|
|
@ -511,66 +552,69 @@ public slots:
|
|||
void sendMousePressOnOverlay(const QUuid& id, const PointerEvent& event);
|
||||
|
||||
/**jsdoc
|
||||
* Generate a mouse release event on an overlay.
|
||||
* Generates a mouse release event on an overlay (or local entity).
|
||||
* @function Overlays.sendMouseReleaseOnOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to generate a mouse release event on.
|
||||
* @param {Uuid} id - The ID of the overlay (or local entity) to generate a mouse release event on.
|
||||
* @param {PointerEvent} event - The mouse release event details.
|
||||
*/
|
||||
void sendMouseReleaseOnOverlay(const QUuid& id, const PointerEvent& event);
|
||||
|
||||
/**jsdoc
|
||||
* Generate a mouse move event on an overlay.
|
||||
* Generates a mouse move event on an overlay (or local entity).
|
||||
* @function Overlays.sendMouseMoveOnOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to generate a mouse move event on.
|
||||
* @param {Uuid} id - The ID of the overlay (or local entity) to generate a mouse move event on.
|
||||
* @param {PointerEvent} event - The mouse move event details.
|
||||
*/
|
||||
void sendMouseMoveOnOverlay(const QUuid& id, const PointerEvent& event);
|
||||
|
||||
/**jsdoc
|
||||
* Generate a hover enter event on an overlay.
|
||||
* Generates a hover enter event on an overlay (or local entity).
|
||||
* @function Overlays.sendHoverEnterOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to generate a hover enter event on.
|
||||
* @param {Uuid} id - The ID of the overlay (or local entity) to generate a hover enter event on.
|
||||
* @param {PointerEvent} event - The hover enter event details.
|
||||
*/
|
||||
void sendHoverEnterOverlay(const QUuid& id, const PointerEvent& event);
|
||||
|
||||
/**jsdoc
|
||||
* Generate a hover over event on an overlay.
|
||||
* Generates a hover over event on an overlay (or entity).
|
||||
* @function Overlays.sendHoverOverOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to generate a hover over event on.
|
||||
* @param {Uuid} id - The ID of the overlay (or local entity) to generate a hover over event on.
|
||||
* @param {PointerEvent} event - The hover over event details.
|
||||
*/
|
||||
void sendHoverOverOverlay(const QUuid& id, const PointerEvent& event);
|
||||
|
||||
/**jsdoc
|
||||
* Generate a hover leave event on an overlay.
|
||||
* Generates a hover leave event on an overlay (or local entity).
|
||||
* @function Overlays.sendHoverLeaveOverlay
|
||||
* @param {Uuid} id - The ID of the overlay to generate a hover leave event on.
|
||||
* @param {Uuid} id - The ID of the overlay (or local entity) to generate a hover leave event on.
|
||||
* @param {PointerEvent} event - The hover leave event details.
|
||||
*/
|
||||
void sendHoverLeaveOverlay(const QUuid& id, const PointerEvent& event);
|
||||
|
||||
/**jsdoc
|
||||
* Get the ID of the Web3D entity that has keyboard focus.
|
||||
* Gets the ID of the <code>{@link Overlays.OverlayProperties-Web3D|"web3d"}</code> overlay
|
||||
* ({@link Entities.EntityProperties-Web|Web} entity) that has keyboard focus.
|
||||
* @function Overlays.getKeyboardFocusOverlay
|
||||
* @returns {Uuid} The ID of the {@link Entities.EntityTypes|Web} overlay that has focus, if any, otherwise
|
||||
* <code>null</code>.
|
||||
* @returns {Uuid} The ID of the <code>{@link Overlays.OverlayProperties-Web3D|"web3d"}</code> overlay
|
||||
* ({@link Entities.EntityProperties-Web|Web} entity) that has focus, if any, otherwise <code>null</code>.
|
||||
*/
|
||||
QUuid getKeyboardFocusOverlay() { return DependencyManager::get<EntityScriptingInterface>()->getKeyboardFocusEntity(); }
|
||||
|
||||
/**jsdoc
|
||||
* Set the Web3D entity that has keyboard focus.
|
||||
* Sets the <code>{@link Overlays.OverlayProperties-Web3D|"web3d"}</code> overlay
|
||||
* ({@link Entities.EntityProperties-Web|Web} entity) that has keyboard focus.
|
||||
* @function Overlays.setKeyboardFocusOverlay
|
||||
* @param {Uuid} id - The ID of the {@link Entities.EntityTypes|Web} entity to set keyboard focus to. Use
|
||||
* <code>null</code> or {@link Uuid(0)|Uuid.NULL} to unset keyboard focus from an overlay.
|
||||
* @param {Uuid} id - The ID of the <code>{@link Overlays.OverlayProperties-Web3D|"web3d"}</code> overlay
|
||||
* ({@link Entities.EntityProperties-Web|Web} entity) to set keyboard focus to. Use <code>null</code> or
|
||||
* {@link Uuid(0)|Uuid.NULL} to unset keyboard focus from an overlay (entity).
|
||||
*/
|
||||
void setKeyboardFocusOverlay(const QUuid& id) { DependencyManager::get<EntityScriptingInterface>()->setKeyboardFocusEntity(id); }
|
||||
|
||||
signals:
|
||||
/**jsdoc
|
||||
* Triggered when an overlay is deleted.
|
||||
* Triggered when an overlay (or entity) is deleted.
|
||||
* @function Overlays.overlayDeleted
|
||||
* @param {Uuid} id - The ID of the overlay that was deleted.
|
||||
* @param {Uuid} id - The ID of the overlay (or entity) that was deleted.
|
||||
* @returns {Signal}
|
||||
* @example <caption>Create an overlay then delete it after 1s.</caption>
|
||||
* var overlay = Overlays.addOverlay("cube", {
|
||||
|
|
|
|||
|
|
@ -1904,6 +1904,61 @@ void Rig::updateFeet(bool leftFootEnabled, bool rightFootEnabled, bool headEnabl
|
|||
}
|
||||
}
|
||||
|
||||
void Rig::updateReactions(const ControllerParameters& params) {
|
||||
|
||||
// enable/disable animVars
|
||||
bool enabled = params.reactionEnabledFlags[AVATAR_REACTION_POSITIVE];
|
||||
_animVars.set("reactionPositiveEnabled", enabled);
|
||||
_animVars.set("reactionPositiveDisabled", !enabled);
|
||||
|
||||
enabled = params.reactionEnabledFlags[AVATAR_REACTION_NEGATIVE];
|
||||
_animVars.set("reactionNegativeEnabled", enabled);
|
||||
_animVars.set("reactionNegativeDisabled", !enabled);
|
||||
|
||||
enabled = params.reactionEnabledFlags[AVATAR_REACTION_RAISE_HAND];
|
||||
_animVars.set("reactionRaiseHandEnabled", enabled);
|
||||
_animVars.set("reactionRaiseHandDisabled", !enabled);
|
||||
|
||||
enabled = params.reactionEnabledFlags[AVATAR_REACTION_APPLAUD];
|
||||
_animVars.set("reactionApplaudEnabled", enabled);
|
||||
_animVars.set("reactionApplaudDisabled", !enabled);
|
||||
|
||||
enabled = params.reactionEnabledFlags[AVATAR_REACTION_POINT];
|
||||
_animVars.set("reactionPointEnabled", enabled);
|
||||
_animVars.set("reactionPointDisabled", !enabled);
|
||||
|
||||
// trigger animVars
|
||||
if (params.reactionTriggers[AVATAR_REACTION_POSITIVE]) {
|
||||
_animVars.set("reactionPositiveTrigger", true);
|
||||
} else {
|
||||
_animVars.set("reactionPositiveTrigger", false);
|
||||
}
|
||||
|
||||
if (params.reactionTriggers[AVATAR_REACTION_NEGATIVE]) {
|
||||
_animVars.set("reactionNegativeTrigger", true);
|
||||
} else {
|
||||
_animVars.set("reactionNegativeTrigger", false);
|
||||
}
|
||||
|
||||
if (params.reactionTriggers[AVATAR_REACTION_RAISE_HAND]) {
|
||||
_animVars.set("reactionRaiseHandTrigger", true);
|
||||
} else {
|
||||
_animVars.set("reactionRaiseHandTrigger", false);
|
||||
}
|
||||
|
||||
if (params.reactionTriggers[AVATAR_REACTION_APPLAUD]) {
|
||||
_animVars.set("reactionApplaudTrigger", true);
|
||||
} else {
|
||||
_animVars.set("reactionApplaudTrigger", false);
|
||||
}
|
||||
|
||||
if (params.reactionTriggers[AVATAR_REACTION_POINT]) {
|
||||
_animVars.set("reactionPointTrigger", true);
|
||||
} else {
|
||||
_animVars.set("reactionPointTrigger", false);
|
||||
}
|
||||
}
|
||||
|
||||
void Rig::updateEyeJoint(int index, const glm::vec3& modelTranslation, const glm::quat& modelRotation, const glm::vec3& lookAtSpot, const glm::vec3& saccade) {
|
||||
|
||||
// TODO: does not properly handle avatar scale.
|
||||
|
|
@ -2183,6 +2238,8 @@ void Rig::updateFromControllerParameters(const ControllerParameters& params, flo
|
|||
}
|
||||
}
|
||||
|
||||
updateReactions(params);
|
||||
|
||||
_previousControllerParameters = params;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -88,6 +88,8 @@ public:
|
|||
AnimPose secondaryControllerPoses[NumSecondaryControllerTypes]; // rig space
|
||||
uint8_t secondaryControllerFlags[NumSecondaryControllerTypes];
|
||||
bool isTalking;
|
||||
bool reactionEnabledFlags[NUM_AVATAR_REACTIONS];
|
||||
bool reactionTriggers[NUM_AVATAR_REACTIONS];
|
||||
HFMJointShapeInfo hipsShapeInfo;
|
||||
HFMJointShapeInfo spineShapeInfo;
|
||||
HFMJointShapeInfo spine1ShapeInfo;
|
||||
|
|
@ -269,6 +271,7 @@ protected:
|
|||
void updateFeet(bool leftFootEnabled, bool rightFootEnabled, bool headEnabled,
|
||||
const AnimPose& leftFootPose, const AnimPose& rightFootPose,
|
||||
const glm::mat4& rigToSensorMatrix, const glm::mat4& sensorToRigMatrix);
|
||||
void updateReactions(const ControllerParameters& params);
|
||||
|
||||
void updateEyeJoint(int index, const glm::vec3& modelTranslation, const glm::quat& modelRotation, const glm::vec3& lookAt, const glm::vec3& saccade);
|
||||
void calcAnimAlpha(float speed, const std::vector<float>& referenceSpeeds, float* alphaOut) const;
|
||||
|
|
|
|||
|
|
@ -2861,7 +2861,7 @@ glm::vec3 AvatarData::getAbsoluteJointTranslationInObjectFrame(int index) const
|
|||
* Information on an attachment worn by the avatar.
|
||||
* @typedef {object} AttachmentData
|
||||
* @property {string} modelUrl - The URL of the model file. Models can be FBX or OBJ format.
|
||||
* @property {string} jointName - The offset to apply to the model relative to the joint position.
|
||||
* @property {string} jointName - The name of the joint that the attachment is parented to.
|
||||
* @property {Vec3} translation - The offset from the joint that the attachment is positioned at.
|
||||
* @property {Vec3} rotation - The rotation applied to the model relative to the joint orientation.
|
||||
* @property {number} scale - The scale applied to the attachment model.
|
||||
|
|
|
|||
|
|
@ -1292,7 +1292,7 @@ public:
|
|||
* jointName: "Head",
|
||||
* translation: {"x": 0, "y": 0.25, "z": 0},
|
||||
* rotation: {"x": 0, "y": 0, "z": 0, "w": 1},
|
||||
* scale: 1,
|
||||
* scale: 0.01,
|
||||
* isSoft: false
|
||||
* };
|
||||
*
|
||||
|
|
|
|||
|
|
@ -174,20 +174,35 @@ private:
|
|||
};
|
||||
|
||||
/**jsdoc
|
||||
* The <code>Reticle</code> API provides access to the mouse cursor. The cursor may be an arrow or a reticle circle, depending
|
||||
* on Interface settings. The mouse cursor is visible in HMD mode if controllers aren't being used.
|
||||
*
|
||||
* @namespace Reticle
|
||||
*
|
||||
* @hifi-interface
|
||||
* @hifi-client-entity
|
||||
* @hifi-avatar
|
||||
*
|
||||
* @property {boolean} allowMouseCapture
|
||||
* @property {number} depth
|
||||
* @property {Vec2} maximumPosition
|
||||
* @property {boolean} mouseCaptured
|
||||
* @property {boolean} pointingAtSystemOverlay
|
||||
* @property {Vec2} position
|
||||
* @property {number} scale
|
||||
* @property {boolean} visible
|
||||
* @property {boolean} allowMouseCapture=true - <code>true</code> if the mouse cursor will be captured when in HMD mode and the
|
||||
* Interface window content (excluding menus) has focus, <code>false</code> if the mouse cursor will not be captured.
|
||||
* @property {number} depth - The depth (distance) that the reticle is displayed at relative to the HMD view, in HMD mode.
|
||||
* @property {Vec2} maximumPosition - The maximum reticle coordinates on the display device in desktop mode or the HUD surface
|
||||
* in HMD mode. (The minimum reticle coordinates on the desktop display device or HUD surface are <code>0</code>,
|
||||
* <code>0</code>.) <em>Read-only.</em>
|
||||
* @property {boolean} mouseCaptured - <code>true</code> if the mouse cursor is captured, displaying only in Interface and
|
||||
* not on the rest of the desktop. The mouse cursor may be captured when in HMD mode and the Interface window content
|
||||
* (excluding menu items) has focus, if capturing is enabled (<code>allowMouseCapture</code> is <code>true</code>).
|
||||
* <em>Read-only.</em>
|
||||
* @property {boolean} pointingAtSystemOverlay - <code>true</code> if the mouse cursor is pointing at UI in the Interface
|
||||
* window in desktop mode or on the HUD surface in HMD mode, <code>false</code> if it isn't. <em>Read-only.</em>
|
||||
* @property {Vec2} position - The position of the cursor. This is the position relative to the Interface window in desktop
|
||||
* mode, and the HUD surface in HMD mode.
|
||||
* <p><strong>Note:</strong> The position values may be negative.</p>
|
||||
* @property {number} scale=1 - The scale of the reticle circle in desktop mode, and the arrow and reticle circle in HMD mode.
|
||||
* (Does not affect the size of the arrow in desktop mode.)
|
||||
* @property {boolean} visible=true - <code>true</code> if the reticle circle is visible in desktop mode, and the arrow or
|
||||
* reticle circle are visible in HMD mode; <code>false</code> otherwise. (Does not affect the visibility of the mouse
|
||||
* pointer in desktop mode.)
|
||||
*/
|
||||
// Scripting interface available to control the Reticle
|
||||
class ReticleInterface : public QObject {
|
||||
|
|
@ -205,80 +220,113 @@ public:
|
|||
ReticleInterface(CompositorHelper* outer) : QObject(outer), _compositor(outer) {}
|
||||
|
||||
/**jsdoc
|
||||
* Checks whether the mouse cursor is captured, displaying only in Interface and not on the rest of the desktop. The mouse
|
||||
* cursor is captured when in HMD mode and the Interface window content (excluding menu items) has focus, if capturing is
|
||||
* enabled (<code>allowMouseCapture</code> property value is <code>true</code>).
|
||||
* @function Reticle.isMouseCaptured
|
||||
* @returns {boolean}
|
||||
* @returns {boolean} <code>true</code> if the mouse cursor is captured, displaying only in Interface and not on the
|
||||
* desktop.
|
||||
*/
|
||||
Q_INVOKABLE bool isMouseCaptured() { return _compositor->shouldCaptureMouse(); }
|
||||
|
||||
/**jsdoc
|
||||
* Gets whether the mouse cursor will be captured when in HMD mode and the Interface window content (excluding menu items)
|
||||
* has focus. When captured, the mouse cursor displays only in Interface, not on the rest of the desktop.
|
||||
* @function Reticle.getAllowMouseCapture
|
||||
* @returns {boolean}
|
||||
* @returns {boolean} <code>true</code> if the mouse cursor will be captured when in HMD mode and the Interface window
|
||||
* content has focus, <code>false</code> if the mouse cursor will not be captured.
|
||||
*/
|
||||
Q_INVOKABLE bool getAllowMouseCapture() { return _compositor->getAllowMouseCapture(); }
|
||||
|
||||
/**jsdoc
|
||||
* Sets whether the mouse cursor will be captured when in HMD mode and the Interface window content (excluding menu items)
|
||||
* has focus. When captured, the mouse cursor displays only in Interface, not on the rest of desktop.
|
||||
* @function Reticle.setAllowMouseCapture
|
||||
* @param {boolean} allowMouseCaptured
|
||||
* @param {boolean} allowMouseCaptured - <code>true</code> if the mouse cursor will be captured when in HMD mode and the
|
||||
* Interface window content has focus, <code>false</code> if the mouse cursor will not be captured.
|
||||
*/
|
||||
Q_INVOKABLE void setAllowMouseCapture(bool value) { return _compositor->setAllowMouseCapture(value); }
|
||||
|
||||
/**jsdoc
|
||||
* Gets whether the mouse cursor is pointing at UI in the Interface window in desktop mode or on the HUD surface in HMD
|
||||
* mode.
|
||||
* @function Reticle.isPointingAtSystemOverlay
|
||||
* @returns {boolean}
|
||||
* @returns {boolean} <code>true</code> if the mouse cursor is pointing at UI in the Interface window in desktop mode or on
|
||||
* the HUD surface in HMD mode, <code>false</code> if it isn't.
|
||||
*/
|
||||
Q_INVOKABLE bool isPointingAtSystemOverlay() { return !_compositor->getReticleOverDesktop(); }
|
||||
|
||||
/**jsdoc
|
||||
* Gets whether the reticle circle is visible in desktop mode, or the arrow or reticle circle are visible in HMD mode.
|
||||
* @function Reticle.getVisible
|
||||
* @returns {boolean}
|
||||
* @returns {boolean} <code>true</code> if the reticle circle is visible in desktop mode, and the arrow or
|
||||
* reticle circle are visible in HMD mode; <code>false</code> otherwise. (The mouse pointer is always visible in
|
||||
* desktop mode.)
|
||||
*/
|
||||
Q_INVOKABLE bool getVisible() { return _compositor->getReticleVisible(); }
|
||||
|
||||
/**jsdoc
|
||||
* Sets whether the reticle circle is visible in desktop mode, or the arrow or reticle circle are visible in HMD mode.
|
||||
* @function Reticle.setVisible
|
||||
* @param {boolean} visible
|
||||
* @param {boolean} visible - <code>true</code> if the reticle circle is visible in desktop mode, and the arrow or reticle
|
||||
* circle are visible in HMD mode; <code>false</code> otherwise. (Does not affect the visibility of the mouse pointer
|
||||
* in desktop mode.)
|
||||
*/
|
||||
Q_INVOKABLE void setVisible(bool visible) { _compositor->setReticleVisible(visible); }
|
||||
|
||||
/**jsdoc
|
||||
* Gets the depth (distance) that the reticle is displayed at relative to the HMD view, in HMD mode.
|
||||
* @function Reticle.getDepth
|
||||
* @returns {number}
|
||||
* @returns {number} The depth (distance) that the reticle is displayed at relative to the HMD view, in HMD mode.
|
||||
*/
|
||||
Q_INVOKABLE float getDepth() { return _compositor->getReticleDepth(); }
|
||||
|
||||
/**jsdoc
|
||||
* Sets the depth (distance) that the reticle is displayed at relative to the HMD view, in HMD mode.
|
||||
* @function Reticle.setDepth
|
||||
* @param {number} depth
|
||||
* @param {number} depth - The depth (distance) that the reticle is displayed at relative to the HMD view, in HMD mode.
|
||||
*/
|
||||
Q_INVOKABLE void setDepth(float depth) { _compositor->setReticleDepth(depth); }
|
||||
|
||||
/**jsdoc
|
||||
* Gets the scale of the reticle circle in desktop mode, and the arrow and reticle circle in HMD mode. (Does not affect the
|
||||
* size of the arrow in desktop mode.) The default scale is <code>1.0</code>.
|
||||
* @function Reticle.getScale
|
||||
* @returns {number}
|
||||
* @returns {number} The scale of the reticle.
|
||||
*/
|
||||
Q_INVOKABLE float getScale() const;
|
||||
|
||||
/**jsdoc
|
||||
* Sets the scale of the reticle circle in desktop mode, and the arrow and reticle circle in HMD mode. (Does not affect the
|
||||
* size of the arrow in desktop mode.) The default scale is <code>1.0</code>.
|
||||
* @function Reticle.setScale
|
||||
* @param {number} scale
|
||||
* @param {number} scale - The scale of the reticle.
|
||||
*/
|
||||
Q_INVOKABLE void setScale(float scale);
|
||||
|
||||
/**jsdoc
|
||||
* Gets the position of the cursor. This is the position relative to the Interface window in desktop mode, and the HUD
|
||||
* surface in HMD mode.
|
||||
* <p><strong>Note:</strong> The position values may be negative.</p>
|
||||
* @function Reticle.getPosition
|
||||
* @returns {Vec2}
|
||||
* @returns {Vec2} The position of the cursor.
|
||||
*/
|
||||
Q_INVOKABLE QVariant getPosition() const;
|
||||
|
||||
/**jsdoc
|
||||
* Sets the position of the cursor. This is the position relative to the Interface window in desktop mode, and the HUD
|
||||
* surface in HMD mode.
|
||||
* <p><strong>Note:</strong> The position values may be negative.</p>
|
||||
* @function Reticle.setPosition
|
||||
* @param {Vec2} position
|
||||
* @param {Vec2} position - The position of the cursor.
|
||||
*/
|
||||
Q_INVOKABLE void setPosition(QVariant position);
|
||||
|
||||
/**jsdoc
|
||||
* Gets the maximum reticle coordinates on the display device in desktop mode or the HUD surface in HMD mode. (The minimum
|
||||
* reticle coordinates on the desktop display device or HUD surface are <code>0</code>, <code>0</code>.)
|
||||
* @function Reticle.getMaximumPosition
|
||||
* @returns {Vec2}
|
||||
* @returns {Vec2} The maximum reticle coordinates on the display device in desktop mode or the HUD surface in HMD mode.
|
||||
*/
|
||||
Q_INVOKABLE glm::vec2 getMaximumPosition() { return _compositor->getReticleMaximumPosition(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -988,8 +988,8 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
|
|||
* <code>false</code> otherwise; <code>[]</code> if none are applied or the model hasn't loaded. The array indexes are per
|
||||
* {@link Entities.getJointIndex|getJointIndex}.
|
||||
* @property {Vec3[]} jointTranslations=[]] - Joint translations applied to the model; <code>[]</code> if none are applied or
|
||||
* the model hasn't loaded. The array indexes are per {@link Entities.getJointIndex|getJointIndex}. Rotations are relative
|
||||
* to each joint's parent.
|
||||
* the model hasn't loaded. The array indexes are per {@link Entities.getJointIndex|getJointIndex}. Translations are
|
||||
* relative to each joint's parent.
|
||||
* <p>Joint translations can be set by {@link Entities.setLocalJointTranslation|setLocalJointTranslation} and similar
|
||||
* functions, or by setting the value of this property. If you set a joint translation using this property you also need to
|
||||
* set the corresponding <code>jointTranslationsSet</code> value to <code>true</code>.</p>
|
||||
|
|
|
|||
|
|
@ -446,7 +446,15 @@ public slots:
|
|||
/**jsdoc
|
||||
* Gets an entity's script object. In particular, this is useful for accessing a {@link Entities.EntityProperties-Web|Web}
|
||||
* entity's HTML <code>EventBridge</code> script object to exchange messages with the web page script.
|
||||
* <p>Alternatively, you can use {@link Entities.emitScriptEvent} and {@link Entities.webEventReceived} to exchange
|
||||
* <p>To send a message from an Interface script to a Web entity over its event bridge:</p>
|
||||
* <pre class="prettyprint"><code>var entityObject = Entities.getEntityObject(entityID);
|
||||
* entityObject.emitScriptEvent(message);</code></pre>
|
||||
* <p>To receive a message from a Web entity over its event bridge in an Interface script:</p>
|
||||
* <pre class="prettyprint"><code>var entityObject = Entities.getentityObject(entityID);
|
||||
* entityObject.webEventReceived.connect(function(message) {
|
||||
* ...
|
||||
* };</code></pre>
|
||||
* <p>Alternatively, you can use {@link Entities.emitScriptEvent} and {@link Entities.webEventReceived} to exchange
|
||||
* messages with a Web entity over its event bridge.</p>
|
||||
* @function Entities.getEntityObject
|
||||
* @param {Uuid} id - The ID of the entity to get the script object for.
|
||||
|
|
@ -459,7 +467,7 @@ public slots:
|
|||
* <title>HELLO</title>
|
||||
* </head>
|
||||
* <body>
|
||||
* <h1>HELLO</h1></h1>
|
||||
* <h1>HELLO</h1>
|
||||
* <script>
|
||||
* function onScriptEventReceived(message) {
|
||||
* // Message received from the script.
|
||||
|
|
@ -476,7 +484,7 @@ public slots:
|
|||
* </body>
|
||||
* </html>
|
||||
*
|
||||
* // Script file.
|
||||
* // Interface script file.
|
||||
* var webEntity = Entities.addEntity({
|
||||
* type: "Web",
|
||||
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0.5, z: -3 })),
|
||||
|
|
@ -525,9 +533,12 @@ public slots:
|
|||
Q_INVOKABLE bool isAddedEntity(const QUuid& id);
|
||||
|
||||
/**jsdoc
|
||||
* Calculates the size of some text in a text entity.
|
||||
* Calculates the size of some text in a {@link Entities.EntityProperties-Text|Text} entity. The entity need not be set
|
||||
* visible.
|
||||
* <p><strong>Note:</strong> The size of text in a Text entity cannot be calculated immediately after the
|
||||
* entity is created; a short delay is required while the entity finishes being created.</p>
|
||||
* @function Entities.textSize
|
||||
* @param {Uuid} id - The ID of the entity to use for calculation.
|
||||
* @param {Uuid} id - The ID of the Text entity to use for calculation.
|
||||
* @param {string} text - The string to calculate the size of.
|
||||
* @returns {Size} The size of the <code>text</code> in meters if the object is a text entity, otherwise
|
||||
* <code>{ height: 0, width : 0 }</code>.
|
||||
|
|
@ -1794,7 +1805,7 @@ public slots:
|
|||
* <title>HELLO</title>
|
||||
* </head>
|
||||
* <body>
|
||||
* <h1>HELLO</h1></h1>
|
||||
* <h1>HELLO</h1>
|
||||
* <script>
|
||||
* function onScriptEventReceived(message) {
|
||||
* // Message received from the script.
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ namespace entity {
|
|||
* </thead>
|
||||
* <tbody>
|
||||
* <tr><td><code>"Circle"</code></td><td>2D</td><td>A circle oriented in 3D.</td></tr>
|
||||
* <tr><td><code>"Cube"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Cone"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Cube"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Cylinder"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Dodecahedron"</code></td><td>3D</td><td></td></tr>
|
||||
* <tr><td><code>"Hexagon"</code></td><td>3D</td><td>A hexagonal prism.</td></tr>
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@
|
|||
* <tr><td>INTERSECTED_ENTITY</td><td><code>1</code></td><td>Intersected an entity.</td></tr>
|
||||
* <tr><td>INTERSECTED_LOCAL_ENTITY</td><td><code>2</code></td><td>Intersected a local entity.</td></tr>
|
||||
* <tr><td>INTERSECTED_AVATAR</td><td><code>3</code></td><td>Intersected an avatar.</td></tr>
|
||||
* <tr><td>INTERSECTED_HUD</td><td><code>4</code></td><td>Intersected the HUD sphere.</td></tr>
|
||||
* <tr><td>INTERSECTED_HUD</td><td><code>4</code></td><td>Intersected the HUD surface.</td></tr>
|
||||
* </tbody>
|
||||
* </table>
|
||||
* @typedef {number} IntersectionType
|
||||
|
|
|
|||
|
|
@ -106,4 +106,13 @@ static const float AVATAR_WALK_SPEED_SCALAR = 1.0f;
|
|||
static const float AVATAR_DESKTOP_SPRINT_SPEED_SCALAR = 3.0f;
|
||||
static const float AVATAR_HMD_SPRINT_SPEED_SCALAR = 2.0f;
|
||||
|
||||
enum AvatarReaction {
|
||||
AVATAR_REACTION_POSITIVE = 0,
|
||||
AVATAR_REACTION_NEGATIVE,
|
||||
AVATAR_REACTION_RAISE_HAND,
|
||||
AVATAR_REACTION_APPLAUD,
|
||||
AVATAR_REACTION_POINT,
|
||||
NUM_AVATAR_REACTIONS
|
||||
};
|
||||
|
||||
#endif // hifi_AvatarConstants_h
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ public:
|
|||
* <tr><td>PICK_AVATAR_ENTITIES</td><td><code>2</code></td><td>Include avatar entities when intersecting.</td></tr>
|
||||
* <tr><td>PICK_LOCAL_ENTITIES</td><td><code>4</code></td><td>Include local entities when intersecting.</td></tr>
|
||||
* <tr><td>PICK_AVATATRS</td><td><code>8</code></td><td>Include avatars when intersecting.</td></tr>
|
||||
* <tr><td>PICK_HUD</td><td><code>16</code></td><td>Include the HUD sphere when intersecting in HMD mode.</td></tr>
|
||||
* <tr><td>PICK_HUD</td><td><code>16</code></td><td>Include the HUD surface when intersecting in HMD mode.</td></tr>
|
||||
* <tr><td>PICK_INCLUDE_VISIBLE</td><td><code>32</code></td><td>Include visible objects when intersecting.</td></tr>
|
||||
* <tr><td>PICK_INCLUDE_INVISIBLE</td><td><code>64</code></td><td>Include invisible objects when intersecting.</td></tr>
|
||||
* <tr><td>PICK_INCLUDE_COLLIDABLE</td><td><code>128</code></td><td>Include collidable objects when
|
||||
|
|
|
|||
|
|
@ -19,8 +19,8 @@
|
|||
* </thead>
|
||||
* <tbody>
|
||||
* <tr><td><code>"world"</code></td><td>The entity is drawn in the world with everything else.</td></tr>
|
||||
* <tr><td><code>"front"</code></td><td>The entity is drawn on top of the world layer but behind the HUD sphere.</td></tr>
|
||||
* <tr><td><code>"hud"</code></td><td>The entity is drawn on top of other layers and the HUD sphere.</td></tr>
|
||||
* <tr><td><code>"front"</code></td><td>The entity is drawn on top of the world layer but behind the HUD surface.</td></tr>
|
||||
* <tr><td><code>"hud"</code></td><td>The entity is drawn on top of other layers and the HUD surface.</td></tr>
|
||||
* </tbody>
|
||||
* </table>
|
||||
* @typedef {string} Entities.RenderLayer
|
||||
|
|
|
|||
|
|
@ -1,7 +1,17 @@
|
|||
(function () {
|
||||
var tablet = Tablet.getTablet("com.highfidelity.interface.tablet.system");
|
||||
|
||||
|
||||
this.clickDownOnEntity = function (entityID, mouseEvent) {
|
||||
tablet.loadQMLSource("hifi/AvatarApp.qml");
|
||||
var scripts = ScriptDiscoveryService.getRunning();
|
||||
|
||||
var runningSimplified =
|
||||
!scripts.every(function (item) {
|
||||
return item.name !== "simplifiedUI.js";
|
||||
});
|
||||
|
||||
var avatarAppQML = runningSimplified ? "hifi/simplifiedUI/avatarApp/AvatarApp.qml" : "hifi/AvatarApp.qml";
|
||||
tablet.loadQMLSource(avatarAppQML);
|
||||
};
|
||||
}
|
||||
);
|
||||
|
|
|
|||
|
|
@ -1118,6 +1118,11 @@ SelectionDisplay = (function() {
|
|||
return false;
|
||||
}
|
||||
|
||||
// No action if the Alt key is pressed.
|
||||
if (event.isAlt) {
|
||||
return;
|
||||
}
|
||||
|
||||
var pickRay = generalComputePickRay(event.x, event.y);
|
||||
// TODO_Case6491: Move this out to setup just to make it once
|
||||
var interactiveOverlays = getMainTabletIDs();
|
||||
|
|
@ -2039,10 +2044,10 @@ SelectionDisplay = (function() {
|
|||
Vec3.print(" pickResult.intersection", pickResult.intersection);
|
||||
}
|
||||
|
||||
// Duplicate entities if alt is pressed. This will make a
|
||||
// Duplicate entities if Ctrl is pressed. This will make a
|
||||
// copy of the selected entities and move the _original_ entities, not
|
||||
// the new ones.
|
||||
if (event.isAlt || doDuplicate) {
|
||||
if (event.isControl || doDuplicate) {
|
||||
duplicatedEntityIDs = SelectionManager.duplicateSelection();
|
||||
var ids = [];
|
||||
for (var i = 0; i < duplicatedEntityIDs.length; ++i) {
|
||||
|
|
@ -2265,10 +2270,10 @@ SelectionDisplay = (function() {
|
|||
addHandleTool(overlay, {
|
||||
mode: mode,
|
||||
onBegin: function(event, pickRay, pickResult) {
|
||||
// Duplicate entities if alt is pressed. This will make a
|
||||
// Duplicate entities if Ctrl is pressed. This will make a
|
||||
// copy of the selected entities and move the _original_ entities, not
|
||||
// the new ones.
|
||||
if (event.isAlt) {
|
||||
if (event.isControl) {
|
||||
duplicatedEntityIDs = SelectionManager.duplicateSelection();
|
||||
var ids = [];
|
||||
for (var i = 0; i < duplicatedEntityIDs.length; ++i) {
|
||||
|
|
|
|||
|
|
@ -167,6 +167,19 @@ local unsourced_packet_types = {
|
|||
["ICEServerHeartbeatACK"] = true
|
||||
}
|
||||
|
||||
local nonverified_packet_types = {
|
||||
["NodeJsonStats"] = true,
|
||||
["EntityQuery"] = true,
|
||||
["OctreeDataNack"] = true,
|
||||
["EntityEditNack"] = true,
|
||||
["DomainListRequest"] = true,
|
||||
["StopNode"] = true,
|
||||
["DomainDisconnectRequest"] = true,
|
||||
["UsernameFromIDRequest"] = true,
|
||||
["NodeKickRequest"] = true,
|
||||
["NodeMuteRequest"] = true,
|
||||
}
|
||||
|
||||
local fragments = {}
|
||||
|
||||
local RFC_5389_MAGIC_COOKIE = 0x2112A442
|
||||
|
|
@ -304,9 +317,11 @@ function p_hfudt.dissector(buf, pinfo, tree)
|
|||
subtree:add_le(f_sender_id, sender_id)
|
||||
i = i + 2
|
||||
|
||||
-- read HMAC MD5 hash
|
||||
subtree:add(f_hmac_hash, buf(i, 16))
|
||||
i = i + 16
|
||||
if nonverified_packet_types[packet_type_text] == nil then
|
||||
-- read HMAC MD5 hash
|
||||
subtree:add(f_hmac_hash, buf(i, 16))
|
||||
i = i + 16
|
||||
end
|
||||
end
|
||||
|
||||
local payload_to_dissect = nil
|
||||
|
|
|
|||
Loading…
Reference in a new issue