mirror of
https://github.com/lubosz/overte.git
synced 2025-04-07 03:22:09 +02:00
DOC-208 revisions
This commit is contained in:
ingerjm0
parent
ed9db81bed
commit
d2118f0aac
7 changed files with 49 additions and 49 deletions
|
|
@ -76,21 +76,21 @@
|
|||
* size in the virtual world. <em>Read-only.</em>
|
||||
* @property {boolean} hasPriority - <code>true</code> if the avatar is in a "hero" zone, <code>false</code> if it isn't.
|
||||
* <em>Read-only.</em>
|
||||
* @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blendshapes are controlled by scripted actions,
|
||||
* otherwise <code>false</code>. Set this to true before using the {@link MyAvatar.setBlendshape} method, and set back
|
||||
* to false after you no longer want scripted control over the blendshapes.
|
||||
* <p>NOTE: This property will automatically be set to true if the Controller system has valid facial blendshape
|
||||
* actions.</p>
|
||||
* @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blend shapes are controlled by scripted actions,
|
||||
* otherwise <code>false</code>. Set this to <code>true</code> before using the {@link MyAvatar.setBlendshape} method,
|
||||
* and set back to <code>false</code> after you no longer want scripted control over the blend shapes.
|
||||
* <p><strong>Note:</strong> This property will automatically be set to true if the Controller system has valid facial
|
||||
* blend shape actions.</p>
|
||||
* @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating
|
||||
* facial blendshapes, <code>false</code> if automatic blinking is disabled. Set this property to false if you wish to
|
||||
* fully control the blink facial blendshapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blendshapes for an avatar's eyes
|
||||
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set this property to <code>false</code> if
|
||||
* you wish to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes
|
||||
* adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property
|
||||
* to true to prevent the iris from being obscured by the upper or lower lids. Set this property to <code>false</code>
|
||||
* if you wish to fully control the eye blendshapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blendshapes animate
|
||||
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set this property to
|
||||
* <code>false</code> if you wish to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate
|
||||
* automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set
|
||||
* this property to false if you wish to fully control the mouth facial blendshapes via the
|
||||
* this property to <code>false</code> if you wish to fully control the mouth facial blend shapes via the
|
||||
* {@link MyAvatar.setBlendshape} method.
|
||||
*
|
||||
* @example <caption>Create a scriptable avatar.</caption>
|
||||
|
|
|
|||
|
|
@ -148,21 +148,21 @@ class MyAvatar : public Avatar {
|
|||
* size in the virtual world. <em>Read-only.</em>
|
||||
* @property {boolean} hasPriority - <code>true</code> if the avatar is in a "hero" zone, <code>false</code> if it isn't.
|
||||
* <em>Read-only.</em>
|
||||
* @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blendshapes are controlled by scripted actions,
|
||||
* otherwise <code>false</code>. Set this to true before using the {@link MyAvatar.setBlendshape} method, and set back
|
||||
* to false after you no longer want scripted control over the blendshapes.
|
||||
* <p>NOTE: This property will automatically be set to true if the Controller system has valid facial blendshape
|
||||
* actions.</p>
|
||||
* @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blend shapes are controlled by scripted actions,
|
||||
* otherwise <code>false</code>. Set this to <code>true</code> before using the {@link MyAvatar.setBlendshape} method,
|
||||
* and set back to <code>false</code> after you no longer want scripted control over the blend shapes.
|
||||
* <p><strong>Note:</strong> This property will automatically be set to true if the Controller system has valid facial
|
||||
* blend shape actions.</p>
|
||||
* @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating
|
||||
* facial blendshapes, <code>false</code> if automatic blinking is disabled. Set this property to false if you wish to
|
||||
* fully control the blink facial blendshapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blendshapes for an avatar's eyes
|
||||
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set this property to <code>false</code> if
|
||||
* you wish to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes
|
||||
* adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property
|
||||
* to true to prevent the iris from being obscured by the upper or lower lids. Set this property to <code>false</code>
|
||||
* if you wish to fully control the eye blendshapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blendshapes animate
|
||||
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set this property to
|
||||
* <code>false</code> if you wish to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate
|
||||
* automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set
|
||||
* this property to false if you wish to fully control the mouth facial blendshapes via the
|
||||
* this property to <code>false</code> if you wish to fully control the mouth facial blend shapes via the
|
||||
* {@link MyAvatar.setBlendshape} method.
|
||||
*
|
||||
* @comment IMPORTANT: This group of properties is copied from Avatar.h; they should NOT be edited here.
|
||||
|
|
@ -1762,7 +1762,7 @@ public:
|
|||
void prepareAvatarEntityDataForReload();
|
||||
|
||||
/**jsdoc
|
||||
* Turns the avatar's head until it faces the target point within a 90/-90 degree range.
|
||||
* Turns the avatar's head until it faces the target point within a +90/-90 degree range.
|
||||
* Once this method is called, API calls will have full control of the head for a limited time.
|
||||
* If this method is not called for two seconds, the engine will regain control of the head.
|
||||
* @function MyAvatar.setHeadLookAt
|
||||
|
|
@ -1785,8 +1785,8 @@ public:
|
|||
|
||||
/**jsdoc
|
||||
* Forces the avatar's eyes to look at a specified location. Once this method is called, API calls
|
||||
* will have full control of the eyes for a limited time. If this method is not called for two seconds,
|
||||
* the engine will regain control of the eyes.
|
||||
* have full control of the eyes for a limited time. If this method is not called for two seconds,
|
||||
* the engine regains control of the eyes.
|
||||
* @function MyAvatar.setEyesLookAt
|
||||
* @param {Vec3} lookAtTarget - The target point in world coordinates.
|
||||
*/
|
||||
|
|
@ -1810,7 +1810,7 @@ public:
|
|||
* before using this method with the code <code>MyAvatar.beginReaction("point")</code>.
|
||||
* @function MyAvatar.setPointAt
|
||||
* @param {Vec3} pointAtTarget - The target point in world coordinates.
|
||||
* @returns {boolean} <code>true</code> if the target point lays in front of the avatar; <code>false</code> otherwise.
|
||||
* @returns {boolean} <code>true</code> if the target point lays in front of the avatar, <code>false</code> if it doesn't.
|
||||
*/
|
||||
Q_INVOKABLE bool setPointAt(const glm::vec3& pointAtTarget);
|
||||
|
||||
|
|
|
|||
|
|
@ -253,7 +253,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVarian
|
|||
* {@link Picks.getPickScriptParameters}. A parabola pick's type is {@link PickType.Parabola}.
|
||||
* @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale
|
||||
* (usually an avatar or an entity). Its value is the original scale of the parent at the moment the pick was created, and
|
||||
* is used to rescale the pick, and/or the pointer which owns this pick, if any.
|
||||
* is used to rescale the pick and the pointer which owns this pick, if any.
|
||||
*/
|
||||
std::shared_ptr<PickQuery> PickScriptingInterface::buildParabolaPick(const QVariantMap& propMap) {
|
||||
bool enabled = false;
|
||||
|
|
|
|||
|
|
@ -159,7 +159,7 @@ public:
|
|||
* @function Picks.getPickScriptParameters
|
||||
* @param {number} id - The ID of the pick.
|
||||
* @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties}
|
||||
* User-provided properties, per the pick <code>type</code>.
|
||||
* Script-provided properties, per the pick <code>type</code>.
|
||||
*/
|
||||
Q_INVOKABLE QVariantMap getPickScriptParameters(unsigned int uid) const;
|
||||
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u
|
|||
* @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events,
|
||||
* <code>false</code> if it doesn't.
|
||||
* @property {PickType} pointerType - The type of the stylus pointer returned from {@link Pointers.getPointerProperties}
|
||||
* or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType.Stylus}.
|
||||
* or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType(0)|PickType.Stylus}.
|
||||
* @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
|
||||
* {@link Pointers.getPointerProperties}.
|
||||
* @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.
|
||||
|
|
@ -212,7 +212,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant&
|
|||
* @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
|
||||
* events on the entity or overlay currently intersected.
|
||||
* @property {PickType} pointerType - The type of pointer returned from {@link Pointers.getPointerProperties} or
|
||||
* {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType.Ray}.
|
||||
* {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType(0)|PickType.Ray}.
|
||||
* @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
|
||||
* {@link Pointers.getPointerProperties}.
|
||||
* @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.
|
||||
|
|
@ -407,7 +407,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar
|
|||
* @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
|
||||
* events on the entity or overlay currently intersected.
|
||||
* @property {PickType} pointerType - The type of pointer returned from {@link Pointers.getPointerProperties} or
|
||||
* {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType.Parabola}.
|
||||
* {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType(0)|PickType.Parabola}.
|
||||
* @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
|
||||
* {@link Pointers.getPointerProperties}.
|
||||
* @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.
|
||||
|
|
|
|||
|
|
@ -168,7 +168,7 @@ public:
|
|||
* @function Pointers.getPointerScriptParameters
|
||||
* @param {number} id - The ID of the pointer.
|
||||
* @returns {Pointers.RayPointerProperties|Picks.ParabolaPointerProperties|Picks.StylusPointerProperties}
|
||||
* User-provided properties, per the pointer <code>type</code>.
|
||||
* Script-provided properties, per the pointer <code>type</code>.
|
||||
*/
|
||||
Q_INVOKABLE QVariantMap getPointerScriptParameters(unsigned int uid) const;
|
||||
|
||||
|
|
|
|||
|
|
@ -532,21 +532,21 @@ class AvatarData : public QObject, public SpatiallyNestable {
|
|||
* size in the virtual world. <em>Read-only.</em>
|
||||
* @property {boolean} hasPriority - <code>true</code> if the avatar is in a "hero" zone, <code>false</code> if it isn't.
|
||||
* <em>Read-only.</em>
|
||||
* @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blendshapes are controlled by scripted actions,
|
||||
* otherwise <code>false</code>. Set this to true before using the {@link MyAvatar.setBlendshape} method, and set back
|
||||
* to false after you no longer want scripted control over the blendshapes.
|
||||
* <p>NOTE: This property will automatically be set to true if the Controller system has valid facial blendshape
|
||||
* actions.</p>
|
||||
* @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blend shapes are controlled by scripted actions,
|
||||
* otherwise <code>false</code>. Set this to <code>true</code> before using the {@link MyAvatar.setBlendshape} method,
|
||||
* and set back to <code>false</code> after you no longer want scripted control over the blend shapes.
|
||||
* <p><strong>Note:</strong> This property will automatically be set to true if the Controller system has valid facial
|
||||
* blend shape actions.</p>
|
||||
* @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating
|
||||
* facial blendshapes, <code>false</code> if automatic blinking is disabled. Set this property to false if you wish to
|
||||
* fully control the blink facial blendshapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blendshapes for an avatar's eyes
|
||||
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set this property to <code>false</code> if
|
||||
* you wish to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes
|
||||
* adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property
|
||||
* to true to prevent the iris from being obscured by the upper or lower lids. Set this property to <code>false</code>
|
||||
* if you wish to fully control the eye blendshapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blendshapes animate
|
||||
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set this property to
|
||||
* <code>false</code> if you wish to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
|
||||
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate
|
||||
* automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set
|
||||
* this property to false if you wish to fully control the mouth facial blendshapes via the
|
||||
* this property to <code>false</code> if you wish to fully control the mouth facial blend shapes via the
|
||||
* {@link MyAvatar.setBlendshape} method.
|
||||
*/
|
||||
Q_PROPERTY(glm::vec3 position READ getWorldPosition WRITE setPositionViaScript)
|
||||
|
|
@ -1133,9 +1133,9 @@ public:
|
|||
|
||||
|
||||
/**jsdoc
|
||||
* Sets the value of a blendshape to animate your avatar's face. In order for other users to see the resulting animations
|
||||
* on your avatar's face, set {@link Avatar.hasScriptedBlendshapes} to true. When you are done using this API, set
|
||||
* {@link Avatar.hasScriptedBlendshapes} back to false when the animation is complete.
|
||||
* Sets the value of a blend shape to animate your avatar's face. In order for other users to see the resulting animations
|
||||
* on your avatar's face, set {@link Avatar.hasScriptedBlendshapes} to <code>true</code>. When you are done using this API,
|
||||
* set {@link Avatar.hasScriptedBlendshapes} back to <code>false</code> when the animation is complete.
|
||||
* @function Avatar.setBlendshape
|
||||
* @param {string} name - The name of the blendshape, per the
|
||||
* {@link https://docs.highfidelity.com/create/avatars/avatar-standards.html#blendshapes Avatar Standards}.
|
||||
|
|
|
|||
Loading…
Reference in a new issue