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

Functions

function XELightComponent new () end
 
function XELightComponent Release () end
 
function XELightComponent Render (pViewport) end
 
function XELightComponent SetAsDirLight (color, vDir, fLuminance) end
 
function XELightComponent SetAsEnvLight (color, index, fLuminance) end
 
function XELightComponent SetAsPointLight (desc) end
 
function XELightComponent SetAsSpotLight (desc) end
 
function XELightComponent SetLightRadius (fRadius) end
 
function XELightComponent SetLightFallOffExponent (fFallOffExponent) end
 
function XELightComponent SetLightConeInnerAngle (fAngle) end
 
function XELightComponent SetLightConeOuterAngle (fAngle) end
 
function XELightComponent GetDirLightDir () end
 
function XELightComponent GetLightColor () end
 
function XELightComponent SetLightColor (color) end
 
function XELightComponent GetLightLuminance () end
 
function XELightComponent SetLightLuminance (fLuminance) end
 
function XELightComponent GetLight () end
 
function XELightComponent GetLightIndex () end
 
function XELightComponent IsLightReady () end
 

Variables

 XELightComponent = {}
 

Function Documentation

◆ GetDirLightDir()

function XELightComponent GetDirLightDir ( )

获取平行光（也叫方向光）的方向

Returns
XVECTOR3

◆ GetLight()

function XELightComponent GetLight ( )

获取引擎封装的光源对象

Returns
IXLightBase

◆ GetLightColor()

function XELightComponent GetLightColor ( )

获取光源颜色

Returns
XCOLORBASE

◆ GetLightIndex()

function XELightComponent GetLightIndex ( )

获取环境光索引

Returns
number

◆ GetLightLuminance()

function XELightComponent GetLightLuminance ( )

获取光照强度

Returns
number

◆ IsLightReady()

function XELightComponent IsLightReady ( )

光照是否准备好

Returns
boolean

◆ new()

function XELightComponent new ( )

XELightComponent_new00

Returns
XELightComponent

◆ Release()

function XELightComponent Release ( )

释放资源

Returns
void

◆ Render()

function XELightComponent Render ( pViewport  )

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

Parameters
pViewportXEViewport
Returns
void

◆ SetAsDirLight()

function XELightComponent SetAsDirLight ( color  ,
vDir  ,
fLuminance   
)

创建引擎中封装的代表平行光的 IXLightBase 对象，并设置光源颜色、方向和强度

Parameters
colorXCOLORBASE 光源颜色
vDirXVECTOR3 平行光的方向，单位化的向量
fLuminancenumber 光照强度
Returns
void

◆ SetAsEnvLight()

function XELightComponent SetAsEnvLight ( color  ,
index  ,
fLuminance   
)

创建引擎中封装的代表环境光的 IXLightBase 对象，并设置光源颜色、索引和强度

Parameters
colorXCOLORBASE 光源颜色
indexnumber 环境光的索引，目前引擎仅支持两个环境光
fLuminancenumber 光照强度
Returns
void

◆ SetAsPointLight()

function XELightComponent SetAsPointLight ( desc  )

创建引擎中封装的代表点光源的 IXLightBase 对象，并设置光源参数

Parameters
descXPointLightDesc 点光源参数结构体
Returns
void

◆ SetAsSpotLight()

function XELightComponent SetAsSpotLight ( desc  )

创建引擎中封装的代表聚光源的 IXLightBase 对象，并设置光源参数

Parameters
descXSpotLightDesc 聚光源参数结构体
Returns
void

◆ SetLightColor()

function XELightComponent SetLightColor ( color  )

设置光源颜色

Parameters
colorXCOLORBASE
Returns
boolean

◆ SetLightConeInnerAngle()

function XELightComponent SetLightConeInnerAngle ( fAngle  )

对于聚光源，可以设置光源内锥角

Parameters
fAnglenumber 角度
Returns
void

◆ SetLightConeOuterAngle()

function XELightComponent SetLightConeOuterAngle ( fAngle  )

对于聚光源，可以设置光源外锥角

Parameters
fAnglenumber 角度
Returns
void

◆ SetLightFallOffExponent()

function XELightComponent SetLightFallOffExponent ( fFallOffExponent  )

对于点光源或者聚光源，可以设置光源衰减值

Parameters
fFallOffExponentnumber 光源衰减值
Returns
void

◆ SetLightLuminance()

function XELightComponent SetLightLuminance ( fLuminance  )

设置光照强度

Parameters
fLuminancenumber
Returns
boolean

◆ SetLightRadius()

function XELightComponent SetLightRadius ( fRadius  )

对于点光源或者聚光源，可以设置光源半径

Parameters
fRadiusnumber 光源半径
Returns
void

Variable Documentation

◆ XELightComponent

XELightComponent = {}
Generated by   doxygen 1.8.15