1. 材质配置类

位于:BOS3D.Plugins.MaterialConfig

1.1. 实例化

var config = new BOS3D.Plugins.MaterialConfig();

1.2. 属性

1.2.1. id

/**
 * 材质对象ID
 * @var {String} MaterialConfig.id
 */

1.2.2. offset

/**
 * 贴图u、v方向偏移值
 * @var {Array} MaterialConfig.offset
 */

1.2.3. rotation

/**
 * 贴图旋转角度
 * @var {Number} MaterialConfig.rotation
 */

1.2.4. scale

/**
 * 贴图u、v方向缩放比例
 * @var {Array} MaterialConfig.scale
 */

1.2.5. viewer

/**
 * Viewer对象
 * @property {Object}  viewer
 */

1.2.6. src

/**
 * 贴图路径
 * @var {String} MaterialConfig.src
 */

1.2.7. canvas

/**
 * HTML的Canvas对象
 * @var {Canvas} MaterialConfig.canvas
 */

1.2.8. transparent

/**
 * 是否支持透明贴图,默认为false
 * @var {Boolean} MaterialConfig.transparent
 */

1.2.9. side

/**
 *    0:单面正面,1:单面反面,2:双面,默认值为0
 * @var {Number} MaterialConfig.side
 */

1.2.10. callback

/**
 * 贴图加载完毕的回调函数
 * @var {Function} MaterialConfig.callback
 */

1.2.11. reverse

/**
 * 是否沿水平轴镜像翻转贴图,默认值为false
 * @var {Boolean} MaterialConfig.reverse
 */

2. 材质类

位于:BOS3D.Plugins.Material

2.1. 实例化

let materialConfig = new BOS3D.Plugins.MaterialConfig();
materialConfig.src = "./***.png";
materialConfig.viewer = viewer3D;
materialConfig.callback = function (texture, mat) {};
let material = new BOS3D.Plugins.Material(materialConfig);

2.2. 属性

2.3. 方法

2.3.1. enableTransparent

是否启用透明贴图

名称 说明 类型 是否必须 示例
isEnabled 是否启用透明贴图 Boolean false
返回值说明 类型 示例
null null

调用方式:

/**
 * 是否启用透明贴图
 * @function enableTransparent
 * @param {Boolean} isEnabled 是否启用透明贴图
 * @return {void}
 */
material.enableTransparent(true);

2.3.2. getId

获取材质对象 id

名称 说明 类型 是否必须 示例
null null null null
返回值说明 类型 示例
材质对象 id String "123abc"

调用方式:

/**
 * 获取材质对象id
 * @function getId
 * @returns {String} 材质对象id
 */

material.getId();

2.3.3. getOffset

获取贴图 u、v 方向偏移值

名称 说明 类型 是否必须 示例
null null null null
返回值说明 类型 示例
偏移值 Array [1,1]

调用方式:

/**
 * 获取贴图u、v方向偏移值
 * @function getOffset
 * @returns {Array} 贴图u、v方向偏移值
 */

material.getOffset();

2.3.4. setOffset

设置贴图 u、v 方向偏移值

名称 说明 类型 是否必须 示例
offset 偏移值 Array [1,1]
返回值说明 类型 示例
null null

调用方式:

/**
 * 设置贴图u、v方向偏移值
 * @function setOffset
 * @param {Array} offset 贴图u、v方向偏移值
 * @return {void}
 */

material.setOffset([1, 1]);

2.3.5. getRotation

获取贴图旋转角度

返回值说明 类型 示例
贴图旋转角度 Number 0.5

调用方式:

/**
 * 获取贴图旋转角度
 * @function getRotation
 * @returns {Number} 贴图旋转角度
 */

material.getRotation();

2.3.6. setRotation

设置贴图旋转角度

名称 说明 类型 是否必须 示例
rotation 贴图旋转角度 Number 0.5
返回值说明 类型 示例
null null

调用方式:

/**
 * 设置贴图旋转角度
 * @function setRotation
 * @param {Number} rotation 贴图旋转角度
 * @return {void}
 */

material.setRotation(0.5);

2.3.7. getScale

获取贴图 u、v 方向缩放比例

返回值说明 类型 示例
缩放比例 Array [1,1]

调用方式:

/**
 * 获取贴图u、v方向缩放比例
 * @function getScale
 * @returns {Array} 贴图u、v方向缩放比例
 */

material.getScale();

2.3.8. setScale

设置贴图 u、v 方向缩放比例

名称 说明 类型 是否必须 示例
scale 缩放比例 Array [1,1]
返回值说明 类型 示例
null null

调用方式:

/**
 * 设置贴图u、v方向缩放比例
 * @function setScale
 * @param  {Array} scale 贴图u、v方向缩放比例
 * @return {void}
 */

material.setScale([1, 1]);

2.3.9. getSrc

获取贴图路径

返回值说明 类型 示例
贴图路径 String "./***.png"

调用方式:

/**
 * 获取贴图路径
 * @function getSrc
 * @returns {String} 贴图路径
 */

material.getSrc();

2.3.10. setSrc

设置贴图路径

名称 说明 类型 是否必须 示例
src 贴图路径 String "./***.png"
返回值说明 类型 示例
null null

调用方式:

/**
 * 设置贴图路径
 * @function setSrc
 * @param {String} src 贴图路径
 * @return {void}
 */

material.setSrc("./***.png");

2.3.11. getCanvas

获取 Canvas 对象

返回值说明 类型 示例
HTML 的 Canvas 对象 Canvas

调用方式:

/**
 * 获取Canvas对象
 * @function getCanvas
 * @returns {Canvas} HTML的Canvas对象
 */

material.getCanvas();

2.3.12. setCanvas

设置 Canvas 对象

名称 说明 类型 是否必须 示例
canvas HTML 的 Canvas 对象 Canvas
返回值说明 类型 示例
null null

调用方式:

/**
 * 设置Canvas对象
 * @function setCanvas
 * @param {Canvas} canvas HTML的Canvas对象
 * @return {void}
 */

material.setCanvas(<canvas></canvas>);

2.3.13. reverse

沿水平轴镜像翻转贴图

名称 说明 类型 是否必须 示例
null null null null
返回值说明 类型 示例
null null

调用方式:

/**
 * 沿水平轴镜像翻转贴图
 * @function reverse
 * @return {void}
 */

material.reverse();
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-06-27 15:28:07

results matching ""

    No results matching ""