Skip to content

RoyInterface / Exports / component/RoyCameraComponent / RoyCameraComponent

Class: RoyCameraComponent

component/RoyCameraComponent.RoyCameraComponent

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new RoyCameraComponent(node, transDataInfo?): RoyCameraComponent

Parameters

NameType
nodeRoySceneNode
transDataInfo?RoyTransDataInfo

Returns

RoyCameraComponent

Overrides

RoyComponent.constructor

Properties

cacheMat4

Static cacheMat4: Mat4


CLASS_NAME

Static CLASS_NAME: string = 'RoyCameraComponent'


m_camera

Private m_camera: RoyCamera3D


m_renderPriority

Private m_renderPriority: number = 2


m_isSnapShoot

Private m_isSnapShoot: boolean = false


m_drawWireframe

Private m_drawWireframe: boolean = false


m_forceRender

Private m_forceRender: boolean = false


m_viewMatrixDirty

Private m_viewMatrixDirty: boolean = true


s_handleID

Static Protected s_handleID: number = 0

Inherited from

RoyComponent.s_handleID


m_handleID

Protected m_handleID: number = 0

Inherited from

RoyComponent.m_handleID


m_sceneNode

Protected m_sceneNode: RoySceneNode

Inherited from

RoyComponent.m_sceneNode


m_name

Protected m_name: string = ''

Inherited from

RoyComponent.m_name


m_compTypeName

Protected m_compTypeName: string = ''

Inherited from

RoyComponent.m_compTypeName


m_compClassifyType

Protected m_compClassifyType: RoyComponentClassifyType = RoyComponentClassifyType.CCT_LOGIC

Inherited from

RoyComponent.m_compClassifyType


m_requireDirtyBox

Protected m_requireDirtyBox: boolean = false

Inherited from

RoyComponent.m_requireDirtyBox


m_requireUpdatePriority

Protected m_requireUpdatePriority: number = 0

Inherited from

RoyComponent.m_requireUpdatePriority


m_requireUpdate

Protected m_requireUpdate: boolean = false

Inherited from

RoyComponent.m_requireUpdate


m_visibleLayer

Protected m_visibleLayer: number = RoyLayer.Base

Inherited from

RoyComponent.m_visibleLayer


m_mouseEnabled

Protected m_mouseEnabled: boolean = false

Inherited from

RoyComponent.m_mouseEnabled


m_mouseEnabledOnInvisible

Protected m_mouseEnabledOnInvisible: boolean = false

Inherited from

RoyComponent.m_mouseEnabledOnInvisible


m_occlusionEnabled

Protected m_occlusionEnabled: boolean = false

Inherited from

RoyComponent.m_occlusionEnabled


m_boundBoxValid

Protected m_boundBoxValid: boolean = true

Inherited from

RoyComponent.m_boundBoxValid


m_boundBox

Protected m_boundBox: AABB

Inherited from

RoyComponent.m_boundBox


m_userData

Protected m_userData: object = {}

Inherited from

RoyComponent.m_userData


m_gizmoItem

Protected m_gizmoItem: RoyGizmoItem

Inherited from

RoyComponent.m_gizmoItem


m_transDataInfo

Protected m_transDataInfo: RoyTransDataInfo

Inherited from

RoyComponent.m_transDataInfo


m_canTransfer

Protected m_canTransfer: boolean = true

Inherited from

RoyComponent.m_canTransfer

Accessors

camera

get camera(): RoyCamera3D

Returns

RoyCamera3D


rendererType

get rendererType(): RendererType

Returns

RendererType

set rendererType(value): void

Parameters

NameType
valueRendererType

Returns

void


visibleLayer

get visibleLayer(): number

Returns

number

Overrides

RoyComponent.visibleLayer

set visibleLayer(value): void

Parameters

NameType
valuenumber

Returns

void

Overrides

RoyComponent.visibleLayer


renderTarget

set renderTarget(renderTarget): void

Parameters

NameType
renderTargetRoyRenderTarget

Returns

void


renderPriority

get renderPriority(): number

Returns

number

set renderPriority(renderPriority): void

Parameters

NameType
renderPrioritynumber

Returns

void


presentCamera

get presentCamera(): boolean

Returns

boolean

set presentCamera(value): void

Parameters

NameType
valueboolean

Returns

void


renderCallback

get renderCallback(): RenderCallbackInfo

Returns

RenderCallbackInfo

set renderCallback(value): void

Parameters

NameType
valueRenderCallbackInfo

Returns

void


viewExecStrategy

get viewExecStrategy(): ViewExecutionStrategy

Returns

ViewExecutionStrategy

set viewExecStrategy(value): void

Parameters

NameType
valueViewExecutionStrategy

Returns

void


tintCorrection

get tintCorrection(): boolean

Returns

boolean

set tintCorrection(value): void

Parameters

NameType
valueboolean

Returns

void


physicalCameraOptions

get physicalCameraOptions(): PhysicalCameraOptions

Returns

PhysicalCameraOptions

set physicalCameraOptions(value): void

Parameters

NameType
valuePhysicalCameraOptions

Returns

void


renderScale

get renderScale(): number

Returns

number

set renderScale(value): void

Parameters

NameType
valuenumber

Returns

void


noBufferPadding

get noBufferPadding(): boolean

Returns

boolean

set noBufferPadding(value): void

Parameters

NameType
valueboolean

Returns

void


bloomOption

get bloomOption(): View$BloomOptions

Returns

View$BloomOptions

set bloomOption(value): void

Parameters

NameType
valueView$BloomOptions

Returns

void


ssReflectionsOption

get ssReflectionsOption(): View$ScreenSpaceReflectionsOptions

Returns

View$ScreenSpaceReflectionsOptions

set ssReflectionsOption(value): void

Parameters

NameType
valueView$ScreenSpaceReflectionsOptions

Returns

void


ssRefractionEnabled

get ssRefractionEnabled(): boolean

Returns

boolean

set ssRefractionEnabled(value): void

Parameters

NameType
valueboolean

Returns

void


isGrabDepthBlur

get isGrabDepthBlur(): boolean

Returns

boolean

set isGrabDepthBlur(value): void

Parameters

NameType
valueboolean

Returns

void


ambientOcclusionOptions

get ambientOcclusionOptions(): View$AmbientOcclusionOptions

Returns

View$AmbientOcclusionOptions

set ambientOcclusionOptions(value): void

Parameters

NameType
valueView$AmbientOcclusionOptions

Returns

void


dynamicResolutionOptions

get dynamicResolutionOptions(): View$DynamicResolutionOptions

Returns

View$DynamicResolutionOptions

set dynamicResolutionOptions(value): void

Parameters

NameType
valueView$DynamicResolutionOptions

Returns

void


depthOfFieldOptions

get depthOfFieldOptions(): View$DepthOfFieldOptions

Returns

View$DepthOfFieldOptions

set depthOfFieldOptions(value): void

Parameters

NameType
valueView$DepthOfFieldOptions

Returns

void


multiSampleAntiAliasingOptions

get multiSampleAntiAliasingOptions(): View$MultiSampleAntiAliasingOptions

Returns

View$MultiSampleAntiAliasingOptions

set multiSampleAntiAliasingOptions(value): void

Parameters

NameType
valueView$MultiSampleAntiAliasingOptions

Returns

void


temporalAntiAliasingOptions

get temporalAntiAliasingOptions(): View$TemporalAntiAliasingOptions

Returns

View$TemporalAntiAliasingOptions

set temporalAntiAliasingOptions(value): void

Parameters

NameType
valueView$TemporalAntiAliasingOptions

Returns

void


fogOptions

get fogOptions(): View$FogOptions

Returns

View$FogOptions

set fogOptions(value): void

Parameters

NameType
valueView$FogOptions

Returns

void


vignetteOptions

get vignetteOptions(): View$VignetteOptions

Returns

View$VignetteOptions

set vignetteOptions(value): void

Parameters

NameType
valueView$VignetteOptions

Returns

void


guardBandOptions

get guardBandOptions(): View$GuardBandOptions

Returns

View$GuardBandOptions

set guardBandOptions(value): void

Parameters

NameType
valueView$GuardBandOptions

Returns

void


colorGradingOptions

get colorGradingOptions(): ColorGradingOptions

Returns

ColorGradingOptions

set colorGradingOptions(value): void

Parameters

NameType
valueColorGradingOptions

Returns

void


selectFocusOptions

get selectFocusOptions(): SelectFocusOptions

Returns

SelectFocusOptions

set selectFocusOptions(value): void

Parameters

NameType
valueSelectFocusOptions

Returns

void


rayTraceOptions

get rayTraceOptions(): RayTraceOptions

Returns

RayTraceOptions

set rayTraceOptions(value): void

Parameters

NameType
valueRayTraceOptions

Returns

void


rayTraceNoiseData

set rayTraceNoiseData(value): void

Parameters

NameType
valueUint8Array

Returns

void


shadowType

get shadowType(): View$ShadowType

Returns

View$ShadowType

set shadowType(value): void

Parameters

NameType
valueView$ShadowType

Returns

void


vsmShadowOptions

get vsmShadowOptions(): View$VsmShadowOptions

Returns

View$VsmShadowOptions

set vsmShadowOptions(value): void

Parameters

NameType
valueView$VsmShadowOptions

Returns

void


softShadowOptions

get softShadowOptions(): View$SoftShadowOptions

Returns

View$SoftShadowOptions

set softShadowOptions(value): void

Parameters

NameType
valueView$SoftShadowOptions

Returns

void


clippingPlanesOptions

get clippingPlanesOptions(): View$ClippingPlanesOptions

Returns

View$ClippingPlanesOptions

set clippingPlanesOptions(value): void

Parameters

NameType
valueView$ClippingPlanesOptions

Returns

void


setAlphaToOne

get setAlphaToOne(): boolean

Returns

boolean

set setAlphaToOne(value): void

Parameters

NameType
valueboolean

Returns

void


blendMode

get blendMode(): View$BlendMode

Returns

View$BlendMode

set blendMode(value): void

Parameters

NameType
valueView$BlendMode

Returns

void


viewRect

get viewRect(): number[]

Returns

number[]

set viewRect(value): void

Parameters

NameType
valuenumber[]

Returns

void


displayScreenRadio

get displayScreenRadio(): number

Returns

number

set displayScreenRadio(value): void

Parameters

NameType
valuenumber

Returns

void


bestEffect

get bestEffect(): boolean

Returns

boolean


clearColor

get clearColor(): number[]

Returns

number[]

set clearColor(value): void

Parameters

NameType
valuenumber[]

Returns

void


draftClearColor

get draftClearColor(): number[]

Returns

number[]

set draftClearColor(value): void

Parameters

NameType
valuenumber[]

Returns

void


clearBackBufferOptions

get clearBackBufferOptions(): Renderer$ClearOptions

Returns

Renderer$ClearOptions

set clearBackBufferOptions(value): void

Parameters

NameType
valueRenderer$ClearOptions

Returns

void


effectMode

get effectMode(): CameraEffectMode

Returns

CameraEffectMode

set effectMode(value): void

Parameters

NameType
valueCameraEffectMode

Returns

void


effectIgnoreDRO

get effectIgnoreDRO(): boolean

Returns

boolean

set effectIgnoreDRO(value): void

Parameters

NameType
valueboolean

Returns

void


renderLevel

get renderLevel(): RendererLevel

Returns

RendererLevel

set renderLevel(value): void

Parameters

NameType
valueRendererLevel

Returns

void


frontFaceWindingInverted

get frontFaceWindingInverted(): boolean

Returns

boolean

set frontFaceWindingInverted(value): void

Parameters

NameType
valueboolean

Returns

void


frontFaceWindingAutoInverted

get frontFaceWindingAutoInverted(): boolean

Returns

boolean

set frontFaceWindingAutoInverted(value): void

Parameters

NameType
valueboolean

Returns

void


snapImageOptions

get snapImageOptions(): SnapImageOptions

Returns

SnapImageOptions

set snapImageOptions(value): void

Parameters

NameType
valueSnapImageOptions

Returns

void


snapRTObjectOptions

get snapRTObjectOptions(): SnapRTOptions

Returns

SnapRTOptions

set snapRTObjectOptions(value): void

Parameters

NameType
valueSnapRTOptions

Returns

void


drawWireframe

get drawWireframe(): boolean

Returns

boolean

set drawWireframe(value): void

Parameters

NameType
valueboolean

Returns

void


forceRender

get forceRender(): boolean

Returns

boolean

set forceRender(value): void

Parameters

NameType
valueboolean

Returns

void


projectType

get projectType(): RoyCameraProjType

Returns

RoyCameraProjType


fov

get fov(): number

Returns

number


near

get near(): number

Returns

number


far

get far(): number

Returns

number


width

get width(): number

Returns

number


height

get height(): number

Returns

number


eye

get eye(): Vec3

Returns

Vec3


dir

get dir(): Vec3

Returns

Vec3


viewMat

get viewMat(): Mat4

Returns

Mat4


projMat

get projMat(): Mat4

Returns

Mat4


handleID

get handleID(): number

Returns

number

Inherited from

RoyComponent.handleID


sceneNode

get sceneNode(): RoySceneNode

Returns

RoySceneNode

Inherited from

RoyComponent.sceneNode


name

get name(): string

Returns

string

Inherited from

RoyComponent.name

set name(value): void

Parameters

NameType
valuestring

Returns

void

Inherited from

RoyComponent.name


compTypeName

get compTypeName(): string

Returns

string

Inherited from

RoyComponent.compTypeName


compClassifyType

get compClassifyType(): RoyComponentClassifyType

Returns

RoyComponentClassifyType

Inherited from

RoyComponent.compClassifyType


requireDirtyBox

get requireDirtyBox(): boolean

Returns

boolean

Inherited from

RoyComponent.requireDirtyBox


requireUpdatePriority

get requireUpdatePriority(): number

Returns

number

Inherited from

RoyComponent.requireUpdatePriority


requireUpdate

get requireUpdate(): boolean

Returns

boolean

Inherited from

RoyComponent.requireUpdate


enabled

get enabled(): boolean

Returns

boolean

Inherited from

RoyComponent.enabled

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RoyComponent.enabled


mouseEnabled

get mouseEnabled(): boolean

Returns

boolean

Inherited from

RoyComponent.mouseEnabled

set mouseEnabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RoyComponent.mouseEnabled


mouseEnabledOnInvisible

get mouseEnabledOnInvisible(): boolean

Returns

boolean

Inherited from

RoyComponent.mouseEnabledOnInvisible

set mouseEnabledOnInvisible(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RoyComponent.mouseEnabledOnInvisible


occlusionEnabled

get occlusionEnabled(): boolean

Returns

boolean

Inherited from

RoyComponent.occlusionEnabled

set occlusionEnabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RoyComponent.occlusionEnabled


boundBoxValid

get boundBoxValid(): boolean

Returns

boolean

Inherited from

RoyComponent.boundBoxValid

set boundBoxValid(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RoyComponent.boundBoxValid


boundBox

get boundBox(): AABB

Returns

AABB

Inherited from

RoyComponent.boundBox


gizmoItem

get gizmoItem(): RoyGizmoItem

Returns

RoyGizmoItem

Inherited from

RoyComponent.gizmoItem


transDataInfo

get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Inherited from

RoyComponent.transDataInfo


canTransfer

get canTransfer(): boolean

Returns

boolean

Inherited from

RoyComponent.canTransfer

Methods

setClearTargets

setClearTargets(color, depth, stencil): void

Parameters

NameType
colorboolean
depthboolean
stencilboolean

Returns

void


markViewMatrixDirty

markViewMatrixDirty(): void

Returns

void


snapShoot

snapShoot(): void

Returns

void


destroy

destroy(): void

Returns

void

Overrides

RoyComponent.destroy


onAddToScene

onAddToScene(): void

Returns

void

Overrides

RoyComponent.onAddToScene


onRemoveFromScene

onRemoveFromScene(): void

Returns

void

Overrides

RoyComponent.onRemoveFromScene


setParamDirty

setParamDirty(value): void

Parameters

NameType
valueViewDirtyFlag

Returns

void


setProjectionPerspective

setProjectionPerspective(fov, pw, ph, near, far, fovDirection): void

Parameters

NameType
fovnumber
pwnumber
phnumber
nearnumber
farnumber
fovDirectionnumber

Returns

void


setProjectionOrtho

setProjectionOrtho(pw, ph, near, far, orthoViewScale): void

Parameters

NameType
pwnumber
phnumber
nearnumber
farnumber
orthoViewScalenumber

Returns

void


setViewMat

setViewMat(viewMat, worldMat?): void

Parameters

NameType
viewMatMat4
worldMat?Mat4

Returns

void


getWorldPickingRayByScreenXY

getWorldPickingRayByScreenXY(screenX, screenY, ray_pos, ray_tv, ignoreViewOffset): void

Parameters

NameType
screenXnumber
screenYnumber
ray_posVec3
ray_tvVec3
ignoreViewOffsetboolean

Returns

void


getFrustumPoint

getFrustumPoint(outVertexArray, rectX, rectY, rectW, rectH): void

Parameters

NameType
outVertexArrayVec3[]
rectXnumber
rectYnumber
rectWnumber
rectHnumber

Returns

void


getFrustumPlanes

getFrustumPlanes(outPlanes, frustumVertexArray): void

Parameters

NameType
outPlanesPlane[]
frustumVertexArrayVec3[]

Returns

void


screenPointToWorld

screenPointToWorld(screenX, screenY): Vec4

Parameters

NameType
screenXnumber
screenYnumber

Returns

Vec4


worldPointToScreen

worldPointToScreen(worldPos, flipY?): Vec2

Parameters

NameType
worldPosVec4
flipY?boolean

Returns

Vec2


updateViewMatrix

updateViewMatrix(): void

Returns

void


preRender

preRender(drawWireframe): void

Parameters

NameType
drawWireframeboolean

Returns

void


render

render(forceToRender): void

Parameters

NameType
forceToRenderboolean

Returns

void


postRender

postRender(): void

Returns

void


serializeTransData

serializeTransData(dataTransfer): RoyCameraComponentData

Parameters

NameType
dataTransferRoyDataTransferSend

Returns

RoyCameraComponentData

Overrides

RoyComponent.serializeTransData


deserializeTransData

deserializeTransData(dataTransfer, compData): void

Parameters

NameType
dataTransferRoyDataTransferRecv
compDataRoyComponentData

Returns

void

Overrides

RoyComponent.deserializeTransData


getBoundBox

getBoundBox(): AABB

Returns

AABB

Inherited from

RoyComponent.getBoundBox


setUserData

setUserData(key, value): void

Parameters

NameType
keystring
valueunknown

Returns

void

Inherited from

RoyComponent.setUserData


getUserData

getUserData(key): unknown

Parameters

NameType
keystring

Returns

unknown

Inherited from

RoyComponent.getUserData


deleteUserData

deleteUserData(key): void

Parameters

NameType
keystring

Returns

void

Inherited from

RoyComponent.deleteUserData


markTransDataDirty

markTransDataDirty(): void

Returns

void

Inherited from

RoyComponent.markTransDataDirty


markCanTransfer

markCanTransfer(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RoyComponent.markCanTransfer


markCullDirty

markCullDirty(): void

Returns

void

Inherited from

RoyComponent.markCullDirty


update

update(royCamera): void

Parameters

NameType
royCameraRoyCamera3D

Returns

void

Inherited from

RoyComponent.update


onEnable

onEnable(): void

Returns

void

Inherited from

RoyComponent.onEnable


onDisable

onDisable(): void

Returns

void

Inherited from

RoyComponent.onDisable


updateOcclusion

updateOcclusion(): void

Returns

void

Inherited from

RoyComponent.updateOcclusion


raycast

raycast(rl): RoyQueryResultRay[]

Parameters

NameType
rlRadialLine

Returns

RoyQueryResultRay[]

Inherited from

RoyComponent.raycast


frustumQuery

frustumQuery(frustum, intersection, options): RoyQueryResultFrustum[]

Parameters

NameType
frustumFrustum
intersectionIntersection
optionsSceneQueryOptions

Returns

RoyQueryResultFrustum[]

Inherited from

RoyComponent.frustumQuery


removeRelObjectFromMap

removeRelObjectFromMap(dataTransfer): void

Parameters

NameType
dataTransferRoyDataTransferRecv

Returns

void

Inherited from

RoyComponent.removeRelObjectFromMap


collectTransData

collectTransData(dataTransfer): boolean

Parameters

NameType
dataTransferRoyDataTransferSend

Returns

boolean

Inherited from

RoyComponent.collectTransData