Annotations注释

注释

CityEngine 2018.1
|

概要

注释用于向规则或属性添加其他信息。注释是可选的,不会影响规则的语义,因此不会影响模型生成。注释主要用于为用户界面元素(例如Inspector)提供有关如何呈现属性或规则的其他提示。

注释

Annotations

例子

@角度

在Inspector中添加°(度)单位,默认情况下使用滑块添加[0; 360]范围。

@Angle
attr angle = 180

@颜色

将属性标记为颜色属性,该属性将在检查器中显示颜色选择器。

@Color
attr userColor = "#000000"

@description( “描述”)

向属性或规则添加描述,该属性或规则将在检查器中显示为工具提示,或者作为启动规则选择器或样式管理器中的描述。使用\ n表示换行符。

@Description("The building width")
attr width = 40

@目录

将属性标记为目录名称。检查员将显示目录选择器。

@Directory
attr assets = "/assets/lod" + lod

@距离

在Inspector中添加一英尺的单位(取决于场景使用的坐标系)。

@Distance
attr distance = 1852

@Enum(value_1,value_2,…,restricted = true)

设置具有特定值的枚举。值可以是数字或字符串。参数restricted是可选的(默认为true)。如果为true,则无法在检查器中输入其他值或通过句柄设置其他值。

@Enum("low", "mid", "high")
attr lod = "low"
@Enum(10, 20, 30, restricted = false)
attr height = 20

@文件

将属性标记为文件名。检查员将提供文件选择器。

@File
attr asset = "myfile.obj"

@File(“ext_1”,…,“ext_n”)

将属性标记为文件名。检查员将为给定的文件扩展名(“ ext_1”,…,“ext_n ”)提供文件选择器

@File("tif", "tiff")
attr texture = "tex0.tiff"

@Group(“level_1-group”,…,“level_n-group”)

设置以下属性的组(检查器将相应地对属性进行分组)。当前组在进口中保持不变。要离开当前组,请使用@Group。

@Group("First", "Second", "Third")
attr grouped = 0

@Group(“level_1-group”,…,“level_n-group”,订单)

在检查器中设置组和子组的组和排序顺序(类似于@Order属性)。其中order是数值。

@Group("First", "Second", "Third", 1)
attr grouped = 0

@Handle(handle_params)

为以下属性添加交互式句柄

@Handle(shape=Solid, align=right)
attr dimension = 40

@隐

将属性或规则标记为隐藏。隐藏属性不会出现在CityEngine检查器或启动规则选择器中,但它们将自动连接到匹配的对象属性。@Hidden还可用于在import语句之前隐藏一组属性(如带有属性名称列表的第二种形式)。如果没有显式命名属性,在导入语句之前@Hidden将隐藏检查器中的所有导入属性; 隐藏的注释将以递归方式传播到隐藏导入的导入。

@Hidden
attr hide_me = 0

@In {网|多边形|边缘|点|点云

这些注释可用于传达起始形状的预期几何类型。虽然这些注释目前在CityEngine中没有任何效果,但ArcGIS Pro期望每个启动规则(见上文)都使用预期的输入类型进行注释(从ArcGIS Pro 1.1开始,仅支持InPolygon和InMesh)。如果没有,则默认为@InPolygon。因此,如果在ArcGIS Pro中导出要与不同几何类型一起使用的rpk,请确保添加其中一个注释。

@Order(顺序)

在检查器中设置属性的排序顺序。其中order是数值。

@Order(1)
attr i_m_1st = 0
@Order(2)
attr i_m_2nd = 0
@Order(3)
attr i_m_3rd = 0

@out(粒度= separatedShapes | combinedShape)

此注释可用于传达输出几何的建议粒度。默认值为combinedShape。虽然此注释目前在CityEngine中没有任何效果,但在ArcGIS Pro中触发叶子形状生成至关重要。在这种情况下,将其添加到开始规则。

@百分

在Inspector中添加%单位和[0; 100]范围。在CGA文件中,必须将值初始化为实际值(例如,0.1为10%)。检查员将以百分比(例如10%)显示该值。用户必须在检查器中输入百分比值。

@Percent
attr inflation = 0.012

@Range(min = value1,max = value2,stepsize = 0,restricted = true)

通过参数min和max(包括)设置属性的数值范围。参数stepsize是可选的(默认为0)。如果设置为> 0,则可从从最小值开始的相应步骤中设置可能的值。检查器和手柄中的两个滑块都遵循步长。参数restricted是可选的(默认为true)。如果设置为true,则任何数字输入值都将设置为检查器中最接近的可能值。

@Range(min=5, max=50)
attr height = 20
@Range(min=0, max=45, stepsize=15, restricted=false)
attr angle = 30

@StartRule

将规则标记为开始规则选择器的开始规则

@StartRule
Start-->NIL

Was this article helpful?

Leave A Comment?

You must be logged in to post a comment.