From 9f4c657bc3f02e2714151b6c83adcb1aa1a7a125 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 6 Jul 2019 12:12:33 +1200 Subject: [PATCH] Update Overlays properties JSDoc --- interface/src/ui/overlays/Overlays.cpp | 459 ++++++++++++++----------- 1 file changed, 258 insertions(+), 201 deletions(-) diff --git a/interface/src/ui/overlays/Overlays.cpp b/interface/src/ui/overlays/Overlays.cpp index 0532b20b0f..c6bbca54e3 100644 --- a/interface/src/ui/overlays/Overlays.cpp +++ b/interface/src/ui/overlays/Overlays.cpp @@ -1336,12 +1336,12 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * Value2D/3DDescriptionProperties * * - * "image"2D - * An image. - * {@link Overlays.OverlayProperties-Image|OverlayProperties-Image} * "rectangle"2D * A rectangle. * {@link Overlays.OverlayProperties-Rectangle|OverlayProperties-Rectangle} + * "image"2D + * An image. + * {@link Overlays.OverlayProperties-Image|OverlayProperties-Image} * "text"2D * Some text. * {@link Overlays.OverlayProperties-Text|OverlayProperties-Text} @@ -1354,10 +1354,6 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * A sphere. A "shape" overlay can also be used to create a sphere.
* Deprecated. * {@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere} - * "rectangle3d"3D - * A rectangle.
- * Deprecated. - * {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} * "shape"3D * A geometric shape, such as a cube, sphere, or cylinder.
* Deprecated. @@ -1366,14 +1362,18 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * A model.
* Deprecated. * {@link Overlays.OverlayProperties-Model|OverlayProperties-Model} - * "text3d"3D - * Some text.
- * Deprecated. - * {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} * "image3d"3D * An image. Synonym: "billboard".
* Deprecated. * {@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D} + * "rectangle3d"3D + * A rectangle.
+ * Deprecated. + * {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} + * "text3d"3D + * Some text.
+ * Deprecated. + * {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} * "web3d"3D * Web content.
* Deprecated. @@ -1401,22 +1401,22 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { /**jsdoc * 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). - *

3D overlays are local entities, internally, so they also support the corresponding entity properties.

+ *

3D overlays are local entities, internally, so they also support the relevant entity's properties.

* @typedef {object} Overlays.OverlayProperties * @property {Uuid} id - The ID of the overlay. Read-only. * @property {Overlays.OverlayType} type - The overlay's type. Read-only. * @property {boolean} visible=true - true if the overlay is rendered, false if it isn't. * - * @see {@link Overlays.OverlayProperties-Image|OverlayProperties-Image} * @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-Cube|OverlayProperties-Cube} Deprecated. * @see {@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere} Deprecated. - * @see {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} Deprecated. * @see {@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape} Deprecated. * @see {@link Overlays.OverlayProperties-Model|OverlayProperties-Model} Deprecated. - * @see {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} Deprecated. + * @see {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} Deprecated. * @see {@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D} Deprecated. + * @see {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} Deprecated. * @see {@link Overlays.OverlayProperties-Web3D|OverlayProperties-Web3D} Deprecated. * @see {@link Overlays.OverlayProperties-Line3D|OverlayProperties-Line3D} Deprecated. * @see {@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid} Deprecated. @@ -1430,16 +1430,16 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {Rect} bounds - The position and size of the image display area, in pixels. Write-only. * @property {number} x - Integer left, x-coordinate value of the image display area = bounds.x. * Write-only. - * @property {number} y - Integer top, y-coordinate value of the image display area = bounds.y. + * @property {number} y - Integer top, y-coordinate value of the image display area = bounds.y. * Write-only. * @property {number} width - Integer width of the image display area = bounds.width. Write-only. - * @property {number} height - Integer height of the image display area = bounds.height. Write-only. + * @property {number} height - Integer height of the image display area = bounds.height. Write-only. * @property {string} imageURL - The URL of the image file to display. The image is scaled to fit to the bounds. * Write-only. - * @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. * Write-only. * @property {Color} color=0,0,0 - The color to apply over the top of the image to colorize it. Write-only. - * @property {number} alpha=0.0 - The opacity of the color applied over the top of the image, 0.0 - + * @property {number} alpha=0.0 - The opacity of the color applied over the top of the image, 0.0 – * 1.0. Write-only. */ @@ -1452,21 +1452,21 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {number} y - Integer top, y-coordinate value = bounds.y. Write-only. * @property {number} width - Integer width of the rectangle = bounds.width. Write-only. * @property {number} height - Integer height of the rectangle = bounds.height. Write-only. - * - * @property {number} margin=0 - Sets the leftMargin and topMargin values, in pixels. + * @property {number} margin=0 - The leftMargin and topMargin values, in pixels. * Write-only. * @property {number} leftMargin=0 - The left margin's size, in pixels. This value is also used for the right margin. * Write-only. * @property {number} topMargin=0 - The top margin's size, in pixels. This value is also used for the bottom margin. * Write-only. - * @property {string} text="" - The text to display. Text does not automatically wrap; use \n for a line break. Text - * is clipped to the bounds. Write-only. + * @property {string} text="" - The text to display. Text does not automatically wrap; use "\n" for a line break. + * Text is clipped to the bounds. Write-only. * @property {number} font.size=18 - The size of the text, in pixels. Write-only. * @property {number} lineHeight=18 - The height of a line of text, in pixels. Write-only. * @property {Color} color=255,255,255 - The color of the text. Synonym: textColor. Write-only. - * @property {number} alpha=1.0 - The opacity of the overlay, 0.0 - 1.0. Write-only. + * @property {number} alpha=1.0 - The opacity of the overlay, 0.0 – 1.0. Write-only. * @property {Color} backgroundColor=0,0,0 - The color of the background rectangle. Write-only. - * @property {number} backgroundAlpha=0.7 - The opacity of the background rectangle. Write-only. + * @property {number} backgroundAlpha=0.7 - The opacity of the background rectangle, 0.0 – 1.0. + * Write-only. */ /**jsdoc @@ -1478,25 +1478,25 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {number} y - Integer top, y-coordinate value = bounds.y. Write-only. * @property {number} width - Integer width of the rectangle = bounds.width. Write-only. * @property {number} height - Integer height of the rectangle = bounds.height. Write-only. - * + * @property {number} radius=0 - Integer corner radius, in pixels. Write-only. * @property {Color} color=0,0,0 - The color of the overlay. Write-only. - * @property {number} alpha=1.0 - The opacity of the overlay, 0.0 - 1.0. Write-only. + * @property {number} alpha=1.0 - The opacity of the overlay, 0.0 – 1.0. Write-only. * @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 borderColor or borderAlpha are specified. Write-only. - * @property {number} radius=0 - Integer corner radius, in pixels. Write-only. * @property {Color} borderColor=0,0,0 - The color of the border. Write-only. - * @property {number} borderAlpha=1.0 - The opacity of the border, 0.0 - 1.0. + * @property {number} borderAlpha=1.0 - The opacity of the border, 0.0 – 1.0. * Write-only. */ /**jsdoc * The "cube" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1518,26 +1518,33 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} isSolid=false - Synonyms: solid, isFilled, and filled. + * @property {boolean} isSolid=false - true if the overlay is rendered as a solid, false if it is + * rendered as a wire frame. + * Synonyms: solid, isFilled, and filled. * Antonyms: isWire and wire. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". - * + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. */ /**jsdoc * The "sphere" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1559,26 +1566,34 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} isSolid=false - Synonyms: solid, isFilled, and filled. + * @property {boolean} isSolid=false - true if the overlay is rendered as a solid, false if it is + * rendered as a wire frame. + * Synonyms: solid, isFilled, and filled. * Antonyms: isWire and wire. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". - * + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. */ /**jsdoc * The "rectangle3D" {@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 shape + * property value being "Quad". *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1600,20 +1615,27 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} isSolid=false - Synonyms: solid, isFilled, and filled. + * @property {boolean} isSolid=false - true if the overlay is rendered as a solid, false if it is + * rendered as a wire frame. + * Synonyms: solid, isFilled, and filled. * Antonyms: isWire and wire. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". - * + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. */ /**jsdoc - *

A "shape" {@link Overlays.OverlayType|OverlayType} may display as one of the following geometrical shapes:

+ *

A "shape" {@link Overlays.OverlayType|OverlayType} may display as one of the following geometrical + * shapes:

* * * @@ -1626,7 +1648,6 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * * * - * * * * @@ -1642,11 +1663,12 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { /**jsdoc * The "shape" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1668,15 +1690,22 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} isSolid=false - Synonyms: solid, isFilled, and filled. + * @property {boolean} isSolid=false - true if the overlay is rendered as a solid, false if it is + * rendered as a wire frame. + * Synonyms: solid, isFilled, and filled. * Antonyms: isWire and wire. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. * * @property {Overlays.Shape} shape=Hexagon - The geometrical shape of the overlay. */ @@ -1684,6 +1713,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { /**jsdoc * The "model" {@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. *

Deprecated: Use local {@link Entities} instead.

* @typedef {object} Overlays.OverlayProperties-Model * @property {string} name - The name of the overlay. @@ -1697,44 +1727,39 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents'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. - * @property {object.} 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. Read-only. - * @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. Read-only. - * @property {Vec3[]} jointPositions - The absolute positions of the model's joints, in world coordinates. Read-only. - * @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. Currently not used. + * @property {Object.|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. + *

The value can be an object or a JSON string when setting the value; it is a JSON string when getting the value.

+ * @property {Entities.AnimationProperties} animationSettings - An animation to play on the model. */ /**jsdoc * The "text3D" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {Color} color=255,255,255 - The color of the overlay text. Synonym: textColor. + * @property {number} alpha=0.7 - The opacity of the overlay text, 0.0 – 1.0. + *

Currently not used; use textAlpha instead.

+ * * @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 @@ -1756,35 +1781,29 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". - * - * @property {boolean} isFacingAvatar - If true, 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 \n 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 parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. */ /**jsdoc * The "image3D" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1806,31 +1825,31 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. * - * @property {boolean} isFacingAvatar - If true, 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 true, 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 "web3d" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1852,31 +1871,31 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. * - * @property {boolean} isFacingAvatar - If true, 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 "Touch" or "Mouse". + * @property {string} url - The URL of the web page to display. */ /**jsdoc * The "line3d" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * * @property {Vec3} position - The position of the overlay center. Synonyms: p1, point, and * start. @@ -1886,37 +1905,61 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents'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. + *

Currently doesn't work.

+ * * @property {number} endParentJointIndex=65535 - Integer value specifying the skeleton joint that the end point of the line is - * attached to if parentID is an avatar skeleton. A value of 65535 means "no joint". + * attached to if parentID is an avatar skeleton. A value of 65535 means "no joint". + *

Currently doesn't work.

+ * + * @property {Vec3} start - The start point of the line. Synonyms: startPoint and p1. + *

If parentID is set, use localStart to set the local position of the start point.

+ * * @property {Vec3} end - The end point of the line. Synonyms: endPoint and p2. + *

If parentID is set, use localEnd to set the local position of the end point.

+ * + * @property {Vec3} localStart - The local position of the overlay relative to its parent if the overlay has a - * parentID set, otherwise the same value as start. Synonym: localPosition. + * parentID set, otherwise the same value as start. + * * @property {Vec3} localEnd - The local position of the overlay relative to its parent if the overlay has a - * endParentID set, otherwise the same value as end. + * endParentID set, otherwise the same value as end. + * + * @property {number} length - The length of the line, in meters. This can be set after creating a line with start and end - * points. + * points. + *

Currently doesn't work.

+ * + * @property {number} glow=0 - If glow > 0, the line is rendered with a glow. * @property {number} lineWidth=0.02 - Width of the line, in meters. + *

You can set this property's value but currently cannot retrieve its value. Use the strokeWidths + * property to retrieve its value instead.

*/ /**jsdoc * The "grid" {@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. *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. + * @property {number} alpha=0.7 - The opacity of the overlay, 0.0 – 1.0. * @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 @@ -1938,27 +1981,28 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". - * - * @property {boolean} followCamera=true - If true, the grid is always visible even as the camera moves to another position. - * @property {number} majorGridEvery=5 - Integer number of minorGridEvery intervals at which to draw a thick grid line. Minimum value = 1. - * @property {number} minorGridEvery=1 - Real number of meters at which to draw thin grid lines. Minimum value = 0.001. + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * than a joint. */ /**jsdoc * The "circle3d" {@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 + * gizmoType property value being "ring". *

Deprecated: Use local {@link Entities} instead.

* @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, 0.0 - 1.0. * @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 @@ -1975,62 +2019,75 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {Vec3} position - The position of the overlay center. Synonyms: p1, point, and * start. * @property {Vec3} dimensions - The dimensions of the overlay. Synonyms: scale, size. + * Read-only. * @property {Quat} rotation - The orientation of the overlay. Synonym: orientation. * @property {Vec3} localPosition - The local position of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as position. * @property {Quat} localRotation - The orientation of the overlay relative to its parent if the overlay has a * parentID set, otherwise the same value as rotation. Synonym: localOrientation. - * @property {boolean} isSolid=false - Synonyms: solid, isFilled, and filled. + * @property {boolean} isSolid=false - true if the overlay is rendered as a solid, false if it is + * rendered as a wire frame. + * Synonyms: solid, isFilled, and filled. * Antonyms: isWire and wire. - * @property {boolean} ignorePickIntersection=false - If true, picks ignore the overlay. ignoreRayIntersection is a synonym. - * @property {boolean} drawInFront=false - If true, the overlay is rendered in front of objects in the world, but behind the HUD. - * @property {boolean} drawHUDLayer=false - If true, 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 - true if {@link Picks} ignore the overlay, false + * if they don't. + * Synonym: ignoreRayIntersection. + * @property {boolean} drawInFront=false - true if the overlay is rendered on top of the world layer but behind + * the HUD surface. + * @property {boolean} drawHUDLayer=false - true if the overlay is rendered in front of everything, including the + * HUD surface. + * @property {boolean} grabbable=false - true if the overlay can be grabbed, false 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 - * parentID is an avatar skeleton. A value of 65535 means "no joint". + * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is + * parented to if parentID is set. Use 65535 or -1 to parent to the parents'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: radius. - * @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 - * innerStartColor, innerEndColor, outerStartColor, and outerEndColor. + * @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: radius. + * @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 innerStartColor, + * innerEndColor, outerStartColor, and outerEndColor. + * Write-only. * @property {Color} startColor - Sets the values of innerStartColor and outerStartColor. - * Write - only. + * Write-only. * @property {Color} endColor - Sets the values of innerEndColor and outerEndColor. - * Write - only. + * Write-only. * @property {Color} innerColor - Sets the values of innerStartColor and innerEndColor. - * Write - only. + * Write-only. * @property {Color} outerColor - Sets the values of outerStartColor and outerEndColor. - * Write - only. - * @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, 0.0 -1.0. Setting this value also sets - * the values of innerStartAlpha, innerEndAlpha, outerStartAlpha, and - * outerEndAlpha. Synonym: Alpha; write - only. + * Write-only. + * @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, 0.0 – 1.0. Setting this value + * sets the values of innerStartAlpha, innerEndAlpha, outerStartAlpha, and + * outerEndAlpha. Synonym: Alpha. * @property {number} startAlpha - Sets the values of innerStartAlpha and outerStartAlpha. - * Write - only. + * Write-only. * @property {number} endAlpha - Sets the values of innerEndAlpha and outerEndAlpha. - * Write - only. + * Write-only. * @property {number} innerAlpha - Sets the values of innerStartAlpha and innerEndAlpha. - * Write - only. + * Write-only. * @property {number} outerAlpha - Sets the values of outerStartAlpha and outerEndAlpha. - * Write - only. - * @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. + * Write-only. + * @property {number} innerStartAlpha=0.7 - The opacity at the inner start point of the overlay, 0.0 – + * 1.0. + * @property {number} innerEndAlpha=0.7 - The opacity at the inner end point of the overlay, 0.0 – + * 1.0. + * @property {number} outerStartAlpha=0.7 - The opacity at the outer start point of the overlay, 0.0 – + * 1.0. + * @property {number} outerEndAlpha=0.7 - The opacity at the outer end point of the overlay, 0.0 – + * 1.0. * - * @property {boolean} hasTickMarks = false - If true, 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 - true if tick marks are drawn, false 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. */
ValueDimensionsDescription
"Dodecahedron"3D
"Hexagon"3DA hexagonal prism.
"Icosahedron"3D
"Line"1DA line oriented in 3D.
"Octagon"3DAn octagonal prism.
"Octahedron"3D
"Quad"2DA square oriented in 3D.