RoyInterface / Exports / resource/material/RoyMaterialBase / RoyMaterialBase

Class: RoyMaterialBase

resource/material/RoyMaterialBase.RoyMaterialBase

Hierarchy

• RoyMaterialBase

  ↳ RoyMaterialInstance

  ↳ RoyMaterialBitmapLineMesh

  ↳ RoyMaterialColorSelection

  ↳ RoyMaterialFill

  ↳ RoyMaterialStandard

  ↳ RoyMaterialStandardBat

Implements

• RoyTransDataObject

Table of contents

Constructors

• constructor

Properties

• sMatDefPBR
• CLASS_NAME
• m_impl
• m_name
• m_templateName
• m_extensions
• sMatHandleID
• m_handleID
• m_materialType
• m_relObjectMap
• m_matDirtyFrameId
• m_blendMode
• m_shadingMode
• 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_userData
• m_transDataInfo
• m_canTransfer
• m_enabledDirtyNotify

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
• clone
• clonePropertiesFrom
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData

Constructors

constructor

• new RoyMaterialBase(batchCount?, transDataInfo?): RoyMaterialBase

Parameters

Name	Type	Default value
batchCount	number	0
transDataInfo?	RoyTransDataInfo	undefined

Returns

RoyMaterialBase

Properties

sMatDefPBR

▪ Static sMatDefPBR: MatDefPBR

---

CLASS_NAME

▪ Static Readonly CLASS_NAME: string = 'RoyMaterial'

---

m_impl

• Protected m_impl: RoyMaterialBaseImpl[]

---

m_name

• Protected m_name: string

---

m_templateName

• Protected m_templateName: string

---

m_extensions

• Private m_extensions: object = {}

---

sMatHandleID

▪ Static sMatHandleID: number = 0

---

m_handleID

• Protected m_handleID: number = 0

---

m_materialType

• Protected m_materialType: RoyMaterialType = RoyMaterialType.CommonType

---

m_relObjectMap

• Protected m_relObjectMap: Map<number, RoyObject3D>

---

m_matDirtyFrameId

• Private m_matDirtyFrameId: number = 0

---

m_blendMode

• Protected m_blendMode: RoyBlendMode = RoyBlendMode.NORMAL

---

m_shadingMode

• Private m_shadingMode: RoyShadingMode = RoyShadingMode.MetalRoughness

---

m_cullFaceMode

• Protected m_cullFaceMode: CullingMode = CullingMode.BACK

---

m_depthWriteEnabled

• Protected m_depthWriteEnabled: boolean = true

---

m_depthTestEnabled

• Protected m_depthTestEnabled: boolean = true

---

m_a3dRenderPriority

• Protected m_a3dRenderPriority: number = -1

---

m_doubleSided

• Protected m_doubleSided: boolean = false

---

m_colorWrite

• Protected m_colorWrite: boolean = true

---

m_clipFillEnabled

• Protected m_clipFillEnabled: boolean = false

---

m_stencilState

• Protected m_stencilState: RoyStencilState

---

m_polygonOffset

• Protected m_polygonOffset: number[]

---

m_instanceEnabled

• Protected m_instanceEnabled: boolean = true

---

m_batchCount

• Protected m_batchCount: number = 0

---

m_lightEnabled

• Protected m_lightEnabled: boolean = true

---

m_forceDRMode

• Protected m_forceDRMode: MatDRMode = MatDRMode.DR_DEFAULT

---

m_uniformMap

• Protected m_uniformMap: Map<string, RoyMatUniformInfo>

---

m_textureMap

• Protected m_textureMap: Map<string, RoyMatTexInfo>

---

m_clippingPlaneInfo

• Protected m_clippingPlaneInfo: Plane[]

---

m_clippingPlanes

• Protected m_clippingPlanes: Float32Array

---

m_clipIntersection

• Protected m_clipIntersection: boolean = false

---

m_matExecutionDirtyFrameId

• Protected m_matExecutionDirtyFrameId: number = 0

---

m_executionList

• Protected m_executionList: number[] = []

---

m_userData

• Private m_userData: object = {}

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

---

m_enabledDirtyNotify

• Protected m_enabledDirtyNotify: boolean = true

Accessors

impl

• get impl(): RoyMaterialBaseImpl[]

Returns

RoyMaterialBaseImpl[]

---

name

• get name(): string

Returns

string

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

---

templateName

• get templateName(): string

Returns

string

---

handleID

• get handleID(): number

Returns

number

---

materialType

• get materialType(): RoyMaterialType

Returns

RoyMaterialType

---

relObjectMap

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

Returns

Map<number, RoyObject3D>

---

matDirtyFrameId

• get matDirtyFrameId(): number

Returns

number

---

blendMode

• get blendMode(): RoyBlendMode

Returns

RoyBlendMode

• set blendMode(value): void

Parameters

Name	Type
value	RoyBlendMode

Returns

void

---

shadingMode

• get shadingMode(): RoyShadingMode

Returns

RoyShadingMode

• set shadingMode(value): void

Parameters

Name	Type
value	RoyShadingMode

Returns

void

---

cullFaceMode

• get cullFaceMode(): CullingMode

Returns

CullingMode

• set cullFaceMode(value): void

Parameters

Name	Type
value	CullingMode

Returns

void

---

depthWriteEnabled

• get depthWriteEnabled(): boolean

Returns

boolean

• set depthWriteEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

depthTestEnabled

• get depthTestEnabled(): boolean

Returns

boolean

• set depthTestEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

a3dRenderPriority

• set a3dRenderPriority(value): void

Parameters

Name	Type
value	number

Returns

void

---

doubleSided

• get doubleSided(): boolean

Returns

boolean

• set doubleSided(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

colorWrite

• get colorWrite(): boolean

Returns

boolean

• set colorWrite(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

clipFillEnabled

• get clipFillEnabled(): boolean

Returns

boolean

• set clipFillEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

stencilState

• get stencilState(): RoyStencilState

Returns

RoyStencilState

• set stencilState(value): void

Parameters

Name	Type
value	RoyStencilState

Returns

void

---

polygonOffset

• get polygonOffset(): number[]

Returns

number[]

• set polygonOffset(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

instanceEnabled

• get instanceEnabled(): boolean

Returns

boolean

• set instanceEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

batchCount

• get batchCount(): number

Returns

number

---

lightEnabled

• get lightEnabled(): boolean

Returns

boolean

• set lightEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

forceDRMode

• get forceDRMode(): MatDRMode

Returns

MatDRMode

• set forceDRMode(value): void

Parameters

Name	Type
value	MatDRMode

Returns

void

---

uniformMap

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

Returns

Map<string, RoyMatUniformInfo>

---

textureMap

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

Returns

Map<string, RoyMatTexInfo>

---

clippingPlaneNum

• get clippingPlaneNum(): number

Returns

number

---

clippingPlanes

• get clippingPlanes(): Float32Array

Returns

Float32Array

---

clipIntersection

• get clipIntersection(): boolean

Returns

boolean

---

matExecutionDirtyFrameId

• get matExecutionDirtyFrameId(): number

Returns

number

---

executionList

• get executionList(): number[]

Returns

number[]

• set executionList(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Implementation of

RoyTransDataObject.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Implementation of

RoyTransDataObject.canTransfer

• set canTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

RoyTransDataObject.canTransfer

Methods

setExtension

▸ setExtension(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

---

getExtension

▸ getExtension(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

---

deleteExtension

▸ deleteExtension(key): void

Parameters

Name	Type
key	string

Returns

void

---

isInUse

▸ isInUse(): boolean

Returns

boolean

---

getDefaultRoyStencilState

▸ getDefaultRoyStencilState(): RoyStencilState

Returns

RoyStencilState

---

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

---

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

---

setUniform

▸ setUniform(name, value): void

Parameters

Name	Type
name	string
value	UniformType

Returns

void

---

getUniform

▸ getUniform(name): UniformType

Parameters

Name	Type
name	string

Returns

UniformType

---

hasUniform

▸ hasUniform(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

---

setTexture

▸ setTexture(name, texture, sampler): void

Parameters

Name	Type
name	string
texture	RoyTexture
sampler	RoySamplerInfo

Returns

void

---

getTexture

▸ getTexture(name): RoyTexture

Parameters

Name	Type
name	string

Returns

RoyTexture

---

getTextureList

▸ getTextureList(): RoyTexture[]

Returns

RoyTexture[]

---

setSampler

▸ setSampler(name, sampler): void

Parameters

Name	Type
name	string
sampler	RoySamplerInfo

Returns

void

---

getSampler

▸ getSampler(name): RoySamplerInfo

Parameters

Name	Type
name	string

Returns

RoySamplerInfo

---

setTextureVisible

▸ setTextureVisible(name, value): void

Parameters

Name	Type
name	string
value	boolean

Returns

void

---

getTextureVisible

▸ getTextureVisible(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

---

setClippingPlanes

▸ setClippingPlanes(value, intersection): void

Parameters

Name	Type
value	Plane[]
intersection	boolean

Returns

void

---

addExecution

▸ addExecution(handleID): void

Parameters

Name	Type
handleID	number

Returns

void

---

removeExecution

▸ removeExecution(handleID): void

Parameters

Name	Type
handleID	number

Returns

void

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Implementation of

RoyTransDataObject.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

RoyTransDataObject.markCanTransfer

---

addRelObject

▸ addRelObject(object): void

Parameters

Name	Type
object	RoyObject3D

Returns

void

---

addRefMatImpl

▸ addRefMatImpl(): void

Returns

void

---

removeRelObject

▸ removeRelObject(object): void

Parameters

Name	Type
object	RoyObject3D

Returns

void

---

removeRefMatImpl

▸ removeRefMatImpl(): void

Returns

void

---

canInstance

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

Parameters

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

Returns

boolean

---

canInstanceMaterialState

▸ canInstanceMaterialState(other): boolean

Parameters

Name	Type
other	RoyMaterialBase

Returns

boolean

---

canInstanceUniform

▸ canInstanceUniform(other, ignoreUVMatrix): boolean

Parameters

Name	Type
other	RoyMaterialBase
ignoreUVMatrix	boolean

Returns

boolean

---

canInstanceTex

▸ canInstanceTex(other, ignoreTex?): boolean

Parameters

Name	Type	Default value
other	RoyMaterialBase	undefined
ignoreTex	boolean	false

Returns

boolean

---

canBatchExtent

▸ canBatchExtent(): boolean

Returns

boolean

---

markContentDirtyFromMtl

▸ markContentDirtyFromMtl(matDirtyType?): void

Parameters

Name	Type	Default value
matDirtyType	RoyMaterialDirtyType	RoyMaterialDirtyType.MDT_COMMON

Returns

void

---

clone

▸ clone(batchCount): RoyMaterialBase

Parameters

Name	Type
batchCount	number

Returns

RoyMaterialBase

---

clonePropertiesFrom

▸ clonePropertiesFrom(royMaterial): void

Parameters

Name	Type
royMaterial	RoyMaterialBase

Returns

void

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Implementation of

RoyTransDataObject.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

void

Implementation of

RoyTransDataObject.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): RoyMaterialData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoyMaterialData

Implementation of

RoyTransDataObject.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, matData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
matData	RoyMaterialData

Returns

void