Material | rhodonite

The material class. This class has one or more material nodes.

Hierarchy

RnObject
- Material

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Material(materialTid: number, materialUid: number, materialSid: number, materialTypeName: string, materialNode: AbstractMaterialContent): Material

Overrides RnObject.constructor
- Defined in foundation/materials/core/Material.ts:88
Parameters
- materialTid: number
- materialUid: number
- materialSid: number
- materialTypeName: string
- materialNode: AbstractMaterialContent
Returns Material

Properties

Private __alphaMode

__alphaMode: AlphaModeEnum = AlphaMode.Opaque

Private __alphaToCoverage

__alphaToCoverage: boolean = false

Private __belongPrimitives

__belongPrimitives: Map<number, Primitive> = ...

Private __blendEquationMode

__blendEquationMode: number = GL_FUNC_ADD

Private __blendEquationModeAlpha

__blendEquationModeAlpha: number = GL_FUNC_ADD

Private __blendFuncAlphaDstFactor

__blendFuncAlphaDstFactor: number = GL_ONE

Private __blendFuncAlphaSrcFactor

__blendFuncAlphaSrcFactor: number = GL_ONE

Private __blendFuncDstFactor

__blendFuncDstFactor: number = GL_ONE_MINUS_SRC_ALPHA

Private __blendFuncSrcFactor

__blendFuncSrcFactor: number = GL_SRC_ALPHA

__materialSid

__materialSid: number = -1

Private __materialTid

__materialTid: number

__materialTypeName

__materialTypeName: string

__materialUid

__materialUid: number = -1

Private Optional __updatedShaderSources

__updatedShaderSources?: ShaderSources

_allFieldVariables

_allFieldVariables: Map<number, ShaderVariable> = ...

_allFieldsInfo

_allFieldsInfo: Map<number, ShaderSemanticsInfo> = ...

_autoFieldVariablesOnly

_autoFieldVariablesOnly: Map<number, ShaderVariable> = ...

_materialContent

_materialContent: AbstractMaterialContent

_shaderProgramUid

_shaderProgramUid: number = CGAPIResourceRepository.InvalidCGAPIResourceUid

cullFace

cullFace: boolean = true

cullFrontFaceCCW

cullFrontFaceCCW: boolean = true

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static Private __shaderHashMap

__shaderHashMap: Map<number, number> = ...

Static Private __shaderStringMap

__shaderStringMap: Map<string, number> = ...

Static _soloDatumFields

_soloDatumFields: Map<string, Map<number, ShaderVariable>> = ...

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Accessors

alphaMode

get alphaMode(): AlphaModeEnum
set alphaMode(mode: AlphaModeEnum): void

- Defined in foundation/materials/core/Material.ts:835
Returns AlphaModeEnum
- Defined in foundation/materials/core/Material.ts:839
Parameters
- mode: AlphaModeEnum
Returns void

alphaToCoverage

get alphaToCoverage(): boolean
set alphaToCoverage(alphaToCoverage: boolean): void

- Defined in foundation/materials/core/Material.ts:796
NOTE: To apply the alphaToCoverage, the output alpha value must not be fixed to constant value. However, some shaders in the Rhodonite fixes the output alpha value to 1 by setAlphaIfNotInAlphaBlendMode. So we need to improve the shader to use the alphaToCoverage.

Returns boolean
- Defined in foundation/materials/core/Material.ts:788
NOTE: To apply the alphaToCoverage, the output alpha value must not be fixed to constant value. However, some shaders in the Rhodonite fixes the output alpha value to 1 by setAlphaIfNotInAlphaBlendMode. So we need to improve the shader to use the alphaToCoverage.

Parameters
- alphaToCoverage: boolean
  
  apply alphaToCoverage to this material or not
Returns void

blendEquationMode

get blendEquationMode(): number

- Defined in foundation/materials/core/Material.ts:811
Returns number

blendEquationModeAlpha

get blendEquationModeAlpha(): number

- Defined in foundation/materials/core/Material.ts:815
Returns number

blendFuncAlphaDstFactor

get blendFuncAlphaDstFactor(): number

- Defined in foundation/materials/core/Material.ts:831
Returns number

blendFuncAlphaSrcFactor

get blendFuncAlphaSrcFactor(): number

- Defined in foundation/materials/core/Material.ts:827
Returns number

blendFuncDstFactor

get blendFuncDstFactor(): number

- Defined in foundation/materials/core/Material.ts:823
Returns number

blendFuncSrcFactor

get blendFuncSrcFactor(): number

- Defined in foundation/materials/core/Material.ts:819
Returns number

fieldsInfoArray

get fieldsInfoArray(): ShaderSemanticsInfo[]

- Defined in foundation/materials/core/Material.ts:807
Returns ShaderSemanticsInfo[]

isLighting

get isLighting(): boolean

- Defined in foundation/materials/core/Material.ts:859
Returns boolean

isMorphing

get isMorphing(): boolean

- Defined in foundation/materials/core/Material.ts:855
Returns boolean

isSkinning

get isSkinning(): boolean

- Defined in foundation/materials/core/Material.ts:851
Returns boolean

materialSID

get materialSID(): number

- Defined in foundation/materials/core/Material.ts:847
Returns number

materialTID

get materialTID(): number

- Defined in foundation/materials/core/Material.ts:803
Gets materialTID.

Returns number

materialTypeName

get materialTypeName(): string

- Defined in foundation/materials/core/Material.ts:863
Returns string

materialUID

get materialUID(): number

- Defined in foundation/materials/core/Material.ts:843
Returns number

objectUID

get objectUID(): number

Inherited from RnObject.objectUID
- Defined in foundation/core/RnObject.ts:68
Gets the objectUID of the object.

Returns number

uniqueName

get uniqueName(): string

Inherited from RnObject.uniqueName
- Defined in foundation/core/RnObject.ts:238
Get the unique name of the entity.

Returns string

Methods

Private __createProgramAsSingleOperation

__createProgramAsSingleOperation(vertexShaderMethodDefinitions_uniform: string, propertySetter: getShaderPropertyFunc, isWebGL2: boolean): number

- Defined in foundation/materials/core/Material.ts:432
Parameters
- vertexShaderMethodDefinitions_uniform: string
- propertySetter: getShaderPropertyFunc
- isWebGL2: boolean
Returns number

Private __createProgramAsSingleOperationByUpdatedSources

__createProgramAsSingleOperationByUpdatedSources(updatedShaderSources: ShaderSources): number

- Defined in foundation/materials/core/Material.ts:509
Parameters
- updatedShaderSources: ShaderSources
Returns number

Private __createShaderProgramWithCache

__createShaderProgramWithCache(vertexShader: string, pixelShader: string, attributeNames: AttributeNames, attributeSemantics: VertexAttributeEnum[]): number

- Defined in foundation/materials/core/Material.ts:524
Parameters
- vertexShader: string
- pixelShader: string
- attributeNames: AttributeNames
- attributeSemantics: VertexAttributeEnum[]
Returns number

Private __getAttributeInfo

__getAttributeInfo(materialNode: AbstractMaterialContent): { attributeNames: string[]; attributeSemantics: VertexAttributeEnum[] }

- Defined in foundation/materials/core/Material.ts:558
Parameters
- materialNode: AbstractMaterialContent
Returns { attributeNames: string[]; attributeSemantics: VertexAttributeEnum[] }
- attributeNames: string[]
- attributeSemantics: VertexAttributeEnum[]

Private __getTargetShaderSemantics

__getTargetShaderSemantics(uniformName: string): undefined | ShaderSemanticsEnum

- Defined in foundation/materials/core/Material.ts:623
Parameters
- uniformName: string
Returns undefined | ShaderSemanticsEnum

Private __outputVertexAttributeBindingInfo

__outputVertexAttributeBindingInfo(attributeNames: string[], attributeSemantics: VertexAttributeEnum[]): string

- Defined in foundation/materials/core/Material.ts:567
Parameters
- attributeNames: string[]
- attributeSemantics: VertexAttributeEnum[]
Returns string

Private __setAutoParametersToGpu

__setAutoParametersToGpu(args: RenderingArg, firstTime: boolean, shaderProgram: WebGLProgram): void

- Defined in foundation/materials/core/Material.ts:294
Parameters
- args: RenderingArg
- firstTime: boolean
- shaderProgram: WebGLProgram
Returns void

Private __setSoloDatumParametersToGpu

__setSoloDatumParametersToGpu(__namedParameters: { args: RenderingArg; firstTime: boolean; shaderProgram: WebGLProgram }): void

- Defined in foundation/materials/core/Material.ts:348
Parameters
- __namedParameters: { args: RenderingArg; firstTime: boolean; shaderProgram: WebGLProgram }
  - args: RenderingArg
  - firstTime: boolean
  - shaderProgram: WebGLProgram
Returns void

Private __setupGlobalShaderDefinition

__setupGlobalShaderDefinition(): string

- Defined in foundation/materials/core/Material.ts:388
Returns string

_addBelongPrimitive

_addBelongPrimitive(primitive: Primitive): void

- Defined in foundation/materials/core/Material.ts:108
internal
called from Primitive class only

Parameters
- primitive: Primitive
Returns void

_copyFrom

_copyFrom(rnObject: RnObject): void

Inherited from RnObject._copyFrom
- Defined in foundation/core/RnObject.ts:252
Parameters
- rnObject: RnObject
Returns void

_createProgram

_createProgram(vertexShaderMethodDefinitions_uniform: string, propertySetter: getShaderPropertyFunc, isWebGL2: boolean): number

- Defined in foundation/materials/core/Material.ts:647
internal
called from WebGLStrategyDataTexture and WebGLStrategyUnfirom

Parameters
- vertexShaderMethodDefinitions_uniform: string
- propertySetter: getShaderPropertyFunc
- isWebGL2: boolean
Returns number

_getProperties

_getProperties(propertySetter: getShaderPropertyFunc, isWebGL2: boolean): { pixelPropertiesStr: string; vertexPropertiesStr: string }

- Defined in foundation/materials/core/Material.ts:582
internal
Parameters
- propertySetter: getShaderPropertyFunc
- isWebGL2: boolean
Returns { pixelPropertiesStr: string; vertexPropertiesStr: string }
- pixelPropertiesStr: string
- vertexPropertiesStr: string

_setParametersToGpu

_setParametersToGpu(__namedParameters: { args: RenderingArg; firstTime: boolean; material: Material; shaderProgram: WebGLProgram }): void

- Defined in foundation/materials/core/Material.ts:266
internal
called from WebGLStrategyDataTexture and WebGLStrategyUnitform only

Parameters
- __namedParameters: { args: RenderingArg; firstTime: boolean; material: Material; shaderProgram: WebGLProgram }
  - args: RenderingArg
  - firstTime: boolean
  - material: Material
  - shaderProgram: WebGLProgram
Returns void

_setUniformLocationsOfMaterialNodes

_setUniformLocationsOfMaterialNodes(isUniformOnlyMode: boolean): void

- Defined in foundation/materials/core/Material.ts:235
internal
called from WebGLStrategyDataTexture and WebGLStrategyUnfirom only

Parameters
- isUniformOnlyMode: boolean
Returns void

_setupAdditionalUniformLocations

_setupAdditionalUniformLocations(shaderSemantics: ShaderSemanticsInfo[], isUniformOnlyMode: boolean): WebGLProgram

- Defined in foundation/materials/core/Material.ts:735
internal
called WebGLStrategyDataTexture and WebGLStrategyUniform only

Parameters
- shaderSemantics: ShaderSemanticsInfo[]
- isUniformOnlyMode: boolean
Returns WebGLProgram

_setupBasicUniformsLocations

_setupBasicUniformsLocations(): void

- Defined in foundation/materials/core/Material.ts:721
internal
called WebGLStrategyDataTexture and WebGLStrategyUniform only

Returns void

createProgramByUpdatedSources

createProgramByUpdatedSources(updatedShaderSources: ShaderSources): number

- Defined in foundation/materials/core/Material.ts:661
Parameters
- updatedShaderSources: ShaderSources
Returns number

getParameter

getParameter(shaderSemantic: ShaderSemanticsEnum): any

- Defined in foundation/materials/core/Material.ts:215
Parameters
- shaderSemantic: ShaderSemanticsEnum
Returns any

getTag

getTag(tagName: string): Tag

Inherited from RnObject.getTag
- Defined in foundation/core/RnObject.ts:156
Gets the tag object.

Parameters
- tagName: string
  
  The tag name.
Returns Tag

getTagValue

getTagValue(tagName: string): any

Inherited from RnObject.getTagValue
- Defined in foundation/core/RnObject.ts:148
Gets the value of the tag.

Parameters
- tagName: string
  
  The tag name.
Returns any

getTextureParameter

getTextureParameter(shaderSemantic: ShaderSemanticsEnum): any

- Defined in foundation/materials/core/Material.ts:161
Parameters
- shaderSemantic: ShaderSemanticsEnum
Returns any

hasTag

hasTag(tagName: string): boolean

Inherited from RnObject.hasTag
- Defined in foundation/core/RnObject.ts:168
Gets the boolean value whether this object has the tag or not.

Parameters
- tagName: string
  
  The tag name.
Returns boolean

isBlend

isBlend(): boolean

- Defined in foundation/materials/core/Material.ts:764
Returns boolean

isEmptyMaterial

isEmptyMaterial(): boolean

- Defined in foundation/materials/core/Material.ts:756
Returns boolean

isShaderProgramReady

isShaderProgramReady(): boolean

- Defined in foundation/materials/core/Material.ts:256
return whether the shader program ready or not

Returns boolean
is shader program ready or not

matchTag

matchTag(tagName: string, tagValue: string): boolean

Inherited from RnObject.matchTag
- Defined in foundation/core/RnObject.ts:191
Confirms the matching of the tag name and tag value.

Parameters
- tagName: string
  
  The tag name.
- tagValue: string
  
  The tag value.
Returns boolean

matchTags

matchTags(tags: RnTags): boolean

Inherited from RnObject.matchTags
- Defined in foundation/core/RnObject.ts:221
Confirm that this object's tags includes given set of tags.

Parameters
- tags: RnTags
  
  The set of tags.
Returns boolean

matchTagsAsFreeStrings

matchTagsAsFreeStrings(stringArray: string[]): boolean

Inherited from RnObject.matchTagsAsFreeStrings
- Defined in foundation/core/RnObject.ts:203
Confirm that this object's tags includes given an array of string.

Parameters
- stringArray: string[]
  
  an array of string.
Returns boolean

removeTag

removeTag(tagName: string): void

Inherited from RnObject.removeTag
- Defined in foundation/core/RnObject.ts:180
Remove the tag.

Parameters
- tagName: string
  
  The tag name.
Returns void

setBlendEquationMode

setBlendEquationMode(blendEquationMode: number, blendEquationModeAlpha?: number): void

- Defined in foundation/materials/core/Material.ts:682
Change the blendEquations This method works only if this alphaMode is the translucent

Parameters
- blendEquationMode: number
  
  the argument of gl.blendEquation of the first argument of gl.blendEquationSeparate such as gl.FUNC_ADD
- Optional blendEquationModeAlpha: number
  
  the second argument of gl.blendEquationSeparate
Returns void

setBlendFuncFactor

setBlendFuncFactor(blendFuncSrcFactor: number, blendFuncDstFactor: number): void

- Defined in foundation/materials/core/Material.ts:710
Change the blendFuncFactors This method works only if this alphaMode is the translucent

Parameters
- blendFuncSrcFactor: number
- blendFuncDstFactor: number
Returns void

setBlendFuncSeparateFactor

setBlendFuncSeparateFactor(blendFuncSrcFactor: number, blendFuncDstFactor: number, blendFuncAlphaSrcFactor: number, blendFuncAlphaDstFactor: number): void

- Defined in foundation/materials/core/Material.ts:694
Change the blendFuncSeparateFactors This method works only if this alphaMode is the translucent

Parameters
- blendFuncSrcFactor: number
- blendFuncDstFactor: number
- blendFuncAlphaSrcFactor: number
- blendFuncAlphaDstFactor: number
Returns void

setParameter

setParameter(shaderSemantic: ShaderSemanticsEnum, value: any): void

- Defined in foundation/materials/core/Material.ts:120
Parameters
- shaderSemantic: ShaderSemanticsEnum
- value: any
Returns void

setParameterByUniformName

setParameterByUniformName(uniformName: string, value: any): void

- Defined in foundation/materials/core/Material.ts:201
Parameters
- uniformName: string
- value: any
Returns void

setTextureParameter

setTextureParameter(shaderSemantic: ShaderSemanticsEnum, value: AbstractTexture): void

- Defined in foundation/materials/core/Material.ts:136
Parameters
- shaderSemantic: ShaderSemanticsEnum
- value: AbstractTexture
Returns void

setTextureParameterAsPromise

setTextureParameterAsPromise(shaderSemantic: ShaderSemanticsEnum, promise: Promise<AbstractTexture>): void

- Defined in foundation/materials/core/Material.ts:169
Parameters
- shaderSemantic: ShaderSemanticsEnum
- promise: Promise<AbstractTexture>
Returns void

setTextureParameterByUniformName

setTextureParameterByUniformName(uniformName: string, value: any): void

- Defined in foundation/materials/core/Material.ts:208
Parameters
- uniformName: string
- value: any
Returns void

tryToSetTag

tryToSetTag(tag: Tag): boolean

Inherited from RnObject.tryToSetTag
- Defined in foundation/core/RnObject.ts:131
Tries to set tag (name and value).

Parameters
- tag: Tag
Returns boolean

tryToSetUniqueName

tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean

Inherited from RnObject.tryToSetUniqueName
- Defined in foundation/core/RnObject.ts:93
Try to set a unique name of the entity.

Parameters
- name: string
- toAddNameIfConflict: boolean
  
  If true, force to add name string to the current unique name string. If false, give up to change name.
Returns boolean

validateTagString

validateTagString(val: string): boolean

Inherited from RnObject.validateTagString
- Defined in foundation/core/RnObject.ts:118
Validate the string of tags.

Parameters
- val: string
  
  The string to be validated
Returns boolean

Static _reset

_reset(): void

Inherited from RnObject._reset
- Defined in foundation/core/RnObject.ts:245
internal
Returns void

Static getRnObject

getRnObject(objectUid: number): RnObject

Inherited from RnObject.getRnObject
- Defined in foundation/core/RnObject.ts:76
Gets the object by corresponding to the objectUID.

Parameters
- objectUid: number
  
  The objectUID of the object.
Returns RnObject

Static getRnObjectByName

getRnObjectByName(uniqueName: string): undefined | RnObject

Inherited from RnObject.getRnObjectByName
- Defined in foundation/core/RnObject.ts:84
Gets the object by the unique name.

Parameters
- uniqueName: string
  
  The unique name of the object.
Returns undefined | RnObject

Static searchByTag

searchByTag(tag: string, value: string): undefined | RnObject

Inherited from RnObject.searchByTag
- Defined in foundation/core/RnObject.ts:56
Parameters
- tag: string
- value: string
Returns undefined | RnObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

materialTid: number

materialUid: number

materialSid: number

materialTypeName: string

materialNode: AbstractMaterialContent

Returns Material

Properties

Private __alphaMode

Private __alphaToCoverage

Private __belongPrimitives

Private __blendEquationMode

Private __blendEquationModeAlpha

Private __blendFuncAlphaDstFactor

Private __blendFuncAlphaSrcFactor

Private __blendFuncDstFactor

Private __blendFuncSrcFactor

__materialSid

Private __materialTid

__materialTypeName

__materialUid

Private Optional __updatedShaderSources

_allFieldVariables

_allFieldsInfo

_autoFieldVariablesOnly

_materialContent

_shaderProgramUid

cullFace

cullFrontFaceCCW

Static Readonly InvalidObjectUID

Static Private __shaderHashMap

Static Private __shaderStringMap

Static _soloDatumFields

Static currentMaxObjectCount

Accessors

alphaMode

Returns AlphaModeEnum

Parameters

mode: AlphaModeEnum

Returns void

alphaToCoverage

Returns boolean

Parameters

alphaToCoverage: boolean

Returns void

blendEquationMode

Returns number

blendEquationModeAlpha

Returns number

blendFuncAlphaDstFactor

Returns number

blendFuncAlphaSrcFactor

Returns number

blendFuncDstFactor

Returns number

blendFuncSrcFactor

Returns number

fieldsInfoArray

Returns ShaderSemanticsInfo[]

isLighting

Returns boolean

isMorphing

Returns boolean

isSkinning

Returns boolean

materialSID

Returns number

materialTID

Returns number

materialTypeName

Returns string

materialUID