XCameraViewFrustum.lua File Reference

Functions
function XCameraViewFrustum	new () end
function XCameraViewFrustum	new (frustum) end
function XCameraViewFrustum	Init (iNumPlane) end
function XCameraViewFrustum	Init (pCamera, fVLeft, fVTop, fVRight, fVBottom, bZClip) end
function XCameraViewFrustum	Init (pView, iSLeft, iSTop, iSRight, iSBottom, bZClip) end
function XCameraViewFrustum	Release () end
function XCameraViewFrustum	AddClipPlane (ClipCusPlane) end
function XCameraViewFrustum	AddClipPlane (vPanelNormal, fDistance) end
function XCameraViewFrustum	IsAABBInViewFrustum (vMins, vMaxs) end
function XCameraViewFrustum	IsAABBInViewFrustum (cusAABB) end
function XCameraViewFrustum	IsSphereInViewFrustum (vSphereCenter, fSphereRadius) end
function XCameraViewFrustum	IsPointInViewFrustum (vPoint) end
function XCameraViewFrustum	GetTemporaryPlanePointer (iPanelIndex) end
function XCameraViewFrustum	GetClipPlaneNum () end
function XCameraViewFrustum	EnableClipPlane (iPanelIndex, bEnable) end
function XCameraViewFrustum	IsClipPlaneEnable (iPanelIndex) end

Variables
	XCameraViewFrustum = {}
XCameraViewFrustum	XVF_LEFT = 0
XCameraViewFrustum	XVF_RIGHT = 0
XCameraViewFrustum	XVF_TOP = 0
XCameraViewFrustum	XVF_BOTTOM = 0
XCameraViewFrustum	XVF_NEAR = 0
XCameraViewFrustum	XVF_FAR = 0

Function Documentation

AddClipPlane() [1/2]

function XCameraViewFrustum AddClipPlane

(

ClipCusPlane

)

添加裁剪面

Parameters

ClipCusPlane

XCusSPlane 裁剪面信息

Returns

boolean 是否添加成功

AddClipPlane() [2/2]

function XCameraViewFrustum AddClipPlane	(	vPanelNormal	,
		fDistance
	)

添加裁剪面

Parameters

vPanelNormal	XVECTOR3 裁剪面法向量
fDistance	number 裁剪面距离原点距离

Returns

boolean 是否添加成功

EnableClipPlane()

function XCameraViewFrustum EnableClipPlane	(	iPanelIndex	,
		bEnable
	)

设置指定裁剪面是否有效

Parameters

iPanelIndex	number 裁剪面索引
bEnable	boolean 设置是否有效

Returns

void

GetClipPlaneNum()

function XCameraViewFrustum GetClipPlaneNum

(

)

获取裁剪面个数

Returns

number 裁剪面个数

GetTemporaryPlanePointer()

function XCameraViewFrustum GetTemporaryPlanePointer

(

iPanelIndex

)

获取某个裁剪平面对象指针

Parameters

iPanelIndex

number 裁剪面索引

Returns

XCusSPlane 裁剪面对象指针

Init() [1/3]

function XCameraViewFrustum Init

(

iNumPlane

)

初始化

Parameters

iNumPlane

number 平面个数

Returns

boolean 是否初始化成功

Init() [2/3]

function XCameraViewFrustum Init	(	pCamera	,
		fVLeft	,
		fVTop	,
		fVRight	,
		fVBottom	,
		bZClip
	)

初始化

Parameters

pCamera	XBaseCamera 相机对象
fVLeft	number 左平面到相机的距离
fVTop	number 上平面到相机的距离
fVRight	number 右平面到相机的距离
fVBottom	number 底平面到相机的距离
bZClip	boolean 远平面到相机的距离

Returns

boolean 是否初始化成功

Init() [3/3]

function XCameraViewFrustum Init	(	pView	,
		iSLeft	,
		iSTop	,
		iSRight	,
		iSBottom	,
		bZClip
	)

初始化

Parameters

pView	XViewport 视口对象
iSLeft	number 左平面到相机的距离
iSTop	number 上平面到相机的距离
iSRight	number 右平面到相机的距离
iSBottom	number 底平面到相机的距离
bZClip	boolean 远平面到相机的距离

Returns

boolean 是否初始化成功

IsAABBInViewFrustum() [1/2]

function XCameraViewFrustum IsAABBInViewFrustum	(	vMins	,
		vMaxs
	)

判断AABB包围盒是否在相机视椎体内

Parameters

vMins	XVECTOR3 AABB包围盒“最小”点
vMaxs	XVECTOR3 AABB包围盒“最大”点

Returns

number 返回1：AABB完全在视椎体内；返回0：AABB与视椎体相交；返回-1：AABB在视椎体外部

IsAABBInViewFrustum() [2/2]

function XCameraViewFrustum IsAABBInViewFrustum

(

cusAABB

)

判断AABB包围盒是否在相机视椎体内

Parameters

cusAABB

XCusAABB AABB包围盒信息

Returns

number 返回1：AABB完全在视椎体内；返回0：AABB与视椎体相交；返回-1：AABB在视椎体外部

IsClipPlaneEnable()

function XCameraViewFrustum IsClipPlaneEnable

(

iPanelIndex

)

判断指定裁剪面是否有效

Parameters

iPanelIndex

number 裁剪面索引

Returns

boolean 是否有效

IsPointInViewFrustum()

function XCameraViewFrustum IsPointInViewFrustum

(

vPoint

)

判断点是否在相机视椎体内

Parameters

vPoint

XVECTOR3 指定点坐标

Returns

boolean 如果在，返回xtrue，否则返回false.

IsSphereInViewFrustum()

function XCameraViewFrustum IsSphereInViewFrustum	(	vSphereCenter	,
		fSphereRadius
	)

判断球形是否在相机视椎体内

Parameters

vSphereCenter	XVECTOR3 球形中心点坐标
fSphereRadius	number 球形半径

Returns

number 返回1：球形完全在视椎体内；返回0：球形与视椎体相交；返回-1：球形在视椎体外部

new() [1/2]

function XCameraViewFrustum new

(

)

XCameraViewFrustum_new00

Returns

XCameraViewFrustum

new() [2/2]

function XCameraViewFrustum new

(

frustum

)

XCameraViewFrustum_new01

Parameters

frustum

XCameraViewFrustum

Returns

XCameraViewFrustum

Release()

function XCameraViewFrustum Release

(

)

释放

Returns

void

Variable Documentation

XCameraViewFrustum

XCameraViewFrustum = {}

XVF_BOTTOM

XCameraViewFrustum XVF_BOTTOM = 0

XVF_FAR

XCameraViewFrustum XVF_FAR = 0

XVF_LEFT

XCameraViewFrustum XVF_LEFT = 0

XVF_NEAR

XCameraViewFrustum XVF_NEAR = 0

XVF_RIGHT

XCameraViewFrustum XVF_RIGHT = 0

XVF_TOP

XCameraViewFrustum XVF_TOP = 0