AR_Engine_SDK
载入中...
搜索中...
未找到
函数 | 变量
XEViewport.lua 文件参考

#include <XEViewport.h>

OrbitPanView 的协作图:
Collaboration graph

#include <XEViewport.h>

类 XEViewport 继承关系图:
Inheritance graph

#include <XEViewport.h>

类 XEViewportManager 继承关系图:
Inheritance graph

函数

function OrbitPanView new (pVp) end
 
function OrbitPanView new (pCamera) end
 
function OrbitPanView SetLookAt (vLookAt) end
 
function OrbitPanView SetMouseSensitivity (fVal) end
 
function OrbitPanView SetLookAtDistance (fVal) end
 
function OrbitPanView GetMouseSensitivity () end
 
function OrbitPanView GetLookAtDistance () end
 
function OrbitPanView GetLookAt () end
 
function OrbitPanView UpdateView (bUsingCallbackFunc) end
 
function OrbitPanView RatateAround (nDeltaX, nDeltaY) end
 
function OrbitPanView SetPitchLimit (fMinEulerRadian, fMaxEulerRadian, bEnable) end
 
function OrbitPanView SetYawLimit (fMinEulerRadian, fMaxEulerRadian, bEnable) end
 
function OrbitPanView SetLimitAtCurrentAngle (bSet) end
 
function OrbitPanView IsLimitAtCurrentAngle () end
 
function XEViewport GetVPTypeName (eType) end
 
function XEViewport Resize () end
 
function XEViewport Resize (nWidth, nHeight) end
 
function XEViewport Resize (nX, nY, nWidth, nHeight) end
 
function XEViewport UpdateAttachedCameraAspect () end
 
function XEViewport GetName () end
 
function XEViewport GetXViewport () end
 
function XEViewport IsActive () end
 
function XEViewport SetActive (bActive) end
 
function XEViewport GetType () end
 
function XEViewport GetAddRenderOption () end
 
function XEViewport SetAddRenderOption (nOption) end
 
function XEViewport AttachWorld (pWorld) end
 
function XEViewport GetAttachWorld () end
 
function XEViewport GetWorkCamera () end
 
function XEViewport GetAttachCamera () end
 
function XEViewport GetPresentWindow () end
 
function XEViewport SetPresentWindow (pWindow) end
 
function XEViewport AttachCamera (pAttachCamera) end
 
function XEViewport SetOwnerCameraParam (pCamera) end
 
function XEViewport AttachToOwnerCamera () end
 
function XEViewport GetOwnerCamera () end
 
function XEViewport SetCameraPosTextColor (r, g, b, a) end
 
function XEViewport SetCameraPosTextColor (color) end
 
function XEViewport SetFpsTextColor (r, g, b, a) end
 
function XEViewport SetFpsTextColor (color) end
 
function XEViewport SetFpsRenderPos (FpsRenderpos) end
 
function XEViewport GetFpsRenderPos () end
 
function XEViewport SetPrefabTextColor (r, g, b, a) end
 
function XEViewport SetPrefabTextColor (color) end
 
function XEViewport GetRenderY () end
 
function XEViewport GetViewportWidth () end
 
function XEViewport GetViewportHeight () end
 
function XEViewport GetOribitPanView () end
 
function XEViewport GetWindowScale () end
 
function XEViewport SetStatInfo (strInfo) end
 
function XEViewport SetStatDisplayColor (groupColor, statColor) end
 
function XEViewport GetStatDisplayColor (outGroupColor, outStatColor) end
 
function XEViewportManager CreateXEViewport (eType, strName, pWindow, fWindowScale) end
 
function XEViewportManager DeleteXEViewport (strName) end
 
function XEViewportManager GetXEViewport (strName) end
 
function XEViewportManager GetXEViewport (pWorld) end
 
function XEViewportManager GetXEViewport (pWorld, eViewportType) end
 
function XEViewportManager GetXEViewport (pWin) end
 
function XEViewportManager GetXEViewport (pWin, eViewportType) end
 
function XEViewportManager GetAllXEViewports (pWin) end
 
function XEViewportManager GetXEViewport (pViewPort) end
 
function XEViewportManager GetRefXEViewport (pCamera) end
 
function XEViewportManager GetXEViewportByWorldName (strWorldName) end
 

变量

 OrbitPanView = {}
 

函数说明

◆ AttachCamera()

function XEViewport AttachCamera ( pAttachCamera  )

设置该视口的附加相机，并把该相机设置为场景相机

参数
pAttachCameraXBaseCamera
返回
void

◆ AttachToOwnerCamera()

function XEViewport AttachToOwnerCamera ( )

把视口附加相机指针指向视口自己的相机，并把视口的自己相机设置为场景相机

返回
void

◆ AttachWorld()

function XEViewport AttachWorld ( pWorld  )

该视口绑定一个世界

参数
pWorldXEWorld
返回
void

◆ CreateXEViewport()

function XEViewportManager CreateXEViewport ( eType  ,
strName  ,
pWindow  ,
fWindowScale   
)

创建视口

参数
eTypenumber 视口类型
strNamestring 视口名称
pWindowIXPlatformWindow 视口相关联的窗口指针
fWindowScalenumber 窗口的设备像素比
返回
XEViewport 返回创建的视口指针

◆ DeleteXEViewport()

function XEViewportManager DeleteXEViewport ( strName  )

删除视口

参数
strNamestring 视口名称
返回
void

◆ GetAddRenderOption()

function XEViewport GetAddRenderOption ( )

获取当前视口的渲染选项

返回
number

◆ GetAllXEViewports()

function XEViewportManager GetAllXEViewports ( pWin  )

XEViewportManager_GetAllXEViewports00

参数
pWinIXPlatformWindow
返回
XEViewport[]

◆ GetAttachCamera()

function XEViewport GetAttachCamera ( )

获取该视口的工作相机，即附加相机

返回
XBaseCamera

◆ GetAttachWorld()

function XEViewport GetAttachWorld ( )

获取该视口绑定的世界指针

返回
XEWorld

◆ GetFpsRenderPos()

function XEViewport GetFpsRenderPos ( )

获取fps渲染位置

返回
number

◆ GetLookAt()

function OrbitPanView GetLookAt ( )

获取相机看的目标点坐标

返回
XVECTOR3 看的目标点坐标

◆ GetLookAtDistance()

function OrbitPanView GetLookAtDistance ( )

获取视点距离

返回
number 视点距离

◆ GetMouseSensitivity()

function OrbitPanView GetMouseSensitivity ( )

获取鼠标敏感度

返回
number 敏感度大小

◆ GetName()

function XEViewport GetName ( )

获取视口名称

返回
string

◆ GetOribitPanView()

function XEViewport GetOribitPanView ( )

获取OrbitPanView指针

返回
OrbitPanView

◆ GetOwnerCamera()

function XEViewport GetOwnerCamera ( )

获取场景相机指针

返回
XBaseCamera

◆ GetPresentWindow()

function XEViewport GetPresentWindow ( )

获取该视口对应的窗口

返回
IXPlatformWindow

◆ GetRefXEViewport()

function XEViewportManager GetRefXEViewport ( pCamera  )

通过XBaseCamera指针获取关联的XEViewport列表

参数
pCameraXBaseCamera XBaseCamera指针
返回
XEViewport[] 关联的XEViewport列表

◆ GetRenderY()

function XEViewport GetRenderY ( )

获取字体开始渲染的Y值

返回
number

◆ GetStatDisplayColor()

function XEViewport GetStatDisplayColor ( outGroupColor  ,
outStatColor   
)

XEViewport_GetStatDisplayColor00

参数
outGroupColorXCOLORBASE
outStatColorXCOLORBASE
返回
void

◆ GetType()

function XEViewport GetType ( )

获取视口类型

返回
number

◆ GetViewportHeight()

function XEViewport GetViewportHeight ( )

获取视口的高

返回
number

◆ GetViewportWidth()

function XEViewport GetViewportWidth ( )

获取视口的宽

返回
number

◆ GetVPTypeName()

function XEViewport GetVPTypeName ( eType  )

获取视口类型对应的名称

参数
eTypenumber 视口类型
返回
string 视口类型对应的名称

◆ GetWindowScale()

function XEViewport GetWindowScale ( )

获取当前窗口设备像素比devicePixelRatio

返回
number

◆ GetWorkCamera()

function XEViewport GetWorkCamera ( )

获取该视口的工作相机，即附加相机

返回
XBaseCamera

◆ GetXEViewport() [1/6]

function XEViewportManager GetXEViewport ( pViewPort  )

通过底层XViewport指针获取XEViewport

参数
pViewPortXViewport XViewport指针
返回
XEViewport XEViewport视口指针

◆ GetXEViewport() [2/6]

function XEViewportManager GetXEViewport ( pWin  )

通过窗口获取视口

参数
pWinIXPlatformWindow 窗口指针
返回
XEViewport 视口指针

◆ GetXEViewport() [3/6]

function XEViewportManager GetXEViewport ( pWin  ,
eViewportType   
)

XEViewportManager_GetXEViewport04

参数
pWinIXPlatformWindow
eViewportTypenumber
返回
XEViewport

◆ GetXEViewport() [4/6]

function XEViewportManager GetXEViewport ( pWorld  )

通过世界指针获取视口

参数
pWorldXEWorld 世界指针
返回
XEViewport 视口指针

◆ GetXEViewport() [5/6]

function XEViewportManager GetXEViewport ( pWorld  ,
eViewportType   
)

XEViewportManager_GetXEViewport02

参数
pWorldXEWorld
eViewportTypenumber
返回
XEViewport

◆ GetXEViewport() [6/6]

function XEViewportManager GetXEViewport ( strName  )

通过名称获取视口

参数
strNamestring 视口名称
返回
XEViewport 视口指针

◆ GetXEViewportByWorldName()

function XEViewportManager GetXEViewportByWorldName ( strWorldName  )

通过WorldName获取关联的XEViewport指针

参数
strWorldNamestring WorldName
返回
XEViewport XEViewport指针

◆ GetXViewport()

function XEViewport GetXViewport ( )

获取引擎视口指针

返回
XViewport

◆ IsActive()

function XEViewport IsActive ( )

判断是否是激活状态

返回
boolean

◆ IsLimitAtCurrentAngle()

function OrbitPanView IsLimitAtCurrentAngle ( )

获取是否将限制应用在当前相机的姿态角上

返回
boolean

◆ new() [1/2]

function OrbitPanView new ( pCamera  )

OrbitPanView_new01

参数
pCameraXBaseCamera
返回
OrbitPanView

◆ new() [2/2]

function OrbitPanView new ( pVp  )

OrbitPanView_new00

参数
pVpXEViewport
返回
OrbitPanView

◆ RatateAround()

function OrbitPanView RatateAround ( nDeltaX  ,
nDeltaY   
)

绕关注点旋转相机

参数
nDeltaXnumber Pitch角的鼠标偏移值
nDeltaYnumber Yaw角的鼠标偏移值
返回
void

◆ Resize() [1/3]

function XEViewport Resize ( )

调整大小

返回
void

◆ Resize() [2/3]

function XEViewport Resize ( nWidth  ,
nHeight   
)

XEViewport_Resize01

参数
nWidthnumber
nHeightnumber
返回
void

◆ Resize() [3/3]

function XEViewport Resize ( nX  ,
nY  ,
nWidth  ,
nHeight   
)

XEViewport_Resize02

参数
nXnumber
nYnumber
nWidthnumber
nHeightnumber
返回
void

◆ SetActive()

function XEViewport SetActive ( bActive  )

设置激活状态

参数
bActiveboolean
返回
void

◆ SetAddRenderOption()

function XEViewport SetAddRenderOption ( nOption  )

设置当前视口的渲染选项

参数
nOptionnumber
返回
void

◆ SetCameraPosTextColor() [1/2]

function XEViewport SetCameraPosTextColor ( color  )

设置视口附加渲染项中的相机位置信息的渲染颜色

参数
colorXCOLORBASE
返回
void

◆ SetCameraPosTextColor() [2/2]

function XEViewport SetCameraPosTextColor ( r  ,
g  ,
b  ,
a   
)

设置视口附加渲染项中的相机位置信息的渲染颜色

参数
rnumber
gnumber
bnumber
anumber
返回
void

◆ SetFpsRenderPos()

function XEViewport SetFpsRenderPos ( FpsRenderpos  )

设置fps渲染位置

参数
FpsRenderposnumber
返回
void

◆ SetFpsTextColor() [1/2]

function XEViewport SetFpsTextColor ( color  )

设置视口附加渲染项中的fps信息的渲染颜色

参数
colorXCOLORBASE
返回
void

◆ SetFpsTextColor() [2/2]

function XEViewport SetFpsTextColor ( r  ,
g  ,
b  ,
a   
)

设置视口附加渲染项中的fps信息的渲染颜色

参数
rnumber
gnumber
bnumber
anumber
返回
void

◆ SetLimitAtCurrentAngle()

function OrbitPanView SetLimitAtCurrentAngle ( bSet  )

设置是否将限制应用在当前相机的姿态角上 为xfalse时，则设置的限制量为相机的最终姿态角，并对此进行限制

参数
bSetboolean 为xtrue时，将以当前相机的姿态角为基础，对限制角度的偏移量进行限制（此时设置的限制量为偏移量）
返回
void

◆ SetLookAt()

function OrbitPanView SetLookAt ( vLookAt  )

设置相机看的目标点坐标

参数
vLookAtXVECTOR3 看的目标点坐标
返回
void

◆ SetLookAtDistance()

function OrbitPanView SetLookAtDistance ( fVal  )

设置视点距离

参数
fValnumber 视点距离，默认为4.0f
返回
void

◆ SetMouseSensitivity()

function OrbitPanView SetMouseSensitivity ( fVal  )

设置鼠标敏感度

参数
fValnumber 敏感度大小，默认为0.2f
返回
void

◆ SetOwnerCameraParam()

function XEViewport SetOwnerCameraParam ( pCamera  )

设置该视口自己相机的属性

参数
pCameraXBaseCamera
返回
void

◆ SetPitchLimit()

function OrbitPanView SetPitchLimit ( fMinEulerRadian  ,
fMaxEulerRadian  ,
bEnable   
)

设置Pitch角（绕x轴，右方向，俯仰角）的范围

参数
fMinEulerRadiannumber Pitch的最小值
fMaxEulerRadiannumber Pitch的最大值
bEnableboolean 是否启用Pitch角限制
返回
void

◆ SetPrefabTextColor() [1/2]

function XEViewport SetPrefabTextColor ( color  )

设置视口附加渲染项中的Prefab信息的渲染颜色

参数
colorXCOLORBASE
返回
void

◆ SetPrefabTextColor() [2/2]

function XEViewport SetPrefabTextColor ( r  ,
g  ,
b  ,
a   
)

设置视口附加渲染项中的Prefab信息的渲染颜色

参数
rnumber
gnumber
bnumber
anumber
返回
void

◆ SetPresentWindow()

function XEViewport SetPresentWindow ( pWindow  )

设置该视口对应的窗口

参数
pWindowIXPlatformWindow
返回
void

◆ SetStatDisplayColor()

function XEViewport SetStatDisplayColor ( groupColor  ,
statColor   
)

XEViewport_SetStatDisplayColor00

参数
groupColorXCOLORBASE
statColorXCOLORBASE
返回
void

◆ SetStatInfo()

function XEViewport SetStatInfo ( strInfo  )

设置统计的单一信息, 当strInfo为空时，统计当前所有

参数
strInfostring
返回
void

◆ SetYawLimit()

function OrbitPanView SetYawLimit ( fMinEulerRadian  ,
fMaxEulerRadian  ,
bEnable   
)

设置Yaw角(绕y轴，上方向，偏航角)的范围

参数
fMinEulerRadiannumber Yaw的最小值
fMaxEulerRadiannumber Yaw的最大值
bEnableboolean 是否启用Yaw角限制
返回
void

◆ UpdateAttachedCameraAspect()

function XEViewport UpdateAttachedCameraAspect ( )

XEViewport_UpdateAttachedCameraAspect00

返回
void

◆ UpdateView()

function OrbitPanView UpdateView ( bUsingCallbackFunc  )

更新View

参数
bUsingCallbackFuncboolean 是否使用回调函数，如果为xtrue,相机看的目标点依赖于回调函数，默认为true
返回
void

变量说明

◆ OrbitPanView

OrbitPanView = {}
制作者 doxygen 1.9.6