UIModelView
继承自:
描述
UI模型视图组件。用于在UI中显示3D模型,支持相机控制、后处理效果、光照设置和环境配置等功能
属性
bool CanCameraMove |
|---|
| 是否启用视角拖拽。控制用户是否可以通过拖拽UI来旋转相机视角,围绕模型进行观察。默认值为false,不启用视角拖拽 |
int CameraDist |
|---|
| 相机距离设置。控制相机与模型原点之间的距离,数值越大相机距离模型越远,数值越小相机距离模型越近。默认值为100,相机距离原点500个单位 |
Button ResetCameraBtn |
|---|
| 相机重置按钮。仅在编译器模式下有效,点击后将相机恢复到默认状态,包括位置、角度和距离等参数。 |
Vector3 LookAtPosition |
|---|
| 相机观察目标位置。设置相机始终朝向的目标点坐标,相机将围绕此点进行旋转。默认值为(0,0,0),相机朝向世界原点 |
bool CameraLockX |
|---|
| X轴移动锁定。控制相机在拖拽时是否锁定X轴方向的移动,启用后相机只能沿Y轴旋转,无法左右移动。默认值为false,允许X轴移动 |
bool CameraLockY |
|---|
| Y轴移动锁定。控制相机在拖拽时是否锁定Y轴方向的移动,启用后相机只能沿X轴旋转,无法上下移动。默认值为false,允许Y轴移动 |
float CameraPitch |
|---|
| 相机俯仰角度。设置相机的上下倾斜角度,正值表示向上倾斜,负值表示向下倾斜,单位为度。默认值为0,相机水平朝向目标 |
float CameraYaw |
|---|
| 相机偏航角度。设置相机的左右旋转角度,正值表示向右旋转,负值表示向左旋转,单位为度。默认值为0,相机正对目标 |
bool EnablePostProcessing |
|---|
| 是否启用后处理效果。默认值为false,不启用后处理效果 |
bool EnableShadow |
|---|
| 是否启用阴影渲染。默认值为true,启用阴影渲染 |
bool BloomActive |
|---|
| 是否启用泛光效果。默认值为false,不启用泛光 |
float BloomIntensity |
|---|
| 泛光强度。控制泛光效果的强度,数值越大泛光效果越明显,数值越小泛光效果越微弱。默认值为2 |
float BloomThreshold |
|---|
| 泛光阈值设置。设置触发泛光效果的亮度阈值,只有超过此阈值的像素才会产生泛光效果。默认值为-1 |
bool DofActive |
|---|
| 是否启用景深效果。用于模拟真实相机的焦点模糊效果。默认值为false,不启用景深效果 |
float DofFocalRegion |
|---|
| 景深焦点区域。设置景深效果中完全清晰的区域深度范围,在此范围内的物体将保持清晰。默认值为0,无焦点区域 |
float DofNearTransitionRegion |
|---|
| 景深近处过渡区域。设置焦点前方模糊过渡区域的深度,控制从清晰到模糊的渐变范围。默认值为300 |
float DofFarTransitionRegion |
|---|
| 景深远处过渡区域。设置焦点后方模糊过渡区域的深度,控制从清晰到模糊的渐变范围。默认值为500 |
float DofFocalDistance |
|---|
| 景深焦点距离。设置景深效果的焦点距离,在此距离的物体将保持完全清晰。默认值为100 |
float DofScale |
|---|
| 景深缩放比例。控制景深效果的强度缩放,数值越大景深效果越明显。默认值为1 |
bool AntialiasingEnable |
|---|
| 是否启用抗锯齿。默认值为false,不启用抗锯齿 |
AntialiasingMethodDesc AntialiasingMethod |
|---|
| 抗锯齿方法选择。选择抗锯齿的实现方法,包括FXAA、TAA等不同算法。默认值为FXAA,快速近似抗锯齿 |
AntialiasingQualityDesc AntialiasingQuality |
|---|
| 抗锯齿质量等级。设置抗锯齿效果的渲染质量,质量越高效果越好但性能消耗越大。默认值为kAntialiasingQualityHigh,高质量 |
bool LUTsActive |
|---|
| 是否启用颜色查找表。控制是否启用LUTs颜色校正效果,用于调整画面的色彩、对比度和色调。默认值为false,不启用LUTs |
LUTsTemperatureType LUTsTemperatureType |
|---|
| LUTs色温类型选择。默认值为WhilteBalance,白平衡模式 |
float LUTsWhiteTemp |
|---|
| LUTs白色色温设置。调整白色的色温值,数值越高颜色越暖(偏黄),数值越低颜色越冷(偏蓝)。默认值为6450K |
float LUTsWhiteTint |
|---|
| LUTs白色色调偏移。调整白色的色调偏移,正值偏向绿色,负值偏向洋红色。默认值为0,无色调偏移 |
float LUTsColorCorrectionShadowsMax |
|---|
| LUTs阴影区域最大校正值。设置阴影区域色彩校正的最大强度,控制阴影部分的颜色调整范围。默认值为0.8 |
float LUTsColorCorrectionHighlightsMin |
|---|
| LUTs高光区域最小校正值。设置高光区域色彩校正的最小强度,控制高光部分的颜色调整范围。默认值为0.5 |
float LUTsBlueCorrection |
|---|
| LUTs蓝光校正强度。调整蓝光校正的强度,用于减少蓝光对眼睛的刺激。默认值为0.6 |
float LUTsExpandGamut |
|---|
| LUTs色域扩展强度。控制色域扩展的强度,用于增强颜色的饱和度和对比度。默认值为1 |
float LUTsToneCurveAmout |
|---|
| LUTs色调曲线强度。控制色调曲线调整的强度,用于调整画面的明暗对比和色调分布。默认值为1 |
float LUTsFilmicToneMapSlope |
|---|
| LUTs电影色调映射斜率。设置电影级色调映射的斜率参数,控制高光区域的压缩程度。默认值为0.88 |
float LUTsFilmicToneMapToe |
|---|
| LUTs电影色调映射阴影参数。设置电影级色调映射的阴影区域参数,控制阴影部分的细节保留。默认值为0.55 |
float LUTsFilmicToneMapShoulder |
|---|
| LUTs电影色调映射高光参数。设置电影级色调映射的高光区域参数,控制高光部分的细节保留。默认值为0.26 |
float LUTsFilmicToneMapBlackClip |
|---|
| LUTs电影色调映射黑色裁剪。设置电影级色调映射的黑色裁剪值,控制最暗区域的细节保留。默认值为0 |
float LUTsFilmicToneMapWhiteClip |
|---|
| LUTs电影色调映射白色裁剪。设置电影级色调映射的白色裁剪值,控制最亮区域的细节保留。默认值为0.04 |
ColorQuad LUTsBaseSaturation |
|---|
| LUTs基础饱和度调整。设置整体画面的饱和度调整参数,用于控制颜色的鲜艳程度。默认值为(255,255,255,255) |
ColorQuad LUTsBaseContrast |
|---|
| LUTs基础对比度调整。设置整体画面的对比度调整参数,用于控制明暗对比的强度。默认值为(255,255,255,255) |
ColorQuad LUTsBaseGamma |
|---|
| LUTs基础伽马值调整。设置整体画面的伽马值调整参数,用于控制中间色调的亮度分布。默认值为(255,255,255,255) |
ColorQuad LUTsBaseGain |
|---|
| LUTs基础增益调整。设置整体画面的增益调整参数,用于控制各颜色通道的亮度增益。默认值为(255,255,255,255) |
ColorQuad LUTsBaseOffset |
|---|
| 基础偏移调整。设置整体画面的偏移调整参数,用于控制各颜色通道的亮度偏移。默认值为(0,0,0,0) |
ColorQuad LUTsShadowSaturation |
|---|
| LUTs阴影区域饱和度调整。设置阴影区域的饱和度调整参数,用于控制阴影部分的颜色鲜艳程度。默认值为(255,255,255,255) |
ColorQuad LUTsShadowContrast |
|---|
| LUTs阴影区域对比度调整。设置阴影区域的对比度调整参数,用于控制阴影部分的明暗对比。默认值为(255,255,255,255) |
ColorQuad LUTsShadowGamma |
|---|
| LUTs阴影区域伽马值调整。设置阴影区域的伽马值调整参数,用于控制阴影部分的亮度分布。默认值为(255,255,255,255) |
ColorQuad LUTsShadowGain |
|---|
| LUTs阴影区域增益调整。设置阴影区域的增益调整参数,用于控制阴影部分的亮度增益。默认值为(255,255,255,255) |
ColorQuad LUTsShadowOffset |
|---|
| LUTs阴影区域偏移调整。设置阴影区域的偏移调整参数,用于控制阴影部分的亮度偏移。默认值为(0,0,0,0) |
ColorQuad LUTsMidtoneSaturation |
|---|
| LUTs中间色调饱和度调整。设置中间色调区域的饱和度调整参数,用于控制中间亮度部分的颜色鲜艳程度。默认值为(255,255,255,255) |
ColorQuad LUTsMidtoneContrast |
|---|
| LUTs中间色调对比度调整。设置中间色调区域的对比度调整参数,用于控制中间亮度部分的明暗对比。默认值为(255,255,255,255) |
ColorQuad LUTsMidtoneGamma |
|---|
| LUTs中间色调伽马值调整。设置中间色调区域的伽马值调整参数,用于控制中间亮度部分的亮度分布。默认值为(255,255,255,255) |
ColorQuad LUTsMidtoneGain |
|---|
| LUTs中间色调增益调整。设置中间色调区域的增益调整参数,用于控制中间亮度部分的亮度增益。默认值为(255,255,255,255) |
ColorQuad LUTsMidtoneOffset |
|---|
| LUTs中间色调偏移调整。设置中间色调区域的偏移调整参数,用于控制中间亮度部分的亮度偏移。默认值为(0,0,0,0) |
ColorQuad LUTsHighlightSaturation |
|---|
| LUTs高光区域饱和度调整。设置高光区域的饱和度调整参数,用于控制高光部分的颜色鲜艳程度。默认值为(255,255,255,255) |
ColorQuad LUTsHighlightContrast |
|---|
| LUTs高光区域对比度调整。设置高光区域的对比度调整参数,用于控制高光部分的明暗对比。默认值为(255,255,255,255) |
ColorQuad LUTsHighlightGamma |
|---|
| LUTs高光区域伽马值调整。设置高光区域的伽马值调整参数,用于控制高光部分的亮度分布。默认值为(255,255,255,255) |
ColorQuad LUTsHighlightGain |
|---|
| LUTs高光区域增益调整。设置高光区域的增益调整参数,用于控制高光部分的亮度增益。默认值为(255,255,255,255) |
ColorQuad LUTsHighlightOffset |
|---|
| LUTs高光区域偏移调整。设置高光区域的偏移调整参数,用于控制高光部分的亮度偏移。默认值为(0,0,0,0) |
ModelAssetType LUTsColorGradingLUTPath |
|---|
| LUTs颜色分级查找表路径。指定用于颜色分级的LUT纹理文件路径,用于应用特定的颜色校正效果。默认值为空 |
bool GTAOActive |
|---|
| 是否启用GTAO(地面真实环境光遮蔽)。默认值为false,不启用GTAO |
float GTAOThicknessblend |
|---|
| GTAO厚度混合参数。控制GTAO效果的厚度混合程度,数值越大厚度效果越明显。取值范围0-1,默认值为0.75 |
float GTAOFalloffStartRatio |
|---|
| GTAO衰减起始比例。设置GTAO效果开始衰减的距离比例,控制衰减效果的起始位置。取值范围0-1,默认值为0.5 |
float GTAOFalloffEnd |
|---|
| GTAO衰减结束距离。设置GTAO效果衰减结束的最大距离,控制衰减效果的结束位置。取值范围0-300,默认值为70 |
float GTAOFadeoutDistance |
|---|
| GTAO渐隐距离。设置GTAO效果开始渐隐的距离,用于优化远距离的渲染性能。取值范围0-20000,默认值为7000 |
float GTAOFadeoutRadius |
|---|
| GTAO渐隐半径。设置GTAO效果渐隐的半径范围,控制渐隐效果的覆盖范围。取值范围0-10000,默认值为3000 |
float GTAOIntensity |
|---|
| GTAO强度指数。控制GTAO效果的强度,数值越大环境光遮蔽效果越明显。取值范围0-1,默认值为0.5 |
float GTAOPower |
|---|
| GTAO强度倍率。控制GTAO效果的强度倍率,用于进一步调整环境光遮蔽的强度。取值范围0-10,默认值为3.5 |
bool ChromaticAberrationActive |
|---|
| 是否启用色差效果。控制是否启用色差效果,模拟真实相机镜头产生的色散现象。默认值为false,不启用色差效果 |
float ChromaticAberrationIntensity |
|---|
| 色差强度设置。控制色差效果的强度,数值越大色散现象越明显。取值范围0-8,默认值为1 |
float ChromaticAberrationStartOffset |
|---|
| 色差起始偏移。设置色差效果开始应用的偏移量,控制色散效果的起始位置。取值范围0-1,默认值为0 |
float ChromaticAberrationIterationStep |
|---|
| 色差迭代步长。设置色差效果计算的迭代步长,控制色散效果的精度和性能。取值范围0.01-10,默认值为0.01 |
float ChromaticAberrationIterationSamples |
|---|
| 色差迭代次数。设置色差效果计算的迭代次数,影响色散效果的质量和性能。取值范围1-8,默认值为1 |
bool DisEnableDefaultLight |
|---|
| 是否启用默认光照。控制是否禁用默认的环境光照,启用后需要手动设置光照来照亮场景。默认值为false,启用默认光照 |
bool PlanarReflectionActive |
|---|
| 是否启用平面反射。控制是否启用平面反射效果,在指定高度的平面上产生反射效果。默认值为false,不启用平面反射 |
float PlanarReflectionPlaneHeight |
|---|
| 平面反射高度。设置平面反射效果的反射平面高度,在此高度的平面上将产生反射效果。默认值为0 |
uint32_t PlanarReflectionMask |
|---|
| 平面反射渲染遮罩。设置哪些对象可以被平面反射渲染,通过位掩码控制反射对象的类型。默认值为3 |
PlanarReflectionTextureSize PlanarReflectionTextureSize |
|---|
| 平面反射纹理尺寸。设置平面反射效果的渲染纹理大小,影响反射质量和性能。默认值为e512 |
string SkyLightCubeAssetID |
|---|
| 天空光立方体贴图资源ID。指定用于天空光照的立方体贴图资源ID,用于提供环境光照和反射。默认值为空字符串 |
float SkyLightIntensity |
|---|
| 天空光强度。设置天空光照的强度,数值越大天空光越亮。默认值为1 |
ColorQuad SkyLightColor |
|---|
| 天空光颜色。设置天空光照的颜色,影响环境光的色调。默认值为(255,255,255,255) |
float SkyLightBlendAmount |
|---|
| 天空光混合强度。设置天空光与场景光照的混合强度,控制天空光对场景的影响程度。默认值为1 |
ColorQuad SkyLightAmbientSkyColor |
|---|
| 天空环境光颜色。设置来自天空方向的环境光颜色,影响场景上方的环境光照。默认值为(57,57,66,255) |
ColorQuad SkyLightAmbientEquatorColor |
|---|
| 赤道环境光颜色。设置来自水平方向的环境光颜色,影响场景中部的环境光照。默认值为(110,119,130,255) |
ColorQuad SkyLightAmbientGroundColor |
|---|
| 地面环境光颜色。设置来自地面方向的环境光颜色,影响场景下方的环境光照。默认值为(30,30,39,255) |
float BuiltinDirectionalLightIntensity |
|---|
| 内置方向光强度。设置内置方向光的强度,数值越大光照越亮。默认值为1 |
ColorQuad BuiltinDirectionalLightColor |
|---|
| 内置方向光颜色。设置内置方向光的颜色,影响光照的色调。默认值为(255,255,255,255) |
bool BuiltinDirectionalLightActive |
|---|
| 是否启用内置方向光。控制是否启用内置方向光,提供场景的基础光照。默认值为true,启用内置方向光 |
Vector3 BuiltinDirectionalLightRotation |
|---|
| 内置方向光旋转角度。设置内置方向光的旋转角度,控制光照方向。默认值为(45,30,0) |
float BuiltinSkyLightIntensity |
|---|
| 内置天空光强度。设置内置天空光的强度,数值越大天空光越亮。默认值为1 |
ColorQuad BuiltinSkyLightColor |
|---|
| 内置天空光颜色。设置内置天空光的颜色,影响环境光的色调。默认值为(255,255,255,255) |
float BuiltinSkyLightBlendAmount |
|---|
| 内置天空光混合强度。设置内置天空光与场景光照的混合强度,控制天空光对场景的影响程度。默认值为1 |
ColorQuad BuiltinSkyLightAmbientSkyColor |
|---|
| 内置天空光环境天空颜色。设置内置天空光来自天空方向的环境光颜色,影响场景上方的环境光照。默认值为(57,57,66,255) |
ColorQuad BuiltinSkyLightAmbientEquatorColor |
|---|
| 内置天空光环境赤道颜色。设置内置天空光来自水平方向的环境光颜色,影响场景中部的环境光照。默认值为(110,119,130,255) |
ColorQuad BuiltinSkyLightAmbientGroundColor |
|---|
| 内置天空光环境地面颜色。设置内置天空光来自地面方向的环境光颜色,影响场景下方的环境光照。默认值为(30,30,39,255) |
UIMODLEVIEW_SkyLightType BuiltinSkyLightType |
|---|
| 内置天空光类型。选择内置天空光的类型,包括天空盒模式和渐变模式。默认值为Gradient |
string BuiltinSkyLightCubeAssetID |
|---|
| 内置天空光立方体贴图资源ID。指定用于内置天空光照的立方体贴图资源ID,用于提供环境光照和反射。默认值为空字符串 |
MODELVIEW_FogType BuiltinFogType |
|---|
| 内置雾效类型。选择内置雾效的类型,包括禁用和线性雾效。默认值为DISABLE,禁用雾效 |
ColorQuad BuiltinFogColor |
|---|
| 内置雾效颜色。设置内置雾效的颜色,影响雾的色调。默认值为(114,163,255,255) |
float BuiltinFogStart |
|---|
| 内置雾效起始距离。设置内置雾效开始的距离,在此距离之前无雾效。默认值为500 |
float BuiltinFogEnd |
|---|
| 内置雾效结束距离。设置内置雾效结束的距离,在此距离之后完全被雾遮挡。默认值为2000 |
float BuiltinFogOffset |
|---|
| 内置雾效偏移。设置内置雾效的偏移量,用于调整雾效的位置。默认值为1 |
float NearClip |
|---|
| 相机近裁剪面距离 |
float FarClip |
|---|
| 相机远裁剪面距离 |
float Fov |
|---|
| 相机视野角度 |
代码示例
lua
-- 创建UI根节点
local root = SandboxNode.new('UIRoot', game.WorkSpace)
root.Name = 'uiroot'
-- 创建UI模型视图组件
local ModelView = SandboxNode.new('UIModelView', root)
ModelView.Size = Vector2.new(500, 500)
ModelView.Pivot = Vector2.new(0, 0)
ModelView.Position = Vector2.new(0, 0)
-- 相机控制设置
ModelView.CanCameraMove = true -- 启用相机拖拽控制
ModelView.CameraDist = 700 -- 设置相机距离
ModelView.CameraPitch = 15 -- 设置相机俯仰角
ModelView.CameraYaw = 0 -- 设置相机偏航角
-- 创建并添加模型
local newModel = SandboxNode.new('Model')
newModel.Name = "my_model"
newModel.ModelId = "sandboxSysId://entity/100011/body.omod"
newModel.Position = Vector3.new(0, -80, 0)
newModel.Parent = ModelView