DreamGUI
插件参考Guides

属性的 meta 标签

决定属性在 DreamGUI 细节面板里放在哪、是否隐藏、用什么控件、是否作为效果开关的 DreamGUI_ meta 标签——没写标签的属性永远不会被丢掉——以及扩展的类和定制怎么用它们。

DreamGUI 的细节面板按所显示属性上的 meta 标签来排版。标签都以 DreamGUI_ 开头,而且一个都不是必需的:没写标签的属性,照引擎的做法显示在它自己的 Category 下。 只有标了 DreamGUI_Hidden 的属性不显示。 DreamGUI 的面板不会整类隐藏分类,所以给类新加的属性,不会因为分类起错了就在编辑器里消失。

扩展作者自己的类也能用:一个类有标签、却没有细节定制,就会自动得到一个按标签摆放的定制;自己写的定制只要调用 FDreamDetailsLayout::PlaceTagged 就会摆放它们(见下文)。

标签

标签取值作用
DreamGUI_SectionLayer、Layout、Visual、Appearance、Effect、Behavior、Advanced放进面板的这个顶层区。
DreamGUI_Group路径,如 Glass/Refraction放进所在区的这个组;没写区时放进它自己分类的组。每个 / 嵌套一层。
DreamGUI_Order数字在区或组里的位置,小的在前。没写的算 0,保持声明顺序。
DreamGUI_Advanced--放在所在位置的「高级」展开项下。
DreamGUI_Hidden--不显示:内部状态,或者由面板里另一行编辑的值(在注释里写明是哪一行)。
DreamGUI_EditorAngleWheel、Curve、Gradient、BlendMode、Color、Slider用 DreamGUI 的哪种控件编辑,类型本身说明不了时用。选项写在冒号后:AngleWheel:TopCW。
DreamGUI_Handle手柄种类,如 Gradient;参数写在冒号后(Kind:Args)选中控件时设计器视口为它显示哪种手柄。种类由视口手柄框架注册(FDreamDesignerHandles::RegisterKind)。
DreamGUI_LayerToggle--整个效果的开关:层级里和图层区里的那只眼睛。结构体成员里的开关也算(Style.bEnabled)。

「只有另一个属性取某个值时才显示」继续用引擎的 EditCondition 和 EditConditionHides:行始终在,条件一满足就出现。

子分类(Category = "DreamGUI|Pointer Light")里的属性标了 AdvancedDisplay,在 DreamGUI 的面板里不会收进「高级」展开项:引擎画子分类时根本不画它的高级行,开不开「显示全部高级项」都一样。所以 DreamGUI 把这类属性作为子分类里的普通行,排在其它行后面。想把属性收起来,用 DreamGUI_Advanced,或者放进没有子分类的分类。

// Shown with the widget's opacity and mask in the Layer section, second.
UPROPERTY(EditAnywhere, Category = DreamGUI, meta = (DreamGUI_Section = "Layer", DreamGUI_Order = 20))
EDreamUIBlendMode BlendMode = EDreamUIBlendMode::Alpha;

// The eye on this effect in the hierarchy turns this off and on.
UPROPERTY(EditAnywhere, Category = "DreamGUI|Holo Foil", meta = (DreamGUI_LayerToggle))
bool bEnabled = true;

// Only for a filled image, and only then shown.
UPROPERTY(EditAnywhere, Category = "DreamGUI", meta = (EditCondition = "DrawType == EDreamUISpriteDrawType::Filled", EditConditionHides))
float FillAmount = 1;

区

区是面板里名字、标题、位置都固定的分类,也就是控件细节面板从上到下的那几块:

区分类顺序
LayerDreamLayer-110
LayoutDreamLayout-90
VisualVisual-80
AppearanceDreamAppearance-60
EffectDreamEffect-55
BehaviorDreamBehavior-50
AdvancedDreamAdvanced100,默认折叠

视觉显示在所属控件的细节面板里,所以视觉的 Layer 属性由控件的图层区来画,不再出现在视觉自己的行里——视觉的混合模式就是这样和控件的不透明度排在一起的。

视口手柄

DreamGUI_Handle 命名了一种手柄,设计器视口会针对该属性在所选控件上绘制这种手柄:包括控件自身的属性、其视觉对象和行为的属性,以及普通结构体属性向下一层的成员。每个打了标签的属性都有自己的提供者,名为 Kind.Property(“Gradient.BodyGradient”);冒号后的内容会原样交给该种类。

种类标在哪儿手柄
GradientRectBlock 的 BodyGradient、BorderGradient渐变的端点、中心和色标(见渐变)
MaskShape控件的 ClipMask裁剪矩形的四条边、矩形遮罩的圆角、多边形的圆角、星形或圆环的内径、羽化
GlassShape玻璃的 CornerRadius圆角、边缘宽度、光从哪边来
Shadow图层样式的 Style;RectBlock 的 OuterShadowAngle样式的阴影;RectBlock 自带的两个阴影——都画在落下的位置
Light指针光的 LightPosition;图层样式的 Style.GlobalLightAngle光站的位置和照到多远;画成圆盘的全局光

种类由画它的模块注册,给一个为单个标签属性造提供者的工厂:

FDreamDesignerHandles::RegisterKind(TEXT("MyKind"), [](const FDreamDesignerHandleBinding& InBinding) -> TSharedPtr<IDreamDesignerHandleProvider>
{
	// InBinding.Owner is the object, InBinding.Property the tagged property, InBinding.Args what follows the colon.
	return Cast<UMyVisual>(InBinding.Owner.Get()) ? MakeShared<FMyHandles>(InBinding.Property) : nullptr;
});

在自己的定制里

void FMyCustomization::CustomizeDetails(IDetailLayoutBuilder& DetailBuilder)
{
	FDreamDetailsLayout Layout(DetailBuilder);
	Layout.Section(DreamPropertyMeta::ESection::Behavior).AddCustomRow(...);   // rows of its own
	// What applies only in some state of the object that no property says -- whether a canvas is a root -- keeps its row,
	// shown while it applies:
	Layout.ShowWhen(TEXT("ReferenceResolution"), TAttribute<bool>::CreateLambda([...] { return IsRoot(); }));
	Layout.PlaceTagged();   // last: every tagged property not placed yet, placed
}

一个属性要么靠标签摆放,要么由定制自己的行摆放,不要两者都用:定制已经加过或藏过的属性,标签不会再挪它。定制为某个属性自己画的行(比如旁边带单位按钮的数值)要用 HideProperty 藏掉该属性的默认行,在这一行上顺带编辑的属性(单位)标 DreamGUI_Hidden。

读标签用 DreamPropertyMeta(DetailCustomization/DreamPropertyMeta.h),摆放用 FDreamDetailsLayout (DetailCustomization/DreamDetailsLayout.h)。

守住它的测试

DreamGUI.Editor.Details.EveryEditablePropertyHasARowUnlessTaggedHidden 按编辑器的方式显示插件各模块的每个类——控件在自己的细节面板里,它的视觉、布局和导航在控件面板里,组件在自己的面板里,面板插槽放在每种面板下,其余按类默认值——以及每个结构体本身;任何可编辑属性没有行又没标 DreamGUI_Hidden,或者同一属性出现两行,测试就失败。

本页目录