Skip to content

HighlightConfigFormat.md

Latest commit

 

History

History
140 lines (113 loc) · 4.58 KB

HighlightConfigFormat.md

File metadata and controls

140 lines (113 loc) · 4.58 KB

highlightConfig 配置格式说明

highlightConfig 用于配置需要高亮显示的胞/面。它是一个 object 类型，格式如下：

胞高亮配置参数

参数名 类型 说明 约束条件
键 number 高亮的颜色 满足正则 ^[0-9a-fA-F]{8}$，即 16 进制 RGBA 色码
值 object 胞选择器配置 见 胞选择器配置格式

胞选择器配置格式

特殊情况

可以直接为字符串 "all"，表示高亮所有胞。

包含配置

参数名 类型 说明 约束条件
indices number[] 直接指定要选择的胞索引数组 数组元素必须为非负整数
ranges [number, number][] 指定要选择的胞范围数组，每个范围是 [start, end) 的左闭右开区间 start 和 end 必须为非负整数且 start ≤ end
nHedra (number | object)[] 根据面数选择胞，可以是数字或对象 数字必须为正整数；对象必须符合 [nHedra 对象配置](#nHedra 对象配置)

nHedra 对象配置

参数名 类型 说明 约束条件
nFaces number 胞的面数 必须为正整数
ranges [number, number][] 要选择的胞范围数组 必须符合 ranges 约束条件

排除配置 (exclude)

与 包含配置 相同，只是会排除已选中的胞。

胞选择器配置示例

示例1：基本选择

indices: [0, 2, 4]
ranges: [[10, 15]]
  • 选择索引为 0、2、4 的胞
  • 选择索引 [10, 15) 的胞（共 5 个）

示例2：按面数选择

nHedra:
  - 4
  - nFaces: 6
    ranges: [[0, 3]]
  • 选择所有四面体胞
  • 选择前 3 个六面体胞（索引 [0, 2)）

示例3：组合选择并排除

indices: [0, 5, 10]
ranges: [[20, 30]]
nHedra: [4, 6]
exclude:
  indices: [5, 25]
  ranges: [[22, 25]]
  • 选择索引 0、5、10 的胞
  • 选择索引 [20, 30) 的胞
  • 选择所有四面体和六面体胞
  • 排除索引 5 和 25 的胞
  • 排除索引 [22, 25) 的胞

示例4：复杂nHedra配置

nHedra:
  - nFaces: 4
    ranges:
      - [0, 5]
      - [10, 15]
  - nFaces: 6
    ranges: [[3, 6]]
exclude:
  nHedra: [4]
  • 选择第 [0, 5) 和第 [10, 15) 个四面体胞
  • 选择第 [3, 6) 个六面体胞
  • 排除所有四面体胞（注意这会覆盖前面的包含规则）

示例5：全部

all
  • 直接选择全部胞

总配置示例

FF0000FF:
  indices: [0, 2, 4]
  ranges: [[10, 15]]
00FF00FF:
  nHedra:
    - 4
    - nFaces: 6
      ranges: [[0, 3]]
0000FF77:
  indices: [0, 5, 10]
  ranges: [[20, 30]]
  nHedra: [4, 6]
  exclude:
    indices: [5, 25]
    ranges: [[22, 25]]

面高亮配置参数

参数名 类型 说明 约束条件
键 number 高亮的颜色 满足正则 ^[0-9a-fA-F]{8}$，即 16 进制 RGBA 色码
值 object 面选择器配置 见 面选择器配置格式

面选择器配置格式

特殊情况

可以直接为字符串 "all"，表示高亮所有面。

包含配置

参数名 类型 说明 约束条件
indices number[] 直接指定要选择的面索引数组 数组元素必须为非负整数
ngons number[] 根据边数选择面 数字必须为正整数

示例：

AA0000FF: { indices: [0] }
00FF00FF: { ngons: [4] }