Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-29 18:42:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #12915 from ctrlaltdavid/21849

Browse source 
Add Entities materialData JSDoc
This commit is contained in:
MiladNazeri 2018-04-19 13:49:24 -07:00 committed by GitHub
commit 7e780ed55a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
libraries/entities/src/EntityItemProperties.cpp
View file

@ -695,8 +695,8 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* @typedef {object} Entities.EntityProperties-Material * @typedef {object} Entities.EntityProperties-Material
* @property {string} materialURL="" - URL to a {@link MaterialResource}. If you append <code>?name</code> to the URL, the * @property {string} materialURL="" - URL to a {@link MaterialResource}. If you append <code>?name</code> to the URL, the
* material with that name in the {@link MaterialResource} will be applied to the entity. <br /> * material with that name in the {@link MaterialResource} will be applied to the entity. <br />
* Alternatively, set the property value to <code>"userData"</code> to use the {@link Entities.EntityProperties|userData} * Alternatively, set the property value to <code>"materialData"</code> to use the <code>materialData</code> property
* entity property to live edit the material resource values. * for the {@link MaterialResource} values.
* @property {number} priority=0 - The priority for applying the material to its parent. Only the highest priority material is * @property {number} priority=0 - The priority for applying the material to its parent. Only the highest priority material is
* applied, with materials of the same priority randomly assigned. Materials that come with the model have a priority of * applied, with materials of the same priority randomly assigned. Materials that come with the model have a priority of
* <code>0</code>. * <code>0</code>.
@ -710,6 +710,9 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* <code>{ x: 0, y: 0 }</code> &ndash; <code>{ x: 1, y: 1 }</code>. * <code>{ x: 0, y: 0 }</code> &ndash; <code>{ x: 1, y: 1 }</code>.
* @property {Vec2} materialMappingScale=1,1 - How much to scale the material within the parent's UV-space. * @property {Vec2} materialMappingScale=1,1 - How much to scale the material within the parent's UV-space.
* @property {number} materialMappingRot=0 - How much to rotate the material within the parent's UV-space, in degrees. * @property {number} materialMappingRot=0 - How much to rotate the material within the parent's UV-space, in degrees.
* @property {string} materialData="" - Used to store {@link MaterialResource} data as a JSON string. You can use
* <code>JSON.parse()</code> to parse the string into a JavaScript object which you can manipulate the properties of, and
* use <code>JSON.stringify()</code> to convert the object into a string to put in the property.
* @example <caption>Color a sphere using a Material entity.</caption> * @example <caption>Color a sphere using a Material entity.</caption>
* var entityID = Entities.addEntity({ * var entityID = Entities.addEntity({
* type: "Sphere", * type: "Sphere",
@ -722,13 +725,14 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* var materialID = Entities.addEntity({ * var materialID = Entities.addEntity({
* type: "Material", * type: "Material",
* parentID: entityID, * parentID: entityID,
* materialURL: "userData", * materialURL: "materialData",
* priority: 1, * priority: 1,
* userData: JSON.stringify({ * materialData: JSON.stringify({
* materialVersion: 1,
* materials: { * materials: {
* // Can only set albedo on a Shape entity. * // Can only set albedo on a Shape entity.
* // Value overrides entity's "color" property. * // Value overrides entity's "color" property.
* albedo: [1.0, 0, 0] * albedo: [1.0, 1.0, 0] // Yellow
* } * }
* }), * }),
* }); * });