/*global define*/ define([ '../Core/defined', '../Core/defineProperties', '../Core/DeveloperError' ], function( defined, defineProperties, DeveloperError) { "use strict"; /** * A model's material with modifiable parameters. A glTF material * contains parameters defined by the material's technique with values * defined by the technique and potentially overridden by the material. * This class allows changing these values at runtime. *
* Use {@link Model#getMaterial} to create an instance. *
* * @alias ModelMaterial * @internalConstructor * * @see Model#getMaterial */ var ModelMaterial = function(model, material, id) { this._name = material.name; this._id = id; this._uniformMap = model._uniformMaps[id]; }; defineProperties(ModelMaterial.prototype, { /** * The value of thename
property of this material. This is the
* name assigned by the artist when the asset is created. This can be
* different than the name of the material property ({@link ModelMaterial#id}),
* which is internal to glTF.
*
* @memberof ModelMaterial.prototype
*
* @type {String}
* @readonly
*/
name : {
get : function() {
return this._name;
}
},
/**
* The name of the glTF JSON property for this material. This is guaranteed
* to be unique among all materials. It may not match the material's
* name
property (@link ModelMaterial#name), which is assigned by
* the artist when the asset is created.
*
* @memberof ModelMaterial.prototype
*
* @type {String}
* @readonly
*/
id : {
get : function() {
return this._id;
}
}
});
/**
* Assigns a value to a material parameter. The type for value
* depends on the glTF type of the parameter. It will be a floating-point
* number, Cartesian, or matrix.
*
* @param {String} name The name of the parameter.
* @param {Object} [value] The value to assign to the parameter.
*
* @exception {DeveloperError} name must match a parameter name in the material's technique that is targetable and not optimized out.
*
* @example
* material.setValue('diffuse', new Cesium.Cartesian4(1.0, 0.0, 0.0, 1.0)); // vec4
* material.setValue('shininess', 256.0); // scalar
*/
ModelMaterial.prototype.setValue = function(name, value) {
//>>includeStart('debug', pragmas.debug);
if (!defined(name)) {
throw new DeveloperError('name is required.');
}
//>>includeEnd('debug');
var v = this._uniformMap.values[name];
//>>includeStart('debug', pragmas.debug);
if (!defined(v)) {
throw new DeveloperError('name must match a parameter name in the material\'s technique that is targetable and not optimized out.');
}
//>>includeEnd('debug');
v.value = v.clone(value, v.value);
};
/**
* Returns the value of the parameter with the given name
. The type of the
* returned object depends on the glTF type of the parameter. It will be a floating-point
* number, Cartesian, or matrix.
*
* @param {String} name The name of the parameter.
* @returns {Object} The value of the parameter or undefined
if the parameter does not exist.
*/
ModelMaterial.prototype.getValue = function(name) {
//>>includeStart('debug', pragmas.debug);
if (!defined(name)) {
throw new DeveloperError('name is required.');
}
//>>includeEnd('debug');
var v = this._uniformMap.values[name];
if (!defined(v)) {
return undefined;
}
return v.value;
};
return ModelMaterial;
});