docs: add docs for plane node

antvis · Nov 29, 2023 · cd55bc2 · cd55bc2
1 parent a1e5fb3
commit cd55bc2
Show file tree

Hide file tree

Showing 2 changed files with 93 additions and 8 deletions.
diff --git a/packages/site/docs/apis/shape/PlaneGeometryProps.en.md b/packages/site/docs/apis/shape/PlaneGeometryProps.en.md
@@ -11,30 +11,72 @@ Plane geometry, default lying on the XZ plane
 
 **Type**: `number`
 
-**Default**: `0`
+**Default**: `100`
 
 width
 
 ## depth
 
 **Type**: `number`
 
-**Default**: `0`
+**Default**: `100`
 
 depth
 
 ## widthSegments
 
 **Type**: `number`
 
-**Default**: `1`
+**Default**: `5`
 
 width segments
 
 ## depthSegments
 
 **Type**: `number`
 
-**Default**: `1`
+**Default**: `5`
 
 depth segments
+
+## materialType
+
+**Type**：`'basic' | 'phong' | 'lambert'`
+
+**Default**：`basic`
+
+material type
+
+## materialProps material-related parameters
+
+### wireframe
+
+**Type**：`boolean`
+
+**Default**：`false`
+
+enable wireframe，Commonly used to visually display triangular surfaces
+
+### wireframeColor
+
+**Type**：`string`
+
+**Default**：`black`
+
+After enabling wireframe, you can specify a color, which defaults to 'black'
+
+### wireframeLineWidth
+
+**Type**：`number`
+
+**Default**：`1`
+
+After enabling wireframe, you can specify the line width, which defaults to 1
+
+### cullMode
+
+**Type**：`number`
+
+**Default**：`0`
+
+Turn on face removal, default to 0, which means no removal. 1 is front removal, 2 is back removal, and 3 is front and back removal
diff --git a/packages/site/docs/apis/shape/PlaneGeometryProps.zh.md b/packages/site/docs/apis/shape/PlaneGeometryProps.zh.md
@@ -11,30 +11,73 @@ order: 11
 
 **类型**：`number`
 
-**默认值**：`0`
+**默认值**：`100`
 
 宽度
 
 ## depth
 
 **类型**：`number`
 
-**默认值**：`0`
+**默认值**：`100`
 
 深度
 
 ## widthSegments
 
 **类型**：`number`
 
-**默认值**：`1`
+**默认值**：`5`
 
 宽度分段数
 
 ## depthSegments
 
 **类型**：`number`
 
-**默认值**：`1`
+**默认值**：`5`
 
 深度分段数
+
+## materialType
+
+**类型**：`'basic' | 'phong' | 'lambert'`
+
+**默认值**：`basic`
+
+材质类型
+
+## materialProps 材质相关属性
+
+### wireframe
+
+**类型**：`boolean`
+
+**默认值**：`false`
+
+Draw a wireframe, commonly used to visually display triangular surfaces
+
+### wireframeColor
+
+**类型**：`string`
+
+**默认值**：`black`
+
+开启 wireframe 后可指定颜色，默认为 'black'
+
+### wireframeLineWidth
+
+**类型**：`number`
+
+**默认值**：`1`
+
+开启 wireframe 后可指定线宽，默认为 1
+
+### cullMode
+
+**类型**：`number`
+
+**默认值**：`0`
+
+开启 面剔除，默认为 0，即不剔除，1 为正面剔除，2 为背面剔除, 3 为正背面剔除
+