类 XEViewport 继承关系图:

类 XEViewportManager 继承关系图:

Functions
function OrbitPanView	new (pVp) 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 XEViewport	GetVPTypeName (eType) end

function XEViewport	new (eType, pWindow, strName, fWindowScale) end

function XEViewport	Render () 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	GetRenderY () end

function XEViewport	GetViewportWidth () end

function XEViewport	GetViewportHeight () end

function XEViewport	GetOribitPanView () end

function XEViewport	GetWindowScale () 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

Variables
	OrbitPanView = {}

Function Documentation

◆ AttachCamera()

function XEViewport AttachCamera ( pAttachCamera )

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

Parameters

pAttachCamera XBaseCamera

Returns: void

◆ AttachToOwnerCamera()

function XEViewport AttachToOwnerCamera ( )

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

Returns: void

◆ AttachWorld()

function XEViewport AttachWorld ( pWorld )

该视口绑定一个世界

Parameters

pWorld XEWorld

Returns: void

◆ CreateXEViewport()

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

创建视口

Parameters

eType	number 视口类型
strName	string 视口名称
pWindow	IXPlatformWindow 视口相关联的窗口指针
fWindowScale	number 窗口的设备像素比

Returns: XEViewport 返回创建的视口指针

◆ DeleteXEViewport()

function XEViewportManager DeleteXEViewport ( strName )

删除视口

Parameters

strName string 视口名称

Returns: void

◆ GetAddRenderOption()

function XEViewport GetAddRenderOption ( )

获取当前视口的渲染选项

Returns: number

◆ GetAllXEViewports()

function XEViewportManager GetAllXEViewports ( pWin )

XEViewportManager_GetAllXEViewports00

Parameters

pWin	IXPlatformWindow

Returns: XEViewport[]

◆ GetAttachCamera()

function XEViewport GetAttachCamera ( )

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

Returns: XBaseCamera

◆ GetAttachWorld()

function XEViewport GetAttachWorld ( )

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

Returns: XEWorld

◆ GetLookAt()

function OrbitPanView GetLookAt ( )

获取相机看的目标点坐标

Returns: XVECTOR3 看的目标点坐标

◆ GetLookAtDistance()

function OrbitPanView GetLookAtDistance ( )

获取视点距离

Returns: number 视点距离

◆ GetMouseSensitivity()

function OrbitPanView GetMouseSensitivity ( )

获取鼠标敏感度

Returns: number 敏感度大小

◆ GetName()

function XEViewport GetName ( )

获取视口名称

Returns: string

◆ GetOribitPanView()

function XEViewport GetOribitPanView ( )

获取OrbitPanView指针

Returns: OrbitPanView

◆ GetOwnerCamera()

function XEViewport GetOwnerCamera ( )

获取场景相机指针

Returns: XBaseCamera

◆ GetPresentWindow()

function XEViewport GetPresentWindow ( )

获取该视口对应的窗口

Returns: IXPlatformWindow

◆ GetRefXEViewport()

function XEViewportManager GetRefXEViewport ( pCamera )

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

Parameters

pCamera XBaseCamera XBaseCamera指针

Returns: XEViewport[] 关联的XEViewport列表

◆ GetRenderY()

function XEViewport GetRenderY ( )

获取字体开始渲染的Y值

Returns: number

◆ GetStatDisplayColor()

function XEViewport GetStatDisplayColor	(	outGroupColor	,
		outStatColor
	)

XEViewport_GetStatDisplayColor00

Parameters

outGroupColor	XCOLORBASE
outStatColor	XCOLORBASE

Returns: void

◆ GetType()

function XEViewport GetType ( )

获取视口类型

Returns: number

◆ GetViewportHeight()

function XEViewport GetViewportHeight ( )

获取视口的高

Returns: number

◆ GetViewportWidth()

function XEViewport GetViewportWidth ( )

获取视口的宽

Returns: number

◆ GetVPTypeName()

function XEViewport GetVPTypeName ( eType )

获取视口类型对应的名称

Parameters

eType number 视口类型

Returns: string 视口类型对应的名称

◆ GetWindowScale()

function XEViewport GetWindowScale ( )

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

Returns: number

◆ GetWorkCamera()

function XEViewport GetWorkCamera ( )

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

Returns: XBaseCamera

◆ GetXEViewport() [1/6]

function XEViewportManager GetXEViewport ( strName )

通过名称获取视口

Parameters

strName string 视口名称

Returns: XEViewport 视口指针

◆ GetXEViewport() [2/6]

function XEViewportManager GetXEViewport ( pWorld )

通过世界指针获取视口

Parameters

pWorld XEWorld 世界指针

Returns: XEViewport 视口指针

◆ GetXEViewport() [3/6]

function XEViewportManager GetXEViewport	(	pWorld	,
		eViewportType
	)

XEViewportManager_GetXEViewport02

Parameters

pWorld	XEWorld
eViewportType	number

Returns: XEViewport

◆ GetXEViewport() [4/6]

function XEViewportManager GetXEViewport ( pWin )

通过窗口获取视口

Parameters

pWin	IXPlatformWindow 窗口指针

Returns: XEViewport 视口指针

◆ GetXEViewport() [5/6]

function XEViewportManager GetXEViewport	(	pWin	,
		eViewportType
	)

XEViewportManager_GetXEViewport04

Parameters

pWin	IXPlatformWindow
eViewportType	number

Returns: XEViewport

◆ GetXEViewport() [6/6]

function XEViewportManager GetXEViewport ( pViewPort )

通过底层XViewport指针获取XEViewport

Parameters

pViewPort XViewport XViewport指针

Returns: XEViewport XEViewport视口指针

◆ GetXEViewportByWorldName()

function XEViewportManager GetXEViewportByWorldName ( strWorldName )

通过WorldName获取关联的XEViewport指针

Parameters

strWorldName string WorldName

Returns: XEViewport XEViewport指针

◆ GetXViewport()

function XEViewport GetXViewport ( )

获取引擎视口指针

Returns: XViewport

◆ IsActive()

function XEViewport IsActive ( )

判断是否是激活状态

Returns: boolean

◆ new() [1/2]

function OrbitPanView new ( pVp )

OrbitPanView_new00

Parameters

pVp	XEViewport

Returns: OrbitPanView

◆ new() [2/2]

function XEViewport new	(	eType	,
		pWindow	,
		strName	,
		fWindowScale
	)

XEViewport_new00

Parameters

eType	number
pWindow	IXPlatformWindow
strName	string
fWindowScale	number

Returns: XEViewport

◆ RatateAround()

function OrbitPanView RatateAround	(	nDeltaX	,
		nDeltaY
	)

绕关注点旋转相机

Parameters

nDeltaX	number Pitch角的鼠标偏移值
nDeltaY	number Yaw角的鼠标偏移值

Returns: void

◆ Render()

function XEViewport Render ( )

渲染该视口对应的世界，以及附加渲染选项

Returns: void

◆ Resize() [1/3]

function XEViewport Resize ( )

调整大小

Returns: void

◆ Resize() [2/3]

function XEViewport Resize	(	nWidth	,
		nHeight
	)

XEViewport_Resize01

Parameters

nWidth	number
nHeight	number

Returns: void

◆ Resize() [3/3]

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

XEViewport_Resize02

Parameters

nX	number
nY	number
nWidth	number
nHeight	number

Returns: void

◆ SetActive()

function XEViewport SetActive ( bActive )

设置激活状态

Parameters

bActive boolean

Returns: void

◆ SetAddRenderOption()

function XEViewport SetAddRenderOption ( nOption )

设置当前视口的渲染选项

Parameters

nOption number

Returns: void

◆ SetCameraPosTextColor() [1/2]

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

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

Parameters

r	number
g	number
b	number
a	number

Returns: void

◆ SetCameraPosTextColor() [2/2]

function XEViewport SetCameraPosTextColor ( color )

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

Parameters

color XCOLORBASE

Returns: void

◆ SetFpsRenderPos()

function XEViewport SetFpsRenderPos ( FpsRenderpos )

设置fps渲染位置

Parameters

FpsRenderpos number

Returns: void

◆ SetFpsTextColor() [1/2]

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

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

Parameters

r	number
g	number
b	number
a	number

Returns: void

◆ SetFpsTextColor() [2/2]

function XEViewport SetFpsTextColor ( color )

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

Parameters

color XCOLORBASE

Returns: void

◆ SetLookAt()

function OrbitPanView SetLookAt ( vLookAt )

设置相机看的目标点坐标

Parameters

vLookAt XVECTOR3 看的目标点坐标

Returns: void

◆ SetLookAtDistance()

function OrbitPanView SetLookAtDistance ( fVal )

设置视点距离

Parameters

fVal	number 视点距离，默认为4.0f

Returns: void

◆ SetMouseSensitivity()

function OrbitPanView SetMouseSensitivity ( fVal )

设置鼠标敏感度

Parameters

fVal	number 敏感度大小，默认为0.2f

Returns: void

◆ SetOwnerCameraParam()

function XEViewport SetOwnerCameraParam ( pCamera )

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

Parameters

pCamera XBaseCamera

Returns: void

◆ SetPitchLimit()

function OrbitPanView SetPitchLimit	(	fMinEulerRadian	,
		fMaxEulerRadian	,
		bEnable
	)

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

Parameters

fMinEulerRadian	number Pitch的最小值
fMaxEulerRadian	number Pitch的最大值
bEnable	boolean 是否启用Pitch角限制

Returns: void

◆ SetPresentWindow()

function XEViewport SetPresentWindow ( pWindow )

设置该视口对应的窗口

Parameters

pWindow IXPlatformWindow

Returns: void

◆ SetStatDisplayColor()

function XEViewport SetStatDisplayColor	(	groupColor	,
		statColor
	)

XEViewport_SetStatDisplayColor00

Parameters

groupColor	XCOLORBASE
statColor	XCOLORBASE

Returns: void

◆ SetYawLimit()

function OrbitPanView SetYawLimit	(	fMinEulerRadian	,
		fMaxEulerRadian	,
		bEnable
	)

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

Parameters

fMinEulerRadian	number Yaw的最小值
fMaxEulerRadian	number Yaw的最大值
bEnable	boolean 是否启用Yaw角限制

Returns: void

◆ UpdateAttachedCameraAspect()

function XEViewport UpdateAttachedCameraAspect ( )

XEViewport_UpdateAttachedCameraAspect00

Returns: void

◆ UpdateView()

function OrbitPanView UpdateView ( bUsingCallbackFunc )

更新View

Parameters

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

Returns: void

Variable Documentation

◆ OrbitPanView

OrbitPanView = {}

Functions

Variables

Function Documentation

◆ AttachCamera()

◆ AttachToOwnerCamera()

◆ AttachWorld()

◆ CreateXEViewport()

◆ DeleteXEViewport()

◆ GetAddRenderOption()

◆ GetAllXEViewports()

◆ GetAttachCamera()

◆ GetAttachWorld()

◆ GetLookAt()

◆ GetLookAtDistance()

◆ GetMouseSensitivity()

◆ GetName()

◆ GetOribitPanView()

◆ GetOwnerCamera()

◆ GetPresentWindow()

◆ GetRefXEViewport()

◆ GetRenderY()

◆ GetStatDisplayColor()

◆ GetType()

◆ GetViewportHeight()

◆ GetViewportWidth()

◆ GetVPTypeName()

◆ GetWindowScale()

◆ GetWorkCamera()

◆ GetXEViewport() [1/6]

◆ GetXEViewport() [2/6]

◆ GetXEViewport() [3/6]

◆ GetXEViewport() [4/6]

◆ GetXEViewport() [5/6]

◆ GetXEViewport() [6/6]

◆ GetXEViewportByWorldName()

◆ GetXViewport()

◆ IsActive()

◆ new() [1/2]

◆ new() [2/2]

◆ RatateAround()

◆ Render()

◆ Resize() [1/3]

◆ Resize() [2/3]

◆ Resize() [3/3]

◆ SetActive()

◆ SetAddRenderOption()

◆ SetCameraPosTextColor() [1/2]

◆ SetCameraPosTextColor() [2/2]

◆ SetFpsRenderPos()

◆ SetFpsTextColor() [1/2]

◆ SetFpsTextColor() [2/2]

◆ SetLookAt()

◆ SetLookAtDistance()

◆ SetMouseSensitivity()

◆ SetOwnerCameraParam()

◆ SetPitchLimit()

◆ SetPresentWindow()

◆ SetStatDisplayColor()

◆ SetYawLimit()

◆ UpdateAttachedCameraAspect()

◆ UpdateView()

Variable Documentation

◆ OrbitPanView