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

Functions

function IXCanvasBase Init () end
 
function IXCanvasBase Release () end
 
function IXCanvasBase DrawString (x, y, szString, clr) end
 
function IXCanvasBase DrawQuad (x, y, nWidth, nHeight, clr, bSolid, pMat) end
 
function IXCanvasBase Render2DLine (xBegin, yBegin, xEnd, yEnd, clr, pMat) end
 
function IXCanvasBase Render2DCircle (vPos, fRadius, vStartNormalizedDir, vEndNormalizedDir, color, bClockWise, bSolid, pMat) end
 
function IXCanvasBase RenderLine (vBegin, vEnd, clr, bZEnabled) end
 
function IXCanvasBase RenderLines (aVerts, nNumVert, aIndices, nNumIndex, clr, aColors, nNumColor, bZEnabled) end
 
function IXCanvasBase RenderAABB (aabb, clr, bSolid, bLight, bZEnabled) end
 
function IXCanvasBase RenderSphere (vPos, fRadius, clr, bSolid, bLight, bZEnabled, pMat) end
 
function IXCanvasBase RenderOBB (obb, clr, bSolid, bLight, bZEnabled, pMat) end
 
function IXCanvasBase RenderBox (vPos, vDir, vUp, vRight, vExts, clr, bSolid, bLight, bZEnabled, pMat) end
 
function IXCanvasBase RenderCone (cone, clr, bSolid, bLight, bZEnabled, pMat) end
 
function IXCanvasBase RenderCustomGeometry (aVerts, nNumVert, aIndices, nNumIndex, clr, aColors, nNumColor, aNormals, nNumNormal, bLight, bZEnabled) end
 
function IXCanvasBase RenderCustomGeometry (aVerts, aColors, aTexcoords, nNumVert, aIndices, nNumIndex, pTex, bZEnabled) end
 
function IXCanvasBase RenderCircle (vPos, fRadius, vStartNormalizedDir, vEndNormalizedDir, vNormalizedRotationAxis, color, bSolid, bZEnabled, pWorldMat) end
 
function IXCanvasBase RenderCapsule (capsule, clr, bSolid, bLight, bZEnabled, pMat) end
 

Variables

 IXCanvasBase = {}
 

Function Documentation

◆ DrawQuad()

function IXCanvasBase DrawQuad ( x  ,
y  ,
nWidth  ,
nHeight  ,
clr  ,
bSolid  ,
pMat   
)

绘制四边形

Parameters
xnumber 绘制的起始位置坐标的x分量
ynumber 绘制的起始位置坐标的y分量
nWidthnumber 绘制的四边形宽度
nHeightnumber 绘制的四边形高度
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bSolidboolean 是否用颜色填充四边形区域,默认是false
pMatXMATRIX3 叠加矩阵,默认为空。(如果设置了叠加矩阵,绘制信息会叠加上这个矩阵数据)
Returns
void

◆ DrawString()

function IXCanvasBase DrawString ( x  ,
y  ,
szString  ,
clr   
)

绘制字符串

Parameters
xnumber 绘制的位置坐标的x分量
ynumber 绘制的位置坐标的y分量
szStringstring 要绘制的字符串内容
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
Returns
void

◆ Init()

function IXCanvasBase Init ( )

初始化

Returns
boolean

◆ Release()

function IXCanvasBase Release ( )

释放

Returns
void

◆ Render2DCircle()

function IXCanvasBase Render2DCircle ( vPos  ,
fRadius  ,
vStartNormalizedDir  ,
vEndNormalizedDir  ,
color  ,
bClockWise  ,
bSolid  ,
pMat   
)

IXCanvasBase_Render2DCircle00

Parameters
vPosXVECTOR2
fRadiusnumber
vStartNormalizedDirXVECTOR2
vEndNormalizedDirXVECTOR2
colorXCOLORBASE
bClockWiseboolean
bSolidboolean
pMatXMATRIX3
Returns
void

◆ Render2DLine()

function IXCanvasBase Render2DLine ( xBegin  ,
yBegin  ,
xEnd  ,
yEnd  ,
clr  ,
pMat   
)

绘制2D直线

Parameters
xBeginnumber 直线的起始点坐标x分量
yBeginnumber 直线的起始点坐标y分量
xEndnumber 直线的结束点坐标x分量
yEndnumber 直线的结束点坐标y分量
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
pMatXMATRIX3 叠加矩阵,默认为空。(如果设置了叠加矩阵,绘制信息会叠加上这个矩阵数据)
Returns
void

◆ RenderAABB()

function IXCanvasBase RenderAABB ( aabb  ,
clr  ,
bSolid  ,
bLight  ,
bZEnabled   
)

绘制AABB包围盒

Parameters
aabbXCusAABB 要绘制的包围盒信息
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bSolidboolean 是否用颜色填充绘制的区域,默认是false
bLightboolean 是否绘制光照信息,默认为xtrue
bZEnabledboolean 是否开启深度测试,默认为xtrue(开启后,只绘制观察者可见到的部分)
Returns
void

◆ RenderBox()

function IXCanvasBase RenderBox ( vPos  ,
vDir  ,
vUp  ,
vRight  ,
vExts  ,
clr  ,
bSolid  ,
bLight  ,
bZEnabled  ,
pMat   
)

IXCanvasBase_RenderBox00

Parameters
vPosXVECTOR3
vDirXVECTOR3
vUpXVECTOR3
vRightXVECTOR3
vExtsXVECTOR3
clrXCOLORBASE
bSolidboolean
bLightboolean
bZEnabledboolean
pMatXMATRIX4
Returns
void

◆ RenderCapsule()

function IXCanvasBase RenderCapsule ( capsule  ,
clr  ,
bSolid  ,
bLight  ,
bZEnabled  ,
pMat   
)

绘制胶囊体

Parameters
capsuleXCusCapsule 要绘制的胶囊体信息
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bSolidboolean 是否用颜色填充绘制的区域,默认是false
bLightboolean 是否绘制光照信息,默认为xtrue
bZEnabledboolean 是否开启深度测试,默认为xtrue(开启后,只绘制观察者可见到的部分)
pMatXMATRIX4 叠加矩阵,默认为空。(如果设置了叠加矩阵,绘制信息会叠加上这个矩阵数据)
Returns
void

◆ RenderCircle()

function IXCanvasBase RenderCircle ( vPos  ,
fRadius  ,
vStartNormalizedDir  ,
vEndNormalizedDir  ,
vNormalizedRotationAxis  ,
color  ,
bSolid  ,
bZEnabled  ,
pWorldMat   
)

IXCanvasBase_RenderCircle00

Parameters
vPosXVECTOR3
fRadiusnumber
vStartNormalizedDirXVECTOR3
vEndNormalizedDirXVECTOR3
vNormalizedRotationAxisXVECTOR3
colorXCOLORBASE
bSolidboolean
bZEnabledboolean
pWorldMatXMATRIX4
Returns
void

◆ RenderCone()

function IXCanvasBase RenderCone ( cone  ,
clr  ,
bSolid  ,
bLight  ,
bZEnabled  ,
pMat   
)

绘制椎体

Parameters
coneXCusCone 要绘制的椎体信息
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bSolidboolean 是否用颜色填充绘制的区域,默认是false
bLightboolean 是否绘制光照信息,默认为xtrue
bZEnabledboolean 是否开启深度测试,默认为xtrue(开启后,只绘制观察者可见到的部分)
pMatXMATRIX4 叠加矩阵,默认为空。(如果设置了叠加矩阵,绘制信息会叠加上这个矩阵数据)
Returns
void

◆ RenderCustomGeometry() [1/2]

function IXCanvasBase RenderCustomGeometry ( aVerts  ,
nNumVert  ,
aIndices  ,
nNumIndex  ,
clr  ,
aColors  ,
nNumColor  ,
aNormals  ,
nNumNormal  ,
bLight  ,
bZEnabled   
)

IXCanvasBase_RenderCustomGeometry00

Parameters
aVertsXVECTOR3
nNumVertnumber
aIndicesnumber
nNumIndexnumber
clrXCOLORBASE
aColorsXCOLORBASE
nNumColornumber
aNormalsXVECTOR3
nNumNormalnumber
bLightboolean
bZEnabledboolean
Returns
void

◆ RenderCustomGeometry() [2/2]

function IXCanvasBase RenderCustomGeometry ( aVerts  ,
aColors  ,
aTexcoords  ,
nNumVert  ,
aIndices  ,
nNumIndex  ,
pTex  ,
bZEnabled   
)

IXCanvasBase_RenderCustomGeometry01

Parameters
aVertsXVECTOR3
aColorsXCOLORBASE
aTexcoordsXVECTOR2
nNumVertnumber
aIndicesnumber
nNumIndexnumber
pTexIXTexture
bZEnabledboolean
Returns
void

◆ RenderLine()

function IXCanvasBase RenderLine ( vBegin  ,
vEnd  ,
clr  ,
bZEnabled   
)

绘制一条3D直线

Parameters
vBeginXVECTOR3 直线起始点坐标
vEndXVECTOR3 直线结束点坐标
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bZEnabledboolean 是否开启深度测试,默认为xtrue(开启后,只绘制观察者可见到的部分)
Returns
void

◆ RenderLines()

function IXCanvasBase RenderLines ( aVerts  ,
nNumVert  ,
aIndices  ,
nNumIndex  ,
clr  ,
aColors  ,
nNumColor  ,
bZEnabled   
)

IXCanvasBase_RenderLines00

Parameters
aVertsXVECTOR3
nNumVertnumber
aIndicesnumber
nNumIndexnumber
clrXCOLORBASE
aColorsXCOLORBASE
nNumColornumber
bZEnabledboolean
Returns
void

◆ RenderOBB()

function IXCanvasBase RenderOBB ( obb  ,
clr  ,
bSolid  ,
bLight  ,
bZEnabled  ,
pMat   
)

绘制OBB包围盒

Parameters
obbXCusOBB 要绘制的包围盒信息
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bSolidboolean 是否用颜色填充绘制的区域,默认是false
bLightboolean 是否绘制光照信息,默认为xtrue
bZEnabledboolean 是否开启深度测试,默认为xtrue(开启后,只绘制观察者可见到的部分)
pMatXMATRIX4 叠加矩阵,默认为空。(如果设置了叠加矩阵,绘制信息会叠加上这个矩阵数据)
Returns
void

◆ RenderSphere()

function IXCanvasBase RenderSphere ( vPos  ,
fRadius  ,
clr  ,
bSolid  ,
bLight  ,
bZEnabled  ,
pMat   
)

绘制球状

Parameters
vPosXVECTOR3 要绘制的包围盒信息
fRadiusnumber 要绘制的包围盒信息
clrXCOLORBASE 绘制颜色(XCOLORBASE格式)
bSolidboolean 是否用颜色填充绘制的区域,默认是false
bLightboolean 是否绘制光照信息,默认为xtrue
bZEnabledboolean 是否开启深度测试,默认为xtrue(开启后,只绘制观察者可见到的部分)
pMatXMATRIX4 叠加矩阵,默认为空。(如果设置了叠加矩阵,绘制信息会叠加上这个矩阵数据)
Returns
void

Variable Documentation

◆ IXCanvasBase