Skip to content
导航

mask

遮罩功能,可以实现复杂的裁剪,并且支持半透明的遮罩。

关键属性

isMask: boolean

元素是否为遮罩, 默认为 false。

设为遮罩后,自身不渲染,所属 Group 内的上层元素受此遮罩影响,遮罩下层元素不受影响。

示例

将圆环设为遮罩

ts
import { Leafer, Group, Ellipse, Image } from 'leafer-ui'

const leafer = new Leafer({ view: window })

const group = new Group({ x: 100, y: 100 })

const ellipse = new Ellipse({ 
    width: 100,
    height: 100,
    isMask: true,
    innerRadius: 0.5,
    fill: 'black'
})

const image = new Image({
    width: 100,
    height: 100,
    url: 'image/leafer.jpg'
})

leafer.add(group)

group.add(ellipse)   
group.add(image)

将半透明的圆环设为遮罩

ts
import { Leafer, Group, Ellipse, Image } from 'leafer-ui'

const leafer = new Leafer({ view: window })

const group = new Group({ x: 100, y: 100 })

const ellipse = new Ellipse({ 
    width: 100,
    height: 100,
    isMask: true,
    opacity: 0.5,
    innerRadius: 0.5,
    fill: 'black'
})

const image = new Image({
    width: 100,
    height: 100,
    url: 'image/leafer.jpg'
})

leafer.add(group)

group.add(ellipse)   
group.add(image)

将圆形组设为遮罩

ts
import { Leafer, Group, Ellipse, Image } from 'leafer-ui'

const leafer = new Leafer({ view: window })

const group = new Group({ x: 100, y: 100 })

const circleGroup = new Group({  
    isMask: true
})

circleGroup.add(new Ellipse({ width: 60, height: 60, fill: 'black' }))
circleGroup.add(new Ellipse({ x: 50, y: 50, width: 50, height: 50, fill: 'black' }))

const image = new Image({
    width: 100,
    height: 100,
    url: 'image/leafer.jpg'
})

leafer.add(group)

group.add(circleGroup)   
group.add(image)

将路径设为遮罩

ts
import { Leafer, Group, Path, Image } from 'leafer-ui'

const leafer = new Leafer({ view: window })

const group = new Group({ x: 100, y: 100 })

const path = new Path({   
    scaleX: 0.1,
    scaleY: 0.1,
    isMask: true,
    path: 'M945.344 586.304c-13.056-93.44-132.48-98.048-132.48-98.048 0-29.888-39.808-47.424-39.808-47.424L201.664 440.832c-36.736 0-42.112 51.264-42.112 51.264 7.68 288 181.44 382.976 181.44 382.976l299.456 0c42.88-31.36 101.888-122.56 101.888-122.56 9.216 3.072 72.768-0.832 97.984-6.144C865.6 740.992 958.336 679.68 945.344 586.304zM365.568 825.28c-145.472-105.664-130.944-328.576-130.944-328.576l80.448 0c-44.416 126.4 43.648 285.696 55.872 307.904C383.232 826.816 365.568 825.28 365.568 825.28zM833.472 694.272c-37.568 22.272-65.152 7.68-65.152 7.68 39.04-54.4 42.112-159.296 42.112-159.296 6.848 2.304 12.288-26.048 61.312 23.744C920.768 616.128 871.04 672.064 833.472 694.272z M351.68 129.856c0 0-119.424 72.832-44.416 140.928 75.008 68.16 68.16 93.44 24.512 153.216 0 0 81.92-41.344 71.168-104.192s-89.6-94.208-72.768-137.792C347.136 138.304 351.68 129.856 351.68 129.856z M615.232 91.648c0 0-119.488 72.832-44.352 140.928 74.944 68.16 68.032 93.44 24.448 153.216 0 0 81.984-41.344 71.232-104.192-10.688-62.784-89.6-94.208-72.832-137.792C610.624 100.032 615.232 91.648 615.232 91.648z M491.136 64c0 0-74.304 6.144-88.128 78.144C389.248 214.144 435.968 240.96 471.936 276.992 507.904 312.96 492.608 380.352 452.032 427.904c0 0 72.768-25.344 89.6-94.976 16.832-69.76-17.344-94.272-52.8-134.784C453.312 157.504 456.64 83.968 491.136 64z',
    fill: 'black'
})

const image = new Image({
    width: 100,
    height: 100,
    url: 'image/leafer.jpg'
})

leafer.add(group)

group.add(path)   
group.add(image)

快速设置遮罩

通过为 Group 设置 mask 元素可以快速实现遮罩效果,默认会将遮罩添加到 Group 内 最底部, 移除遮罩只需将mask设为 null 即可。

ts
import { Leafer, Group, Ellipse, Image } from 'leafer-ui'

const leafer = new Leafer({ view: window })

const group = new Group({ x: 100, y: 100 })

const image = new Image({
    width: 100,
    height: 100,
    url: 'image/leafer.jpg'
})

leafer.add(group)
group.add(image)

group.mask = new Ellipse({ 
    width: 100,
    height: 100,
    innerRadius: 0.5,
    fill: 'black'
})

Released under the MIT License.