Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-08 00:52:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #15521 from ctrlaltdavid/M22489

Browse source 
Case 22489: Scene JSDoc
This commit is contained in:
Shannon Romano 2019-05-13 15:49:44 -07:00 committed by GitHub
commit 72d000a76d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 57 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
libraries/script-engine/src/SceneScriptingInterface.h
View file

@ -21,10 +21,11 @@
namespace SceneScripting {
/**jsdoc
* @typedef {object} Scene.Stage.Location
* @property {number} longitude
* @property {number} latitude
* @property {number} altitude
* Stage location.
* @typedef {object} Stage.Location
* @property {number} longitude - Longitude.
* @property {number} latitude - Latitude.
* @property {number} altitude - Altitude.
*/
class Location : public QObject {
Q_OBJECT
@ -49,9 +50,10 @@ namespace SceneScripting {
using LocationPointer = std::unique_ptr<Location>;
/**jsdoc
* @typedef {object} Scene.Stage.Time
* @property {number} hour
* @property {number} day
* Stage time.
* @typedef {object} Stage.Time
* @property {number} hour - Hour.
* @property {number} day - Day.
*/
class Time : public QObject {
Q_OBJECT
@ -73,11 +75,12 @@ namespace SceneScripting {
using TimePointer = std::unique_ptr<Time>;
/**jsdoc
* @typedef {object} Scene.Stage.KeyLight
* @property {Vec3} color
* @property {number} intensity
* @property {number} ambientIntensity
* @property {Vec3} direction
* Stage key light.
* @typedef {object} Stage.KeyLight
* @property {Vec3} color - Color.
* @property {number} intensity - Intensity.
* @property {number} ambientIntensity - Ambient intensity.
* @property {Vec3} direction - Direction.
*/
class KeyLight : public QObject {
Q_OBJECT
@ -111,17 +114,28 @@ namespace SceneScripting {
using KeyLightPointer = std::unique_ptr<KeyLight>;
/**jsdoc
* @class Scene.Stage
* The <code>Stage</code> class is no longer used.
*
* <p>Provided as a property in the {@link Scene} API.</p>
*
* <p class="important">Deprecated: This class is deprecated and will be removed.</p>
*
* @class Stage
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
* @property {string} backgroundMode
* @property {Scene.Stage.KeyLight} keyLight
* @property {Scene.Stage.Location} location
* @property {boolean} sunModel
* @property {Scene.Stage.Time} time
* @property {string} backgroundMode - Background mode.
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
* @property {Stage.KeyLight} keyLight - Key light.
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
* @property {Stage.Location} location - Location.
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
* @property {boolean} sunModel - Sun model.
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
* @property {Stage.Time} time - Time.
* <p class="important">Deprecated: This property is deprecated and will be removed.</p>
*/
class Stage : public QObject {
Q_OBJECT
@ -132,8 +146,9 @@ namespace SceneScripting {
_location{ new Location{ skyStage } }, _time{ new Time{ skyStage } }, _keyLight{ new KeyLight{ skyStage } }{}
/**jsdoc
* @function Scene.Stage.setOrientation
* @param {Quat} orientation
* @function Stage.setOrientation
* @param {Quat} orientation - Orientation.
* @deprecated This method is deprecated and will be removed.
*/
Q_INVOKABLE void setOrientation(const glm::quat& orientation) const;
@ -142,10 +157,11 @@ namespace SceneScripting {
Location* getLocation() const { return _location.get(); }
/**jsdoc
* @function Scene.Stage.setLocation
* @param {number} longitude
* @param {number} latitude
* @param {number} altitude
* @function Stage.setLocation
* @param {number} longitude - Longitude.
* @param {number} latitude - Latitude.
* @param {number} altitude - Altitude.
* @deprecated This method is deprecated and will be removed.
*/
Q_INVOKABLE void setLocation(float longitude, float latitude, float altitude);
@ -175,15 +191,20 @@ namespace SceneScripting {
};
/**jsdoc
* The <code>Scene</code> API provides some control over what is rendered.
*
* @namespace Scene
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
* @property {boolean} shouldRenderAvatars
* @property {boolean} shouldRenderEntities
* @property {Scene.Stage} stage
* @property {boolean} shouldRenderAvatars - <code>true</code> if avatars are rendered, <code>false</code> if they aren't.
* @property {boolean} shouldRenderEntities - <code>true</code> if entities (domain, avatar, and local) are rendered,
* <code>false</code> if they aren't.
* @property {Stage} stage - Stage. <em>Read-only.</em>
* <p class="important">Deprecated: This property is deprecated and will be removed. Use {@link Entities| Zone entities}
* for lighting instead.</p>
*/
class SceneScriptingInterface : public QObject, public Dependency {
Q_OBJECT
@ -205,15 +226,22 @@ public:
signals:
/**jsdoc
* Triggered when whether or not avatars are rendered changes.
* @function Scene.shouldRenderAvatarsChanged
* @param {boolean} shouldRenderAvatars
* @param {boolean} shouldRenderAvatars - <code>true</code> if avatars are rendered, <code>false</code> if they aren't.
* @returns {Signal}
* @example <caption>Report when the rendering of avatars changes.</caption>
* Scene.shouldRenderAvatarsChanged.connect(function (shouldRenderAvatars) {
* print("Should render avatars changed to: " + shouldRenderAvatars);
* });
*/
void shouldRenderAvatarsChanged(bool shouldRenderAvatars);
/**jsdoc
* Triggered when whether or not entities are rendered changes.
* @function Scene.shouldRenderEntitiesChanged
* @param {boolean} shouldRenderEntities
* @param {boolean} shouldRenderEntities - <code>true</code> if entities (domain, avatar, and local) are rendered,
* <code>false</code> if they aren't.
* @returns {Signal}
*/
void shouldRenderEntitiesChanged(bool shouldRenderEntities);