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

Functions

function XECameraComponent new () end
 
function XECameraComponent Release () end
 
function XECameraComponent UpdateForSerialize () end
 
function XECameraComponent Tick (fDel, bForceTick) end
 
function XECameraComponent SetAsPerspectiveCamera () end
 
function XECameraComponent SetAsPerspectiveCamera (fFov, fZNear, fZFar, fRatio) end
 
function XECameraComponent SetASOrthoCamera (fLeft, fRight, fBottom, fTop, fZNear, fZFar) end
 
function XECameraComponent IsSystemCamera () end
 
function XECameraComponent ApplyAsSystemCamera () end
 
function XECameraComponent SwitchProjectModel (eModel) end
 
function XECameraComponent GetSystemCamera (pWorldContext) end
 
function XECameraComponent GetCamera () end
 
function XECameraComponent IsPerspectiveCamera () end
 
function XECameraComponent IsOrthoCamera () end
 
function XECameraComponent IsActiveCamera () end
 
function XECameraComponent SetActiveCamera (bActive) end
 
function XECameraComponent SetZNear (fZNear, bUpdateProjMat) end
 
function XECameraComponent SetZFar (fZFar, bUpdateProjMat) end
 
function XECameraComponent SetFov (fFov) end
 
function XECameraComponent GetZFar () end
 
function XECameraComponent GetZNear () end
 
function XECameraComponent GetFov () end
 
function XECameraComponent SetOrthoWidth (fOrthoWidth) end
 
function XECameraComponent GetOrthoWidth () end
 

Variables

 XECameraComponent = {}
 
XECameraComponent XEPM_PERSPECTIVE = 0
 
XECameraComponent XEPM_ORTHO = 0
 

Function Documentation

◆ ApplyAsSystemCamera()

function XECameraComponent ApplyAsSystemCamera ( )

将当前组件内记录的相机指针与视口绑定，这是将当前组件内记录的相机在场景中起作用的前提

Returns
boolean 判断当前组件内记录的相机是否与视口绑定成功

◆ GetCamera()

function XECameraComponent GetCamera ( )

获取当前组件内记录的相机指针

Returns
XBaseCamera

◆ GetFov()

function XECameraComponent GetFov ( )

获取当前组件内记录的相机的视角

Returns
number

◆ GetOrthoWidth()

function XECameraComponent GetOrthoWidth ( )

获取正交投影的视椎体的近裁剪面的宽

Returns
number

◆ GetSystemCamera()

function XECameraComponent GetSystemCamera ( pWorldContext  )

获取某个世界的场景相机

Parameters
pWorldContextXEWorld
Returns
XBaseCamera

◆ GetZFar()

function XECameraComponent GetZFar ( )

获取当前组件内记录的相机的远裁剪面

Returns
number

◆ GetZNear()

function XECameraComponent GetZNear ( )

获取当前组件内记录的相机的近裁剪面

Returns
number

◆ IsActiveCamera()

function XECameraComponent IsActiveCamera ( )

判断当前组件内记录的相机是否处于激活状态，即是否在场景中起作用

Returns
boolean

◆ IsOrthoCamera()

function XECameraComponent IsOrthoCamera ( )

判断当前组件内记录的相机是否是正交投影

Returns
boolean

◆ IsPerspectiveCamera()

function XECameraComponent IsPerspectiveCamera ( )

判断当前组件内记录的相机是否是透视投影

Returns
boolean

◆ IsSystemCamera()

function XECameraComponent IsSystemCamera ( )

判断当前组件内记录的相机是否是场景中起作用的相机

Returns
boolean

◆ new()

function XECameraComponent new ( )

XECameraComponent_new00

Returns
XECameraComponent

◆ Release()

function XECameraComponent Release ( )

释放资源

Returns
void

◆ SetActiveCamera()

function XECameraComponent SetActiveCamera ( bActive  )

设置当前组件内记录的相机的激活状态，即是否在场景中起作用

Parameters
bActiveboolean
Returns
void

◆ SetASOrthoCamera()

function XECameraComponent SetASOrthoCamera ( fLeft  ,
fRight  ,
fBottom  ,
fTop  ,
fZNear  ,
fZFar   
)

创建正交投影的相机(XOrthoCamera，引擎中封装的对象),并分别设置视景体左平面、右平面、上平面、下平面、近平面、远平面到相机的距离。 正交投影的视椎体是一个长方体或立方体，拥有六个平面。

Parameters
fLeftnumber 正交投影时，视椎体左平面到相机的距离。
fRightnumber 正交投影时，视椎体右平面到相机的距离。
fBottomnumber 正交投影时，视椎体下平面到相机的距离。
fTopnumber 正交投影时，视椎体上平面到相机的距离。
fZNearnumber 正交投影时，视椎体近平面到相机的距离。
fZFarnumber 正交投影时，视椎体远平面到相机的距离。
Returns
XOrthoCamera 创建成功的正交投影的相机指针.

◆ SetAsPerspectiveCamera() [1/2]

function XECameraComponent SetAsPerspectiveCamera ( )

创建透视投影的相机(XPerspectiveCamera，引擎中封装的对象),并设置相机的视角(FOV)、远近裁剪平面(NEAR/FAR)和视口宽高比（Ratio）。 透视投影的视椎体是个平截头体，位于视椎体内的物体才能被“看到”。

Returns
XPerspectiveCamera 创建成功的透视投影的相机指针.

◆ SetAsPerspectiveCamera() [2/2]

function XECameraComponent SetAsPerspectiveCamera ( fFov  ,
fZNear  ,
fZFar  ,
fRatio   
)

XECameraComponent_SetAsPerspectiveCamera01

Parameters
fFovnumber
fZNearnumber
fZFarnumber
fRationumber
Returns
XPerspectiveCamera

◆ SetFov()

function XECameraComponent SetFov ( fFov  )

设置当前组件内记录的相机的视角

Parameters
fFovnumber
Returns
boolean

◆ SetOrthoWidth()

function XECameraComponent SetOrthoWidth ( fOrthoWidth  )

设置正交投影的视椎体的近裁剪面的宽

Parameters
fOrthoWidthnumber
Returns
boolean

◆ SetZFar()

function XECameraComponent SetZFar ( fZFar  ,
bUpdateProjMat   
)

设置当前组件内记录的相机的远裁剪面

Parameters
fZFarnumber
bUpdateProjMatboolean
Returns
boolean

◆ SetZNear()

function XECameraComponent SetZNear ( fZNear  ,
bUpdateProjMat   
)

设置当前组件内记录的相机的近裁剪面

Parameters
fZNearnumber
bUpdateProjMatboolean
Returns
boolean

◆ SwitchProjectModel()

function XECameraComponent SwitchProjectModel ( eModel  )

将当前组件内记录的相机的投影方式改为 eModel 类型

Parameters
eModelnumber 相机的投影方式（正交投影/透视投影）
Returns
boolean

◆ Tick()

function XECameraComponent Tick ( fDel  ,
bForceTick   
)

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

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

◆ UpdateForSerialize()

function XECameraComponent UpdateForSerialize ( )

更新相机矩阵

Returns
void

Variable Documentation

◆ XECameraComponent

XECameraComponent = {}

◆ XEPM_ORTHO

XECameraComponent XEPM_ORTHO = 0

◆ XEPM_PERSPECTIVE

XECameraComponent XEPM_PERSPECTIVE = 0
Generated by   doxygen 1.8.15