1. 火焰效果类

位于：BOS3D.Plugins.Fire

通过参数可以控制只生成烟雾，烟雾的浓度可以通过缩放比例设置

1.1. 实例化

参数

/**
 * 火焰效果
 * @constructor Fire
 * @param {object} [options] 火焰效果的配置参数
 * @param {object} options.position 火焰效果位置，默认为{x:0,y:0,z:0}
 * @param {number} options.scale 火焰效果整体的大小在原始基础上的缩放比例，默认为1
 * @param {number} options.fireScale 火焰效果中火焰部分的大小在原始基础上的缩放比例，默认为1，浓度也可以通过改参数调整
 * @param {number} options.smokeScale 火焰效果中烟雾部分的大小在原始基础上的缩放比例，默认为1，浓度也可以通过改参数调整
 * @param {boolean} options.enableFire 是否显示火焰部分，默认为true
 * @param {boolean} options.enableSmoke 是否显示烟雾部分，默认为true
 * @return {void}
 */
let option = {
    position: {
        x: 0,
        y: 0,
        z: 0,
    },
    scale: 1,
    fireScale: 1,
    smokeScale: 1,
    enableFire: true,
    enableSmoke: true,
};
var fire = new BOS3D.Plugins.Fire(option);
viewer3D.addExternalObject("fire", fire);

demo 示例

1.2. 属性

1.3. 方法

1.3.1. getPosition

获取火焰的插入点

调用方式：

/**
 * 获取火焰的插入点
 * @function  getPosition
 * @return {Object} 火焰的插入点 例如{x:1,y:1,z:1}
 */
var fire = new BOS3D.Plugins.Fire();
var position = fire.getPosition();

1.3.2. setPosition

设置火焰对象的插入点

调用方式：

/**
 * 设置火焰对象的插入点
 * @function  setPosition
 * @param {Object} position 火焰的插入点 例如{x:1,y:1,z:1}
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setPosition({ x: 1, y: 1, z: 1 });

1.3.3. getScale

获取火焰对象的缩放比例

调用方式：

/**
 * 获取火焰对象的缩放比例
 * @function  getScale
 * @return {Number} 火焰对象的缩放比例
 */
var fire = new BOS3D.Plugins.Fire();
fire.getScale();

1.3.4. setScale

设置火焰对象的缩放比例

调用方式：

/**
 * 设置火焰对象的缩放比例
 * @function setScale
 * @param {Number} scale 火焰对象的缩放比例
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setScale(4);

1.3.5. setFireScale

单独设置火焰部分的缩放比例

调用方式：

/**
 /**
 * 单独设置火焰部分的缩放比例
 * @function setFireScale
 * @param {float} scale 火焰部分的缩放比例，在原数值上乘当前数值
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setFireScale(4);

1.3.6. setSmokeScale

单独设置烟雾部分的缩放比例

调用方式：

/**
 * 单独设置烟雾部分的缩放比例
 * @function setSmokeScale
 * @param {float} scale 烟雾部分的缩放比例，在原数值上乘当前数值
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setSmokeScale(4);

1.3.7. setSpeed

设置火焰的运动速度

调用方式：

/**
 * 设置火焰对象的运动速度
 * @function setSpeed
 * @param {Number} scale 火焰对象的运动速度
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setSpeed(4);

1.3.8. setDirection

设置火焰的运动方向

调用方式：

/**
 * 设置火焰对象的方向
 * @function ParticleSystem.Fire.prototype.setDirection
 * @param {Vector3} direction 火焰对象的运动方向
 * @returns {Number}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setDirection(new THREE.Vector3(0, 0, 1));

1.3.9. setOptions

设置火焰效果的参数

调用方式：

/**
 * 设置火焰效果的参数
 * @function setOptions
 *  @param {object} [options] 火焰效果的配置参数
 * @param {object} options.position 火焰效果位置，默认为{x:0,y:0,z:0}
 * @param {number} options.scale 火焰效果整体的大小在原始基础上的缩放比例，默认为1
 * @param {number} options.fireScale 火焰效果中火焰部分的大小在原始基础上的缩放比例，默认为1，浓度也可以通过改参数调整
 * @param {number} options.smokeScale 火焰效果中烟雾部分的大小在原始基础上的缩放比例，默认为1，浓度也可以通过改参数调整
 * @param {boolean} options.enableFire 是否显示火焰部分，默认为true
 * @param {boolean} options.enableSmoke 是否显示烟雾部分，默认为true
 * @return {void}
 * */
let option = {
    position: {
        x: 0,
        y: 0,
        z: 0,
    },
    scale: 1,
    fireScale: 1,
    smokeScale: 1,
    enableFire: true,
    enableSmoke: true,
};
var fire = new BOS3D.Plugins.Fire();
fire.setOptions(option);

1.3.10. getOptions

获取火焰效果的参数

调用方式：

/**
 * 获取火焰效果的参数
 * @function getOptions
 * @return {Object} [options] 火焰效果的参数
 * @return {object} options.position 火焰效果位置
 * @return {number} options.scale 火焰效果整体的大小在原始基础上的缩放比例
 * @return {number} options.fireScale 火焰效果中火焰部分的大小在原始基础上的缩放比例
 * @return {number} options.smokeScale 火焰效果中烟雾部分的大小在原始基础上的缩放比例
 * @return {boolean} options.enableFire 是否显示火焰部分
 * @return {boolean} options.enableSmoke 是否显示烟雾部分
 *
 * */
var fire = new BOS3D.Plugins.Fire();
let op = fire.getOptions();

1.3.11. setDistance

设置火焰效果的运动距离

调用方式：

/**
 * 设置火焰整体对象的运动距离比例
 * @function ParticleSystem.Fire.prototype.setDistance
 * @param {Number} distance 运动距离比例
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setDistance(5);

1.3.12. setFireDistance

设置火焰效果的火焰部分运动距离

调用方式：

/**
 * 设置火焰效果的火焰部分运动距离
 * @function ParticleSystem.Fire.prototype.setFireDistance
 * @param {Number} distance 运动距离比例
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setFireDistance(5);

1.3.13. setSmokeDistance

设置火焰效果的烟雾部分运动距离

调用方式：

/**
 * 设置火焰效果的烟雾部分运动距离
 * @function ParticleSystem.Fire.prototype.setSmokeDistance
 * @param {Number} distance 运动距离比例
 * @return {void}
 */
var fire = new BOS3D.Plugins.Fire();
fire.setSmokeDistance(5);