--- sidebarDepth: 1 --- # 渲染 # 索引 --- | 接口 |
| 描述 | | --- | --- | --- | | [AddArrowShape](渲染.md#addarrowshape) | 客户端 | 新建箭头形状 | | [AddBoxShape](渲染.md#addboxshape) | 客户端 | 新建盒子形状 | | [AddCircleShape](渲染.md#addcircleshape) | 客户端 | 新建圆形状 | | [AddLineShape](渲染.md#addlineshape) | 客户端 | 新建线条形状 | | [AddSphereShape](渲染.md#addsphereshape) | 客户端 | 新建球形状 | | [AddTextShape](渲染.md#addtextshape) | 客户端 | 新建文本形状 | | [GetBoxScale](渲染.md#getboxscale) | 客户端 | 获取BoxShape的大小 | | [GetColor](渲染.md#getcolor) | 客户端 | 获取Shape的颜色 | | [GetEndPos](渲染.md#getendpos) | 客户端 | 获取LineShape或ArrowShape的结束位置 | | [GetLength](渲染.md#getlength) | 客户端 | 获取ArrowShape的头部长度 | | [GetPos](渲染.md#getpos) | 客户端 | 获取Shape的位置 | | [GetPriority](渲染.md#getpriority) | 客户端 | 获取Shape的优先级 | | [GetRadius](渲染.md#getradius) | 客户端 | 获取CircleShape或ArrowShape或SphereShape的半径 | | [GetSegments](渲染.md#getsegments) | 客户端 | 获取CircleShape或ArrowShape头部的分段数 | | [GetText](渲染.md#gettext) | 客户端 | 获取TextShape的文本 | | [GetType](渲染.md#gettype) | 客户端 | 获取Shape的类型 | | [GetVisible](渲染.md#getvisible) | 客户端 | 获取Shape是否可见 | | [Remove](渲染.md#remove) | 客户端 | 删除Shape | | [RemoveAll](渲染.md#removeall) | 客户端 | 删除当前所有Shape | | [SetBoxScale](渲染.md#setboxscale) | 客户端 | 设置BoxShape的大小 | | [SetColor](渲染.md#setcolor) | 客户端 | 设置Shape的颜色 | | [SetEndPos](渲染.md#setendpos) | 客户端 | 设置LineShape或ArrowShape的结束位置 | | [SetLength](渲染.md#setlength) | 客户端 | 设置组成ArrowShape头部的长度 | | [SetPos](渲染.md#setpos) | 客户端 | 设置Shape的位置 | | [SetPriority](渲染.md#setpriority) | 客户端 | 设置Shape的渲染优先级, 同一像素点处优先渲染优先级高的Shape, 默认为0 | | [SetRadius](渲染.md#setradius) | 客户端 | 设置CircleShape或ArrowShape或SphereShape的半径 | | [SetSegments](渲染.md#setsegments) | 客户端 | 设置组成ArrowShape头部的网格数量, 最小为3 | | [SetText](渲染.md#settext) | 客户端 | 设置TextShape的文本内容 | | [SetVisible](渲染.md#setvisible) | 客户端 | 设置Shape是否可见 | ## AddArrowShape 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 新建箭头形状 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | startPos | tuple(float,float,float) | 箭头形状的起始位置 | | endPos | tuple(float,float,float) | 箭头形状的结束位置 | | color | tuple(float,float,float) | 箭头形状的颜色, RGB值, 取值范围为[0,1], 默认为(1,1,1) | | headSegmentsNum | int | 组成箭头形状头部的网格数量, 最小为3, 默认为20 | | arrowHeadLength | float | 箭头形状头部的长度, 默认为1 | | radius | float | 箭头形状头部的半径, 默认为0.5 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | DrawingShapeCompClient | 新建的箭头形状 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0), 40, 5, 2.5) ``` ## AddBoxShape 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 新建盒子形状 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | pos | tuple(float,float,float) | 盒子形状的位置 | | scale | tuple(float,float,float) | 盒子形状的大小, 默认为(1,1,1) | | color | tuple(float,float,float) | 盒子形状的颜色, RGB值, 取值范围为[0,1], 默认为(1,1,1) | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | DrawingShapeCompClient | 新建的盒子形状 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) shape = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) ``` ## AddCircleShape 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 新建圆形状 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | pos | tuple(float,float,float) | 圆形状的位置 | | radius | float | 圆形状的半径 | | color | tuple(float,float,float) | 圆形状的颜色, RGB值, 取值范围为[0,1], 默认为(1,1,1) | | plane | int | 圆形状的平面, 0时为不指定平面, 1时为XY平面, 2时为XZ平面, 3时为YZ平面, 默认为2 | | segmentsNum | int | 圆形状的网格数量, 默认为20, 最小为1, 小于1后不渲染 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | DrawingShapeCompClient | 新建的圆形状 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) circle = comp.AddCircleShape((50,100,50), 5, (1,0,0)) ``` ## AddLineShape 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 新建线条形状 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | startPos | tuple(float,float,float) | 线条形状的起始位置 | | endPos | tuple(float,float,float) | 线条形状的结束位置 | | color | tuple(float,float,float) | 线条形状的颜色, RGB值, 取值范围为[0,1], 默认为(1,1,1) | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | DrawingShapeCompClient | 新建的线条形状 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) line = comp.AddLineShape((-37, 100, 100), (0,0,0),(1,0,0)) ``` ## AddSphereShape 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 新建球形状 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | pos | tuple(float,float,float) | 球形状的位置 | | radius | float | 球形状的半径 | | color | tuple(float,float,float) | 球形状的颜色, RGB值, 取值范围为[0,1], 默认为(1,1,1) | | segmentsNum | int | 球形状的网格数量, 默认为20, 最小为1, 小于等于1后不渲染 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | DrawingShapeCompClient | 新建的球形状 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) sphere = comp.AddSphereShape((-50, 100, -50), 5, (1,0,0)) ``` ## AddTextShape 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 新建文本形状 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | pos | tuple(float,float,float) | 文本形状的位置 | | text | str | 文本形状的文本 | | color | tuple(float,float,float) | 文本形状的颜色, RGB值, 取值范围为[0,1], 默认为(1,1,1) | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | DrawingShapeCompClient | 新建的文本形状 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) text = comp.AddTextShape((20,100,20), "test 测试", (1,0,0)) ``` ## GetBoxScale 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取BoxShape的大小 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | tuple(float,float,float) | BoxShape的大小 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) box.GetBoxScale() ``` ## GetColor 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取Shape的颜色 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | tuple(float,float,float) | Shape的颜色 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) box.GetColor() ``` ## GetEndPos 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取LineShape或ArrowShape的结束位置 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | tuple(float,float,float) | LineShape或ArrowShape的结束位置 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) line = comp.AddLineShape((0, 100, 100), (20,20,2),(1,0,0)) line.GetEndPos() ``` ## GetLength 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取ArrowShape的头部长度 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | float | ArrowShape的头部长度 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0), 40, 5) arrow.GetLength() ``` ## GetPos 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取Shape的位置 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | tuple(float,float,float) | Shape的位置 | - 备注 - 对于线条形状和箭头形状来说是指起点Pos, 其他是指形状中心Pos - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) box.GetPos() ``` ## GetPriority 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取Shape的优先级 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | int | Shape的优先级 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) box.GetPriority() ``` ## GetRadius 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取CircleShape或ArrowShape或SphereShape的半径 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | float | CircleShape或ArrowShape或SphereShape的半径 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) circle = comp.AddCircleShape((50,100,50), 5, (1,0,0)) circle.GetRadius() ``` ## GetSegments 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取CircleShape或ArrowShape头部的分段数 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | int | CircleShape或ArrowShape头部的分段数 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) circle = comp.AddCircleShape((50,100,50), 5, (1,0,0)) circle.GetSegments() ``` ## GetText 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取TextShape的文本 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | str | TextShape的文本 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) text = comp.AddTextShape((20,100,20), "test 测试", (1,0,0)) text.GetText() ``` ## GetType 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取Shape的类型 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | ShapeType | [Shape的类型](../枚举值/ShapeType.md) | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) box.GetType() ``` ## GetVisible 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 获取Shape是否可见 - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | Shape是否可见 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37, 100, 100),(5,5,5),(1,0,0)) box.GetVisible() ``` ## Remove 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 删除Shape - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 删除是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0),40, 5, 2.5) arrow.Remove() ``` ## RemoveAll 客户端 method in mod.client.component.drawingCompClient.DrawingCompClient - 描述 删除当前所有Shape - 参数 无 - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 删除是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) comp.RemoveAll() ``` ## SetBoxScale 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置BoxShape的大小 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | scale | tuple(float,float,float) | BoxShape的目标大小 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) box = comp.AddBoxShape((-37,100,100),(5,5,5),(1,0,0)) box.SetBoxScale((9,9,9)) ``` ## SetColor 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置Shape的颜色 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | color | tuple(float,float,float) | Shape的颜色, RGB值, 取值范围为[0,1] | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0),40, 5, 2.5) arrow.SetColor((0,0,0)) ``` ## SetEndPos 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置LineShape或ArrowShape的结束位置 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | endPos | tuple(float,float,float) | LineShape或ArrowShape的结束位置 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) line = comp.AddLineShape((0, 100, 100), (0,100,50),(1,0,0)) line.SetEndPos((20,200, 20)) ``` ## SetLength 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置组成ArrowShape头部的长度 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | length | float | 组成ArrowShape头部的长度 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0),40, 5, 2.5) arrow.SetLength(10) ``` ## SetPos 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置Shape的位置 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | pos | tuple(float,float,float) | Shape的目标位置 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 备注 - 对于线条形状和箭头形状来说是指起点Pos, 其他是指形状中心Pos - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) line = comp.AddLineShape((0,100,100), (0,100,50),(1,0,0)) line.SetPos((0,100,70)) ``` ## SetPriority 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置Shape的渲染优先级, 同一像素点处优先渲染优先级高的Shape, 默认为0 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | priority | int | Shape的渲染优先级 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0),40, 5, 2.5) arrow.SetPriority(10) ``` ## SetRadius 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置CircleShape或ArrowShape或SphereShape的半径 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | radius | float | CircleShape或ArrowShape或SphereShape的半径 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) circle = comp.AddCircleShape((50,100,50), 5, (1,0,0)) print circle.SetRadius(2.0) ``` ## SetSegments 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置组成ArrowShape头部的网格数量, 最小为3 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | segments | int | 组成ArrowShape头部的网格数量, 最小为3 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0),40, 5, 2.5) arrow.SetSegments(100) ``` ## SetText 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置TextShape的文本内容 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | text | str | TextShape的文本内容 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) text = comp.AddTextShape((20,100,20), "test 测试", (1,0,0)) text.SetText("tteesstt") ``` ## SetVisible 客户端 method in mod.client.component.drawingShapeCompClient.DrawingShapeCompClient - 描述 设置Shape是否可见 - 参数 | 参数名 |
数据类型
| 说明 | | :--- | :--- | :--- | | visible | bool | Shape是否可见 | - 返回值 |
数据类型
| 说明 | | :--- | :--- | | bool | 设置是否成功 | - 示例 ```python import mod.client.extraClientApi as clientApi comp = clientApi.GetEngineCompFactory().CreateDrawing(levelId) arrow = comp.AddArrowShape((20,100,20), (20,150,20), (1,0,0),40, 5, 2.5) arrow.SetVisible(False) ```