Visindigo::Widgets::LiquidGlassEffect Class

成员函数文档

[explicit, since Visindigo 0.13.0] LiquidGlassEffect::LiquidGlassEffect(QWidget *parent = nullptr)

parent 父窗口，且必须为将被应用效果的QWidget，否则效果可能无法正确显示。 构造函数。

这个function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] LiquidGlassEffect::~LiquidGlassEffect()

析构函数。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] QImage LiquidGlassEffect::blurImage(const QImage &image, int radius)

对图像进行高斯模糊处理。 image 要模糊的图像。 radius 模糊效果的半径，值越大模糊效果越明显。

此函数不提供sigma的手动设置，其sigma采用

sigma = 0.3 * ((radius - 1) * 0.5 - 1) + 0.8

来计算，这个公式是OpenCV使用的经验公式，可以在不同半径下得到比较自然的模糊效果。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.15.0] QImage LiquidGlassEffect::colorMaskImage(const QImage &image, const QColor &color, qreal percent)

对图像进行颜色遮罩处理。 image 要处理的图像。color 遮罩的颜色，决定了模糊效果的色调。percent 遮罩的透明度，值越大遮罩越透明，默认1。

这个function 从 Visindigo 0.15.0 开始支持。

[static, since Visindigo 0.13.0] QImage LiquidGlassEffect::distortImage(const QImage &coverdArea, int liquidDistortRadius, qreal dispersion = 0.0)

对图像进行液体扭曲处理。 coverdArea 要扭曲的图像。 liquidDistortRadius 扭曲效果的半径，值越大扭曲效果越明显。 此函数通过对图像的边缘区域进行基于正弦函数的坐标偏移来实现液体流动的效果。 扭曲半径决定了边缘区域的宽度，半径越大，扭曲效果越明显。

为了保持性能，扭曲效果仅应用于图像的边缘区域，而图像的中心部分保持不变。 这种方法可以在不显著增加计算量的情况下提供明显的液体流动效果。

当扭曲半径超过图像最短边的一半时，内部会自动按最短边的一半进行扭曲，且不改变用户设置值。

dispersion 色散强度，取值 0 到 0.5，默认0（不做色散）。 色散通过给红绿蓝三个通道不同的映射距离实现：绿光不动，红光偏折得少一点、蓝光多一点，于是边缘会出现彩色镶边。 它需要为每个像素多采样两个通道，因此会让扭曲的开销明显上升（仍然远低于模糊）；为0时三通道共用同一套映射，开销与普通扭曲一致。

由于液态玻璃通常需要模糊效果，本质上算是一种平滑处理，因此考虑到综合性能， 这个扭曲实现在采样的时候没有单独进行插值计算，因此单独使用时可能会出现锯齿状的边缘。

这个function 从 Visindigo 0.13.0 开始支持。

[override virtual, since Visindigo 0.13.0] void LiquidGlassEffect::draw(QPainter *painter)

重写了QGraphicsEffect的draw()方法，在其中实现了液态玻璃效果的绘制逻辑。 painter 用于绘制效果的QPainter对象。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.17.0] QImage LiquidGlassEffect::drawDebugBackground(qint32 width, qint32 height)

生成一张用于调试和演示液态玻璃效果的背景图。 width 图像的宽度，单位为像素。 height 图像的高度，单位为像素。

这个function 从 Visindigo 0.17.0 开始支持。

[override virtual, since Visindigo 0.17.0] bool LiquidGlassEffect::eventFilter(QObject *watched, QEvent *event)

watched 事件的目标对象。event 待处理的事件。

重写了QObject的eventFilter()方法，用于在启用边缘光时跟踪鼠标位置。

这个function 从 Visindigo 0.17.0 开始支持。

[static, since Visindigo 0.17.0] QImage LiquidGlassEffect::globalRimImage(const QImage &image, int borderRadius, const QPointF &lightDirection, int lightThickness, const QColor &lightColor, int shadowThickness, const QColor &shadowColor)

在图像上绘制全局打光，返回绘制后的图像。 image 要绘制的图像，尺寸应当与要打光的控件尺寸一致。 borderRadius 控件的圆角半径，光效沿着这个圆角矩形的边界生成。 lightDirection 从控件指向光源的方向向量，不需要是单位向量。 lightThickness 亮面从边界向内扩散的范围，单位为像素。 lightColor 亮面的颜色，其alpha值决定了亮面的最大强度。 shadowThickness 阴影从边界向内扩散的范围，单位为像素。 shadowColor 阴影的颜色，其alpha值决定了阴影的强度。

这个function 从 Visindigo 0.17.0 开始支持。

[static, since Visindigo 0.17.0] QImage LiquidGlassEffect::rimLightImage(const QImage &image, int borderRadius, const QPoint &mousePosition, int thickness, int range, const QColor &color, qreal intensity = 1.0, QRect *changedRect = nullptr)

在图像上绘制边缘光，返回绘制后的图像。 image 要绘制的图像，尺寸应当与要绘制边缘光的控件尺寸一致。 borderRadius 控件的圆角半径，边缘光贴着这个圆角矩形的边界生成。 mousePosition 鼠标位置，坐标系与 image 相同，允许取值在控件之外。 thickness 边缘光的厚度，即从边界向内扩散的范围，单位为像素。 range 边缘光沿边界延伸的距离，单位为像素。 color 边缘光的颜色，其alpha值决定了边缘光的最大强度。 intensity 整体强度，取值 0 到 1，默认1。鼠标靠近时的淡入、离开时的淡出就靠它。 changedRect 可选输出，返回本次实际改动的区域；不需要就传nullptr。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setBackgroundImage(const QImage &image)

设置被模糊源的图像，仅在BackgroundPolicy为CustomImage时有效。 image 用于模糊的图像。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setBackgroundPolicy(Visindigo::Widgets::LiquidGlassEffect::BackgroundPolicy policy)

设置获取被模糊源的方法。 policy 获取被模糊源的方法，决定了模糊效果的来源。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setBlurRadius(int radius)

设置模糊效果的半径，单位为像素。 radius 模糊效果的半径，值越大模糊效果越明显。 出于性能考虑，建议不要设置过大的模糊半径，尤其是在较大的控件上。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setBorderRadius(int radius)

设置边框半径，单位为像素。 radius 边框的半径，值越大边框越圆润。 如果被应用效果的控件具有圆角，那么就应该同步设置此值以避免输出时溢出应有的视觉边界。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.15.0] void LiquidGlassEffect::setColorMask(const QColor &color, qreal percent)

设置颜色遮罩。 color 遮罩的颜色，决定了模糊效果的色调。 percent 遮罩的透明度，值越大遮罩越透明，默认1。 颜色遮罩会在模糊效果之后应用，可以用来调整模糊效果的整体色调和透明度，从而更好地模仿液态玻璃的外观。

这个function 从 Visindigo 0.15.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setCustomGeometry(const QRect &geometry)

设置自定义几何形状，仅在PositionPolicy为CustomGeometry时有效。 geometry 自定义的几何形状，决定了模糊效果在CustomImage上的位置和大小。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setEffectTypes(Visindigo::Widgets::LiquidGlassEffect::EffectTypes effects)

设置效果类型 effects 要应用的效果类型，可以是EffectType的任意组合。 默认是EffectType::All，即普通扭曲、色散扭曲、模糊、边缘光和全局打光全开； 只想用其中几种时，用|把需要的EffectType拼起来传给这个函数即可。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setGlobalRimLightColor(const QColor &color)

设置全局打光亮面的颜色，仅在EffectType中包含GlobalRim时有效。 color 迎光面的颜色，其alpha值决定了亮面的最大强度，默认白色、alpha值90（刻意做得比较淡）。 全局光只是一个效果元素，默认不应该盖过玻璃本身的颜色，需要更强的光时把alpha值调大即可。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setGlobalRimLightDirection(const QPointF &direction)

设置全局打光的光源方向，仅在EffectType中包含GlobalRim时有效。 direction 从控件指向光源的方向向量，不需要是单位向量，默认QPointF(-0.5, -0.866)，即光从左上角来、与竖直方向成30度。 以屏幕坐标为准（y轴向下），因此(-0.5, -0.866)表示光从左上角来（偏上），(0, -1)表示光从正上方来，(-1, 0)表示光从左侧来，(1, 1)表示光从右下角来。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setGlobalRimLightThickness(int thickness)

设置全局打光亮面的厚度，仅在EffectType中包含GlobalRim时有效。 thickness 亮面从控件边界向内扩散的范围，单位为像素，默认1。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setGlobalRimShadowColor(const QColor &color)

设置全局打光的阴影颜色，仅在EffectType中包含GlobalRim时有效。 color 背光面阴影的颜色，其alpha值决定了阴影的强度，默认半透明黑色（alpha值60）。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setGlobalRimShadowThickness(int thickness)

设置全局打光的阴影厚度，仅在EffectType中包含GlobalRim时有效。 thickness 阴影从控件边界向内扩散的范围，单位为像素，默认2。 阴影一般比亮面厚一些，这样控件看上去才像是一块有厚度的玻璃。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setLiquidDistortDispersion(qreal dispersion)

设置扭曲的色散强度，仅在EffectType中包含DispersionDistort时有效。 dispersion 色散强度，取值会被夹到 0 到 0.5 之间，默认0.2。 色散就是让红绿蓝三个通道的映射距离略有不同（绿光不动，红光偏折得少一点、蓝光多一点）， 于是边缘会出现彩色镶边，看起来就像真实玻璃把光拆开了；0表示三个通道完全一致（等同于NormalDistort），越大彩色镶边越明显。 色散需要为每个像素多采样两个通道，因此会略微增加扭曲的开销。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setLiquidDistortRadius(int radius)

设置液体扭曲效果的半径，单位为像素。 radius 扭曲效果的半径，值越大扭曲效果越明显。 当扭曲半径超过控件最短边的一半时，内部会自动按最短边的一半进行扭曲，且不改变用户设置值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void LiquidGlassEffect::setPositionPolicy(Visindigo::Widgets::LiquidGlassEffect::PositionPolicy policy)

设置模糊效果的位置策略，仅在BackgroundPolicy为CustomImage时有效。 policy 模糊效果的位置策略，决定了模糊效果在CustomImage上的定位和裁剪方式。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setRimLightActivationDistance(int distance)

设置边缘光的激活距离，仅在EffectType中包含RimLight时有效。 distance 鼠标离控件边界多远之内才会出现边缘光，单位为像素，默认40。 设置为0表示只在鼠标位于控件内部时才出现边缘光。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setRimLightColor(const QColor &color)

设置边缘光的颜色，仅在EffectType中包含RimLight时有效。 color 边缘光的颜色，其alpha值决定了边缘光的最大强度，默认半透明白色（alpha值130）。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setRimLightRange(int range)

设置边缘光沿控件边界延伸的距离，仅在EffectType中包含RimLight时有效。 range 边缘光在边界上能够延伸的距离，单位为像素，默认80。 边缘光总是出现在离鼠标最近的那一段边界上，并沿着边界向两侧衰减，这个值决定了它能够延伸多远。

这个function 从 Visindigo 0.17.0 开始支持。

[since Visindigo 0.17.0] void LiquidGlassEffect::setRimLightThickness(int thickness)

设置边缘光的厚度，仅在EffectType中包含RimLight时有效。 thickness 边缘光从控件边界向内扩散的范围，单位为像素，默认1。

这个function 从 Visindigo 0.17.0 开始支持。