文本注释可以用于为规则或属性添加说明信息。这些文本是可选择性的,在规则中对模型的生成没有任何影响。文本注释通常用于为用户接口的元素提供更多的提示,比如在属性检查器中提示用户某些值的范围。
- @StartRule: 给规则做标记,向开始规则选择器提示这个规则是开始规则。
- @Hidden: 表示属性或者规则为隐藏状态,即在属性检查器或者开始规则选择器中不显示。
- @Group("level_1-group", ..., "level_n-group"): 将规则分组进行组织,属性检查器将按照这个分组来显示。
- @Range(min, max): 设置一个属性的数值范围(最小值,最大值)。
- @Range(item_1 = value, ..., item_n = value):设置属性的一系列枚举值,这些值可以是数值或者字符串。
- @Color: 标记该属性为color属性,该属性将以颜色选择器显示在属性查看器中。
- @File:表示该属性为文件名称。在属性检查器中将提示用户选择文件。
- @File("ext_1", ... , "ext_n"): 标记属性为文件名称。在属性选择器中提示用户选择括号中列出的扩展名结尾的文件("ext_1", ... , "ext_n")
- @Directory:将属性设置为文件目录。在属性检查器中将显示让用户选择文件目录
- @Location(x, y): 设置在CGA可视化编辑器中属性或者规则的2D位置
- @Order(order):设置属性检查器中属性的排列顺序
- @Description("description"): 给属性或者规则添加描述信息,从而在属性检查器中以工具提示来显示,或者作为开始规则选择器或样式管理器的描述。
示例:
@StartRule
Start-->NIL
@Hidden
attr hide_me = 0
@Group("First", "Second")
attr grouped = 0
@Range(5, 50)
attr height = 20
@Range(Low=0, Mid=1, High=2)
attr lod = 0
@Range(Red="#ff0000", Green="#00ff00", Blue="#0000ff")
attr color = "#000000"
@Color
attr userColor = "#000000"
@File
attr asset = "myfile.obj"
@File("tif", "tiff")
attr texture = "tex0.tiff"
@Directory
attr assets = "/assets/lod" + lod
@Location(0, 0)
Init-->NIL
@Order(1)
attr i_m_1st = 0
@Order(2)
attr i_m_2nd = 0
@Order(3)
attr i_m_3rd = 0
@Description("The building width")
attr width = 40
对应在属性检查器中的呈现如下图: