RoyInterface / Exports / resource/material/materialfixed/RoyMaterialStandardBat / RoyMaterialStandardBat

Class: RoyMaterialStandardBat

resource/material/materialfixed/RoyMaterialStandardBat.RoyMaterialStandardBat

Hierarchy

• RoyMaterialBase

  ↳ RoyMaterialStandardBat

Table of contents

Constructors

• constructor

Properties

• sMatDefPBR
• CLASS_NAME
• m_impl
• m_name
• m_templateName
• sMatHandleID
• m_handleID
• m_materialType
• m_relObjectMap
• m_blendMode
• m_cullFaceMode
• m_depthWriteEnabled
• m_depthTestEnabled
• m_a3dRenderPriority
• m_doubleSided
• m_colorWrite
• m_clipFillEnabled
• m_stencilState
• m_polygonOffset
• m_instanceEnabled
• m_batchCount
• m_lightEnabled
• m_forceDRMode
• m_uniformMap
• m_textureMap
• m_clippingPlaneInfo
• m_clippingPlanes
• m_clipIntersection
• m_matExecutionDirtyFrameId
• m_executionList
• m_transDataInfo
• m_canTransfer
• m_enabledDirtyNotify
• sTypeClass

Accessors

• impl
• name
• templateName
• handleID
• materialType
• relObjectMap
• matDirtyFrameId
• blendMode
• shadingMode
• cullFaceMode
• depthWriteEnabled
• depthTestEnabled
• a3dRenderPriority
• doubleSided
• colorWrite
• clipFillEnabled
• stencilState
• polygonOffset
• instanceEnabled
• batchCount
• lightEnabled
• forceDRMode
• uniformMap
• textureMap
• clippingPlaneNum
• clippingPlanes
• clipIntersection
• matExecutionDirtyFrameId
• executionList
• transDataInfo
• canTransfer

Methods

• setExtension
• getExtension
• deleteExtension
• isInUse
• getDefaultRoyStencilState
• declareUniform
• declareTexture
• setUniform
• getUniform
• hasUniform
• setTexture
• getTexture
• getTextureList
• setSampler
• getSampler
• setTextureVisible
• getTextureVisible
• setClippingPlanes
• addExecution
• removeExecution
• setUserData
• getUserData
• deleteUserData
• markTransDataDirty
• markCanTransfer
• addRelObject
• addRefMatImpl
• removeRelObject
• removeRefMatImpl
• canInstance
• canInstanceMaterialState
• canInstanceUniform
• canInstanceTex
• canBatchExtent
• markContentDirtyFromMtl
• clonePropertiesFrom
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData
• registerImplClass
• createInstance
• destroyInstance
• setRGB
• setAlpha
• setCoordArray
• clone

Constructors

constructor

• new RoyMaterialStandardBat(batchCount?): RoyMaterialStandardBat

Parameters

Name	Type	Default value
batchCount	number	0

Returns

RoyMaterialStandardBat

Overrides

RoyMaterialBase.constructor

Properties

sMatDefPBR

▪ Static sMatDefPBR: MatDefPBR

Inherited from

RoyMaterialBase.sMatDefPBR

---

CLASS_NAME

▪ Static Readonly CLASS_NAME: string = 'RoyMaterial'

Inherited from

RoyMaterialBase.CLASS_NAME

---

m_impl

• Protected m_impl: RoyMaterialBaseImpl[]

Inherited from

RoyMaterialBase.m_impl

---

m_name

• Protected m_name: string

Inherited from

RoyMaterialBase.m_name

---

m_templateName

• Protected m_templateName: string

Inherited from

RoyMaterialBase.m_templateName

---

sMatHandleID

▪ Static sMatHandleID: number = 0

Inherited from

RoyMaterialBase.sMatHandleID

---

m_handleID

• Protected m_handleID: number = 0

Inherited from

RoyMaterialBase.m_handleID

---

m_materialType

• Protected m_materialType: RoyMaterialType = RoyMaterialType.CommonType

Inherited from

RoyMaterialBase.m_materialType

---

m_relObjectMap

• Protected m_relObjectMap: Map<number, RoyObject3D>

Inherited from

RoyMaterialBase.m_relObjectMap

---

m_blendMode

• Protected m_blendMode: RoyBlendMode = RoyBlendMode.NORMAL

Inherited from

RoyMaterialBase.m_blendMode

---

m_cullFaceMode

• Protected m_cullFaceMode: CullingMode = CullingMode.BACK

Inherited from

RoyMaterialBase.m_cullFaceMode

---

m_depthWriteEnabled

• Protected m_depthWriteEnabled: boolean = true

Inherited from

RoyMaterialBase.m_depthWriteEnabled

---

m_depthTestEnabled

• Protected m_depthTestEnabled: boolean = true

Inherited from

RoyMaterialBase.m_depthTestEnabled

---

m_a3dRenderPriority

• Protected m_a3dRenderPriority: number = -1

Inherited from

RoyMaterialBase.m_a3dRenderPriority

---

m_doubleSided

• Protected m_doubleSided: boolean = false

Inherited from

RoyMaterialBase.m_doubleSided

---

m_colorWrite

• Protected m_colorWrite: boolean = true

Inherited from

RoyMaterialBase.m_colorWrite

---

m_clipFillEnabled

• Protected m_clipFillEnabled: boolean = false

Inherited from

RoyMaterialBase.m_clipFillEnabled

---

m_stencilState

• Protected m_stencilState: RoyStencilState

Inherited from

RoyMaterialBase.m_stencilState

---

m_polygonOffset

• Protected m_polygonOffset: number[]

Inherited from

RoyMaterialBase.m_polygonOffset

---

m_instanceEnabled

• Protected m_instanceEnabled: boolean = true

Inherited from

RoyMaterialBase.m_instanceEnabled

---

m_batchCount

• Protected m_batchCount: number = 0

Inherited from

RoyMaterialBase.m_batchCount

---

m_lightEnabled

• Protected m_lightEnabled: boolean = true

Inherited from

RoyMaterialBase.m_lightEnabled

---

m_forceDRMode

• Protected m_forceDRMode: MatDRMode = MatDRMode.DR_DEFAULT

Inherited from

RoyMaterialBase.m_forceDRMode

---

m_uniformMap

• Protected m_uniformMap: Map<string, RoyMatUniformInfo>

Inherited from

RoyMaterialBase.m_uniformMap

---

m_textureMap

• Protected m_textureMap: Map<string, RoyMatTexInfo>

Inherited from

RoyMaterialBase.m_textureMap

---

m_clippingPlaneInfo

• Protected m_clippingPlaneInfo: Plane[]

Inherited from

RoyMaterialBase.m_clippingPlaneInfo

---

m_clippingPlanes

• Protected m_clippingPlanes: Float32Array

Inherited from

RoyMaterialBase.m_clippingPlanes

---

m_clipIntersection

• Protected m_clipIntersection: boolean = false

Inherited from

RoyMaterialBase.m_clipIntersection

---

m_matExecutionDirtyFrameId

• Protected m_matExecutionDirtyFrameId: number = 0

Inherited from

RoyMaterialBase.m_matExecutionDirtyFrameId

---

m_executionList

• Protected m_executionList: number[] = []

Inherited from

RoyMaterialBase.m_executionList

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

Inherited from

RoyMaterialBase.m_transDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Inherited from

RoyMaterialBase.m_canTransfer

---

m_enabledDirtyNotify

• Protected m_enabledDirtyNotify: boolean = true

Inherited from

RoyMaterialBase.m_enabledDirtyNotify

---

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoyMaterialBaseImplClass

Accessors

impl

• get impl(): RoyMaterialBaseImpl[]

Returns

RoyMaterialBaseImpl[]

Inherited from

RoyMaterialBase.impl

---

name

• get name(): string

Returns

string

Inherited from

RoyMaterialBase.name

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

RoyMaterialBase.name

---

templateName

• get templateName(): string

Returns

string

Inherited from

RoyMaterialBase.templateName

---

handleID

• get handleID(): number

Returns

number

Inherited from

RoyMaterialBase.handleID

---

materialType

• get materialType(): RoyMaterialType

Returns

RoyMaterialType

Inherited from

RoyMaterialBase.materialType

---

relObjectMap

• get relObjectMap(): Map<number, RoyObject3D>

Returns

Map<number, RoyObject3D>

Inherited from

RoyMaterialBase.relObjectMap

---

matDirtyFrameId

• get matDirtyFrameId(): number

Returns

number

Inherited from

RoyMaterialBase.matDirtyFrameId

---

blendMode

• get blendMode(): RoyBlendMode

Returns

RoyBlendMode

Inherited from

RoyMaterialBase.blendMode

• set blendMode(value): void

Parameters

Name	Type
value	RoyBlendMode

Returns

void

Inherited from

RoyMaterialBase.blendMode

---

shadingMode

• get shadingMode(): RoyShadingMode

Returns

RoyShadingMode

Inherited from

RoyMaterialBase.shadingMode

• set shadingMode(value): void

Parameters

Name	Type
value	RoyShadingMode

Returns

void

Inherited from

RoyMaterialBase.shadingMode

---

cullFaceMode

• get cullFaceMode(): CullingMode

Returns

CullingMode

Inherited from

RoyMaterialBase.cullFaceMode

• set cullFaceMode(value): void

Parameters

Name	Type
value	CullingMode

Returns

void

Inherited from

RoyMaterialBase.cullFaceMode

---

depthWriteEnabled

• get depthWriteEnabled(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.depthWriteEnabled

• set depthWriteEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.depthWriteEnabled

---

depthTestEnabled

• get depthTestEnabled(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.depthTestEnabled

• set depthTestEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.depthTestEnabled

---

a3dRenderPriority

• set a3dRenderPriority(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

RoyMaterialBase.a3dRenderPriority

---

doubleSided

• get doubleSided(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.doubleSided

• set doubleSided(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.doubleSided

---

colorWrite

• get colorWrite(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.colorWrite

• set colorWrite(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.colorWrite

---

clipFillEnabled

• get clipFillEnabled(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.clipFillEnabled

• set clipFillEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.clipFillEnabled

---

stencilState

• get stencilState(): RoyStencilState

Returns

RoyStencilState

Inherited from

RoyMaterialBase.stencilState

• set stencilState(value): void

Parameters

Name	Type
value	RoyStencilState

Returns

void

Inherited from

RoyMaterialBase.stencilState

---

polygonOffset

• get polygonOffset(): number[]

Returns

number[]

Inherited from

RoyMaterialBase.polygonOffset

• set polygonOffset(value): void

Parameters

Name	Type
value	number[]

Returns

void

Inherited from

RoyMaterialBase.polygonOffset

---

instanceEnabled

• get instanceEnabled(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.instanceEnabled

• set instanceEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.instanceEnabled

---

batchCount

• get batchCount(): number

Returns

number

Inherited from

RoyMaterialBase.batchCount

---

lightEnabled

• get lightEnabled(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.lightEnabled

• set lightEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.lightEnabled

---

forceDRMode

• get forceDRMode(): MatDRMode

Returns

MatDRMode

Inherited from

RoyMaterialBase.forceDRMode

• set forceDRMode(value): void

Parameters

Name	Type
value	MatDRMode

Returns

void

Inherited from

RoyMaterialBase.forceDRMode

---

uniformMap

• get uniformMap(): Map<string, RoyMatUniformInfo>

Returns

Map<string, RoyMatUniformInfo>

Inherited from

RoyMaterialBase.uniformMap

---

textureMap

• get textureMap(): Map<string, RoyMatTexInfo>

Returns

Map<string, RoyMatTexInfo>

Inherited from

RoyMaterialBase.textureMap

---

clippingPlaneNum

• get clippingPlaneNum(): number

Returns

number

Inherited from

RoyMaterialBase.clippingPlaneNum

---

clippingPlanes

• get clippingPlanes(): Float32Array

Returns

Float32Array

Inherited from

RoyMaterialBase.clippingPlanes

---

clipIntersection

• get clipIntersection(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.clipIntersection

---

matExecutionDirtyFrameId

• get matExecutionDirtyFrameId(): number

Returns

number

Inherited from

RoyMaterialBase.matExecutionDirtyFrameId

---

executionList

• get executionList(): number[]

Returns

number[]

Inherited from

RoyMaterialBase.executionList

• set executionList(value): void

Parameters

Name	Type
value	number[]

Returns

void

Inherited from

RoyMaterialBase.executionList

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Inherited from

RoyMaterialBase.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.canTransfer

• set canTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.canTransfer

Methods

setExtension

▸ setExtension(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

Inherited from

RoyMaterialBase.setExtension

---

getExtension

▸ getExtension(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

Inherited from

RoyMaterialBase.getExtension

---

deleteExtension

▸ deleteExtension(key): void

Parameters

Name	Type
key	string

Returns

void

Inherited from

RoyMaterialBase.deleteExtension

---

isInUse

▸ isInUse(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.isInUse

---

getDefaultRoyStencilState

▸ getDefaultRoyStencilState(): RoyStencilState

Returns

RoyStencilState

Inherited from

RoyMaterialBase.getDefaultRoyStencilState

---

declareUniform

▸ declareUniform(name, type, defaultVal, editorInfo?, size?, filter?): void

Parameters

Name	Type
name	string
type	RoyMatUniformType
defaultVal	UniformType
editorInfo	RoyMatEditorInfo
size?	number
filter?	number

Returns

void

Inherited from

RoyMaterialBase.declareUniform

---

declareTexture

▸ declareTexture(name, type, reqTexArray, reqUv1, reqIndex, editorInfo?, filter?): void

Parameters

Name	Type
name	string
type	Texture$Sampler
reqTexArray	boolean
reqUv1	boolean
reqIndex	boolean
editorInfo	RoyMatEditorInfo
filter?	number

Returns

void

Inherited from

RoyMaterialBase.declareTexture

---

setUniform

▸ setUniform(name, value): void

Parameters

Name	Type
name	string
value	UniformType

Returns

void

Inherited from

RoyMaterialBase.setUniform

---

getUniform

▸ getUniform(name): UniformType

Parameters

Name	Type
name	string

Returns

UniformType

Inherited from

RoyMaterialBase.getUniform

---

hasUniform

▸ hasUniform(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Inherited from

RoyMaterialBase.hasUniform

---

setTexture

▸ setTexture(name, texture, sampler): void

Parameters

Name	Type
name	string
texture	RoyTexture
sampler	RoySamplerInfo

Returns

void

Inherited from

RoyMaterialBase.setTexture

---

getTexture

▸ getTexture(name): RoyTexture

Parameters

Name	Type
name	string

Returns

RoyTexture

Inherited from

RoyMaterialBase.getTexture

---

getTextureList

▸ getTextureList(): RoyTexture[]

Returns

RoyTexture[]

Inherited from

RoyMaterialBase.getTextureList

---

setSampler

▸ setSampler(name, sampler): void

Parameters

Name	Type
name	string
sampler	RoySamplerInfo

Returns

void

Inherited from

RoyMaterialBase.setSampler

---

getSampler

▸ getSampler(name): RoySamplerInfo

Parameters

Name	Type
name	string

Returns

RoySamplerInfo

Inherited from

RoyMaterialBase.getSampler

---

setTextureVisible

▸ setTextureVisible(name, value): void

Parameters

Name	Type
name	string
value	boolean

Returns

void

Inherited from

RoyMaterialBase.setTextureVisible

---

getTextureVisible

▸ getTextureVisible(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Inherited from

RoyMaterialBase.getTextureVisible

---

setClippingPlanes

▸ setClippingPlanes(value, intersection): void

Parameters

Name	Type
value	Plane[]
intersection	boolean

Returns

void

Inherited from

RoyMaterialBase.setClippingPlanes

---

addExecution

▸ addExecution(handleID): void

Parameters

Name	Type
handleID	number

Returns

void

Inherited from

RoyMaterialBase.addExecution

---

removeExecution

▸ removeExecution(handleID): void

Parameters

Name	Type
handleID	number

Returns

void

Inherited from

RoyMaterialBase.removeExecution

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

Inherited from

RoyMaterialBase.setUserData

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

Inherited from

RoyMaterialBase.getUserData

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

Inherited from

RoyMaterialBase.deleteUserData

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Inherited from

RoyMaterialBase.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMaterialBase.markCanTransfer

---

addRelObject

▸ addRelObject(object): void

Parameters

Name	Type
object	RoyObject3D

Returns

void

Inherited from

RoyMaterialBase.addRelObject

---

addRefMatImpl

▸ addRefMatImpl(): void

Returns

void

Inherited from

RoyMaterialBase.addRefMatImpl

---

removeRelObject

▸ removeRelObject(object): void

Parameters

Name	Type
object	RoyObject3D

Returns

void

Inherited from

RoyMaterialBase.removeRelObject

---

removeRefMatImpl

▸ removeRefMatImpl(): void

Returns

void

Inherited from

RoyMaterialBase.removeRefMatImpl

---

canInstance

▸ canInstance(other, ignoreUVMatrix, ignoreTex?): boolean

Parameters

Name	Type	Default value
other	RoyMaterialBase	undefined
ignoreUVMatrix	boolean	undefined
ignoreTex	boolean	false

Returns

boolean

Inherited from

RoyMaterialBase.canInstance

---

canInstanceMaterialState

▸ canInstanceMaterialState(other): boolean

Parameters

Name	Type
other	RoyMaterialBase

Returns

boolean

Inherited from

RoyMaterialBase.canInstanceMaterialState

---

canInstanceUniform

▸ canInstanceUniform(other, ignoreUVMatrix): boolean

Parameters

Name	Type
other	RoyMaterialBase
ignoreUVMatrix	boolean

Returns

boolean

Inherited from

RoyMaterialBase.canInstanceUniform

---

canInstanceTex

▸ canInstanceTex(other, ignoreTex?): boolean

Parameters

Name	Type	Default value
other	RoyMaterialBase	undefined
ignoreTex	boolean	false

Returns

boolean

Inherited from

RoyMaterialBase.canInstanceTex

---

canBatchExtent

▸ canBatchExtent(): boolean

Returns

boolean

Inherited from

RoyMaterialBase.canBatchExtent

---

markContentDirtyFromMtl

▸ markContentDirtyFromMtl(matDirtyType?): void

Parameters

Name	Type	Default value
matDirtyType	RoyMaterialDirtyType	RoyMaterialDirtyType.MDT_COMMON

Returns

void

Inherited from

RoyMaterialBase.markContentDirtyFromMtl

---

clonePropertiesFrom

▸ clonePropertiesFrom(royMaterial): void

Parameters

Name	Type
royMaterial	RoyMaterialBase

Returns

void

Inherited from

RoyMaterialBase.clonePropertiesFrom

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Inherited from

RoyMaterialBase.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

void

Inherited from

RoyMaterialBase.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): RoyMaterialData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoyMaterialData

Inherited from

RoyMaterialBase.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, matData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
matData	RoyMaterialData

Returns

void

Inherited from

RoyMaterialBase.deserializeTransData

---

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoyMaterialBaseImplClass

Returns

void

---

createInstance

▸ createInstance(batchCount?): RoyMaterialStandardBat

Parameters

Name	Type	Default value
batchCount	number	0

Returns

RoyMaterialStandardBat

---

destroyInstance

▸ destroyInstance(royMat): boolean

Parameters

Name	Type
royMat	RoyMaterialStandardBat

Returns

boolean

---

setRGB

▸ setRGB(pr, pg, pb): void

Parameters

Name	Type
pr	number
pg	number
pb	number

Returns

void

---

setAlpha

▸ setAlpha(a): void

Parameters

Name	Type
a	number

Returns

void

---

setCoordArray

▸ setCoordArray(uv0Scale, uv1Scale, uvOffset): void

Parameters

Name	Type
uv0Scale	Float32Array
uv1Scale	Float32Array
uvOffset	Float32Array

Returns

void

---

clone

▸ clone(batchCount): RoyMaterialBase

Parameters

Name	Type
batchCount	number

Returns

RoyMaterialBase

Overrides

RoyMaterialBase.clone