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

Update MeshProxy and Entities.getMeshes() JSDoc

Browse source
This commit is contained in:
David Rowe 2019-12-20 13:34:21 +13:00
parent 1ebc6a575e
commit 8255a50cde
2 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
libraries/entities/src/EntityScriptingInterface.h
View file

@ -1867,7 +1867,8 @@ public slots:
* @function Entities.getMeshes * @function Entities.getMeshes
* @param {Uuid} entityID - The ID of the <code>Model</code> or <code>PolyVox</code> entity to get the meshes of. * @param {Uuid} entityID - The ID of the <code>Model</code> or <code>PolyVox</code> entity to get the meshes of.
* @param {Entities~getMeshesCallback} callback - The function to call upon completion. * @param {Entities~getMeshesCallback} callback - The function to call upon completion.
* @deprecated This function is deprecated and will be removed. Use the {@link Graphics} API instead. * @deprecated This function is deprecated and will be removed. It no longer works for Model entities. Use the
* {@link Graphics} API instead.
*/ */
/**jsdoc /**jsdoc
* Called when a {@link Entities.getMeshes} call is complete. * Called when a {@link Entities.getMeshes} call is complete.
@ -1876,7 +1877,8 @@ public slots:
* <code>Model</code> or <code>PolyVox</code> entity; otherwise <code>undefined</code>. * <code>Model</code> or <code>PolyVox</code> entity; otherwise <code>undefined</code>.
* @param {boolean} success - <code>true</code> if the {@link Entities.getMeshes} call was successful, <code>false</code> * @param {boolean} success - <code>true</code> if the {@link Entities.getMeshes} call was successful, <code>false</code>
* otherwise. The call may be unsuccessful if the requested entity could not be found. * otherwise. The call may be unsuccessful if the requested entity could not be found.
* @deprecated This function is deprecated and will be removed. Use the {@link Graphics} API instead. * @deprecated This function is deprecated and will be removed. It no longer works for Model entities. Use the
* {@link Graphics} API instead.
*/ */
// FIXME move to a renderable entity interface // FIXME move to a renderable entity interface
Q_INVOKABLE void getMeshes(const QUuid& entityID, QScriptValue callback); Q_INVOKABLE void getMeshes(const QUuid& entityID, QScriptValue callback);

9
libraries/shared/src/RegisteredMetaTypes.h
View file

@ -687,7 +687,8 @@ namespace graphics {
using MeshPointer = std::shared_ptr<graphics::Mesh>; using MeshPointer = std::shared_ptr<graphics::Mesh>;
/**jsdoc /**jsdoc
* A handle for a mesh in an entity, such as returned by {@link Entities.getMeshes}. * A mesh, such as returned by {@link Entities.getMeshes} or {@link Model} API functions.
*
* @class MeshProxy * @class MeshProxy
* *
* @hifi-interface * @hifi-interface
@ -705,16 +706,16 @@ public:
virtual MeshPointer getMeshPointer() const = 0; virtual MeshPointer getMeshPointer() const = 0;
/**jsdoc /**jsdoc
* Get the number of vertices in the mesh. * Gets the number of vertices in the mesh.
* @function MeshProxy#getNumVertices * @function MeshProxy#getNumVertices
* @returns {number} Integer number of vertices in the mesh. * @returns {number} Integer number of vertices in the mesh.
*/ */
Q_INVOKABLE virtual int getNumVertices() const = 0; Q_INVOKABLE virtual int getNumVertices() const = 0;
/**jsdoc /**jsdoc
* Get the position of a vertex in the mesh. * Gets the position of a vertex in the mesh.
* @function MeshProxy#getPos * @function MeshProxy#getPos
* @param {number} index - Integer index of the mesh vertex. * @param {number} index - Integer index of the vertex.
* @returns {Vec3} Local position of the vertex relative to the mesh. * @returns {Vec3} Local position of the vertex relative to the mesh.
*/ */
Q_INVOKABLE virtual glm::vec3 getPos(int index) const = 0; Q_INVOKABLE virtual glm::vec3 getPos(int index) const = 0;