AR_Engine_SDK
Functions | Variables
XEBrushComponent.lua File Reference
类 XEBrushComponent 继承关系图:
Inheritance graph

Functions

function XEBrushComponent new () end
 
function XEBrushComponent Initialize (pActor) end
 @type string @readonly Component类型名 More...
 
function XEBrushComponent Release () end
 
function XEBrushComponent Tick (fDel, bForceTick) end
 
function XEBrushComponent Render (pViewport) end
 
function XEBrushComponent GetBrushPrimitive () end
 
function XEBrushComponent BuildBrushPrimitive (brushInitParam) end
 
function XEBrushComponent SetBrushColor (clrBrushColor) end
 
function XEBrushComponent GetBrushColor () end
 
function XEBrushComponent RemoveAllPathPoints () end
 
function XEBrushComponent AddPathWorldPoint (vWorldPoint) end
 
function XEBrushComponent SetMaterialFile (szMaterialPath, bReCreateBrushPrimitive) end
 
function XEBrushComponent SetTexcoordLoopMode (eMode, bReCreateBrushPrimitive) end
 
function XEBrushComponent SetBrushShapeGroup (shapeGroup, bReCreateBrushPrimitive) end
 
function XEBrushComponent SetBrushShapeByIndex (nIndex, aBrushShape, bReCreateBrushPrimitive) end
 
function XEBrushComponent AddBrushShapePoint (vWorldPos, nIndex, bReCreateBrushPrimitive) end
 
function XEBrushComponent SetBrushInitColor (clrBrushColor, bReCreateBrushPrimitive) end
 
function XEBrushComponent GetBrushInitParam () end
 
function XEBrushComponent CreateNewPath () end
 

Variables

 XEBrushComponent = {}
 

Function Documentation

◆ AddBrushShapePoint()

function XEBrushComponent AddBrushShapePoint ( vWorldPos  ,
nIndex  ,
bReCreateBrushPrimitive   
)

增加画刷形状的点，并重新创建画刷几何体

Parameters
vWorldPosXVECTOR3 组成画刷形状的世界坐标点
nIndexnumber 画刷形状组的索引，默认为0
bReCreateBrushPrimitiveboolean 是否重新创建画刷几何体
Returns
boolean 是否创建成功(xbool),如果bReCreateBrushPrimitive为xfalse，返回值为必为xfalse

◆ AddPathWorldPoint()

function XEBrushComponent AddPathWorldPoint ( vWorldPoint  )

为画刷添加一个路径点

Parameters
vWorldPointXVECTOR3 世界空间坐标点
Returns
void

◆ BuildBrushPrimitive()

function XEBrushComponent BuildBrushPrimitive ( brushInitParam  )

创建画刷几何体

Parameters
brushInitParamIXBrushManager::BrushInitParam 画刷初始化参数
Returns
boolean 是否创建成功(xbool)

◆ CreateNewPath()

function XEBrushComponent CreateNewPath ( )

创建一段新的路径,如果上一段路径还没有添加路径点，则不会创建新路径

Returns
void

◆ GetBrushColor()

function XEBrushComponent GetBrushColor ( )

获取画刷颜色

Returns
XCOLORBASE 画刷颜色(XCOLORBASE)

◆ GetBrushInitParam()

function XEBrushComponent GetBrushInitParam ( )

XEBrushComponent_GetBrushInitParam00

Returns
IXBrushManager__BrushInitParam

◆ GetBrushPrimitive()

function XEBrushComponent GetBrushPrimitive ( )

获取画刷几何体指针

Returns
IXBrushPrimitive IXBrushPrimitive画刷几何体指针

◆ Initialize()

function XEBrushComponent Initialize ( pActor  )

@type string @readonly Component类型名

根据pActor初始化当前组件的部分数据，包含当前组件所属的XEActor及当前组件的索引等

Parameters
pActorXEActor 当前组件所属的XEActor，一般而言，每个XEActor都至少包含一个组件
Returns
void

◆ new()

function XEBrushComponent new ( )

XEBrushComponent_new00

Returns
XEBrushComponent

◆ Release()

function XEBrushComponent Release ( )

释放资源

Returns
void

◆ RemoveAllPathPoints()

function XEBrushComponent RemoveAllPathPoints ( )

移除路径上的所有点

Returns
void

◆ Render()

function XEBrushComponent Render ( pViewport  )

渲染当前组件，此函数每帧都会被 XEActor 调用

Parameters
pViewportXEViewport
Returns
void

◆ SetBrushColor()

function XEBrushComponent SetBrushColor ( clrBrushColor  )

设置画刷颜色

Parameters
clrBrushColorXCOLORBASE 画刷颜色
Returns
void

◆ SetBrushInitColor()

function XEBrushComponent SetBrushInitColor ( clrBrushColor  ,
bReCreateBrushPrimitive   
)

增加画刷初始颜色，并重新创建画刷几何体

Parameters
clrBrushColorXCOLORBASE 画刷初始颜色
bReCreateBrushPrimitiveboolean 是否重新创建画刷几何体
Returns
boolean 是否创建成功(xbool),如果bReCreateBrushPrimitive为xfalse，返回值为必为xfalse

◆ SetBrushShapeByIndex()

function XEBrushComponent SetBrushShapeByIndex ( nIndex  ,
aBrushShape  ,
bReCreateBrushPrimitive   
)

更改画刷形状，并重新创建画刷几何体

Parameters
nIndexnumber 画刷形状组的索引
aBrushShapeXVECTOR3[] 画刷形状组的某个索引对应的形状
bReCreateBrushPrimitiveboolean 是否重新创建画刷几何体
Returns
boolean 是否创建成功(xbool),如果bReCreateBrushPrimitive为xfalse，返回值为必为xfalse

◆ SetBrushShapeGroup()

function XEBrushComponent SetBrushShapeGroup ( shapeGroup  ,
bReCreateBrushPrimitive   
)

更改画刷形状，并重新创建画刷几何体

Parameters
shapeGroupXBrushShape[] 画刷形状组
bReCreateBrushPrimitiveboolean 是否重新创建画刷几何体
Returns
boolean 是否创建成功(xbool),如果bReCreateBrushPrimitive为xfalse，返回值为必为xfalse

◆ SetMaterialFile()

function XEBrushComponent SetMaterialFile ( szMaterialPath  ,
bReCreateBrushPrimitive   
)

设置材质文件，并重新创建画刷几何体

Parameters
szMaterialPathstring mt文件滤镜
bReCreateBrushPrimitiveboolean 是否重新创建画刷几何体
Returns
boolean 是否创建成功(xbool),如果bReCreateBrushPrimitive为xfalse，返回值为必为xfalse

◆ SetTexcoordLoopMode()

function XEBrushComponent SetTexcoordLoopMode ( eMode  ,
bReCreateBrushPrimitive   
)

设置ShapeGroup中各顶点纹理坐标在U方向上的平铺方式(0-1)，并重新创建画刷几何体

Parameters
eModenumber 纹理坐标平铺方式
bReCreateBrushPrimitiveboolean 是否重新创建画刷几何体
Returns
boolean 是否创建成功(xbool),如果bReCreateBrushPrimitive为xfalse，返回值为必为xfalse

◆ Tick()

function XEBrushComponent Tick ( fDel  ,
bForceTick   
)

更新当前组件的数据，此函数每帧都会被调用

Parameters
fDelnumber 每帧更新的时间间隔(ms)
bForceTickboolean 是否强制Tick.如果为true，不管当前组件是否隐藏，都会更新；如果为false，当前组件如果隐藏时不更新。
Returns
void

Variable Documentation

◆ XEBrushComponent

XEBrushComponent = {}
Generated by   doxygen 1.8.15