Material - YouScene Documentation

Material

材质

new YS.Material(property)

材质类，Material类的材质可通用

Name	Type	Description
`property`	MaterialProperty	optional 实际属性,sdk内部使用

Example:

颜色线
 var line = new YS.Line({
 id: 'line1',
 points: [...],
 width: 3,
 material: YS.Material.colorMaterial()
});

See:

LineMaterial 专用于Line的材质
CircleMaterial 专用于圆形的材质

Methods

staticYS.Material.checkerboardMaterial(options) → Material

棋盘材质

Name Type Description

options

Object

对象有下面这些属性：

Name	Type	Default	Description
`evenColor`	Color	`Color.WHITE`	optional 棋盘的第一个颜色
`oddColor`	Color	`Color.BLACK`	optional 棋盘的第二个颜色
`repeat`	Object	`{x: 4, y: 4}`	optional 指定图块在每个方向上的重复次数

Returns:

返回构造的材质

staticYS.Material.colorMaterial(color) → Material

颜色材质

Name	Type	Default	Description
`color`	Color	`Color.WHITE`	optional 颜色

Returns:

返回构造的材质

staticYS.Material.dynamicMaterial(options) → Material

动态图片材质

Name Type Description

options

Object

对象有下面这些属性：

Name	Type	Default	Description
`image`	MaterialImage \| String	`MaterialImage.Fence`	optional 图片路径
`color`	Color	`Color.WHITE`	optional 图块渲染的颜色
`axis`	Boolean	`false`	optional 指定图块和动画的渲染方向，false为X轴渲染，true为Y轴渲染
`repeat`	Object	`{x: 5, y: 1}`	optional 指定图块的重复次数
`time`	Number	`1.5`	optional 动画执行一次的时间，时间越小，速度越快

Returns:

返回构造的材质

Example:

动态箭头线
 var line = new YS.Line({
 id: 'line1',
 points: [...],
 width: 10,
 material: YS.Material.dynamicMaterial({
     image: YS.MaterialImage.Arrow
 })
});

staticYS.Material.gridMaterial(options) → Material

网格材质

Name Type Description

options

Object

对象有下面这些属性：

Name	Type	Default	Description
`color`	Color	`Color.WHITE`	optional 网格的颜色
`cellAlpha`	Number	`0.1`	optional 网格的单元格的透明度
`lineCount`	Object	`{x: 8, y: 8}`	optional 指定每个轴的网格线的数量
`lineThickness`	Object	`{x: 1, y: 1}`	optional 指定每个轴的网格线的粗细
`lineOffset`	Object	`{x: 0, y: 0}`	optional 指定每个轴的网格线的起始偏移量

Returns:

返回构造的材质

staticYS.Material.imageMaterial(options) → Material

图片材质

Name Type Description

options

Object

对象有下面这些属性：

Name	Type	Default	Description
`image`	*		图像的url,或者canvas或者视频dom
`repeat`	Object	`{x: 1, y: 1}`	optional 指定图像在x,y方向上的重复次数
`color`	Color	`Color.WHITE`	optional 应用于图像的颜色

Returns:

返回构造的材质

staticYS.Material.stripeMaterial(options) → Material

条纹材质

Name Type Description

options

Object

对象有下面这些属性：

Name	Type	Default	Description
`orientation`	Boolean	`true`	optional 条纹的方向，true表示水平方向，false表示垂直方向
`evenColor`	Color	`Color.WHITE`	optional 条纹的第一个颜色
`oddColor`	Color	`Color.BLACK`	optional 条纹的第二个颜色
`offset`	Number	`0`	optional 指定条纹的起始偏移量
`repeat`	Number	`2`	optional 指定条纹重复的次数

Returns:

返回构造的材质

staticYS.Material.wavesMaterial() → Material

海浪材质

Returns:

返回构造的材质

toCesiumMaterial() → Cesium.Material

获取Cesium的材质用于加在geometry上