CustomMaterialContent

Hierarchy

AbstractMaterialContent
- CustomMaterialContent

Index

Constructors

constructor

Accessors

Constructors

constructor

new CustomMaterialContent(__namedParameters: { additionalShaderSemanticInfo: ShaderSemanticsInfo[]; alphaMode: AlphaModeEnum; isClearCoat?: boolean; isIridescence?: boolean; isLighting: boolean; isMorphing: boolean; isShadow?: boolean; isSheen?: boolean; isSkinning: boolean; isSpecular?: boolean; isTransmission?: boolean; isVolume?: boolean; name: string; pixelShader: ShaderityObject; useNormalTexture: boolean; useTangentAttribute: boolean; vertexShader: ShaderityObject }): CustomMaterialContent

Overrides AbstractMaterialContent.constructor
- Defined in foundation/materials/contents/CustomMaterialContent.ts:18
Parameters
- __namedParameters: { additionalShaderSemanticInfo: ShaderSemanticsInfo[]; alphaMode: AlphaModeEnum; isClearCoat?: boolean; isIridescence?: boolean; isLighting: boolean; isMorphing: boolean; isShadow?: boolean; isSheen?: boolean; isSkinning: boolean; isSpecular?: boolean; isTransmission?: boolean; isVolume?: boolean; name: string; pixelShader: ShaderityObject; useNormalTexture: boolean; useTangentAttribute: boolean; vertexShader: ShaderityObject }
  - additionalShaderSemanticInfo: ShaderSemanticsInfo[]
  - alphaMode: AlphaModeEnum
  - Optional isClearCoat?: boolean
  - Optional isIridescence?: boolean
  - isLighting: boolean
  - isMorphing: boolean
  - Optional isShadow?: boolean
  - Optional isSheen?: boolean
  - isSkinning: boolean
  - Optional isSpecular?: boolean
  - Optional isTransmission?: boolean
  - Optional isVolume?: boolean
  - name: string
  - pixelShader: ShaderityObject
  - useNormalTexture: boolean
  - useTangentAttribute: boolean
  - vertexShader: ShaderityObject
Returns CustomMaterialContent

Properties

Protected __defaultInputValues

__defaultInputValues: Map<string, any> = ...

Protected __definitions

__definitions: string = ''

Protected __materialNodeUid

__materialNodeUid: number

Protected __pixelInputConnections

__pixelInputConnections: InputConnectionType[] = []

Protected __pixelInputs

__pixelInputs: ShaderSocket[] = []

Protected __pixelOutputs

__pixelOutputs: ShaderSocket[] = []

Protected Optional __pixelShaderityObject

__pixelShaderityObject?: ShaderityObject

Protected __semantics

__semantics: ShaderSemanticsInfo[] = []

Protected __shaderFunctionName

__shaderFunctionName: string

Protected __vertexInputConnections

__vertexInputConnections: InputConnectionType[] = []

Protected __vertexInputs

__vertexInputs: ShaderSocket[] = []

Protected __vertexOutputs

__vertexOutputs: ShaderSocket[] = []

Protected Optional __vertexShaderityObject

__vertexShaderityObject?: ShaderityObject

Protected __webglResourceRepository

__webglResourceRepository: WebGLResourceRepository

isSingleOperation

isSingleOperation: boolean = false

shaderType

shaderType: EnumIO = ShaderType.VertexAndPixelShader

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static __dummyBlackCubeTexture

__dummyBlackCubeTexture: CubeTexture = ...

Static __dummyBlackTexture

__dummyBlackTexture: Texture = ...

Static __dummyBlueTexture

__dummyBlueTexture: Texture = ...

Static __dummyPbrKelemenSzirmayKalosBrdfLutTexture

__dummyPbrKelemenSzirmayKalosBrdfLutTexture: Texture = ...

Static __dummySRGBGrayTexture

__dummySRGBGrayTexture: Texture = ...

Static __dummyWhiteTexture

__dummyWhiteTexture: Texture = ...

Static Protected Optional __gl

__gl?: WebGLRenderingContext

Static Private __globalDataRepository

__globalDataRepository: GlobalDataRepository = ...

Static Protected __semanticsMap

__semanticsMap: Map<string, Map<string, ShaderSemanticsInfo>> = ...

Static __sheenLutTextureUid

__sheenLutTextureUid: number = -1

Static Protected __tmp_vector2

__tmp_vector2: MutableVector2 = ...

Static Protected __tmp_vector4

__tmp_vector4: MutableVector4 = ...

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Static materialNodes

materialNodes: AbstractMaterialContent[] = []

Accessors

_semanticsInfoArray

get _semanticsInfoArray(): ShaderSemanticsInfo[]

Inherited from AbstractMaterialContent._semanticsInfoArray
- Defined in foundation/materials/core/AbstractMaterialContent.ts:189
Returns ShaderSemanticsInfo[]

definitions

get definitions(): string

Inherited from AbstractMaterialContent.definitions
- Defined in foundation/materials/core/AbstractMaterialContent.ts:177
Returns string

isLighting

get isLighting(): boolean

Inherited from AbstractMaterialContent.isLighting
- Defined in foundation/materials/core/AbstractMaterialContent.ts:199
Returns boolean

isMorphing

get isMorphing(): boolean

Inherited from AbstractMaterialContent.isMorphing
- Defined in foundation/materials/core/AbstractMaterialContent.ts:196
Returns boolean

isSkinning

get isSkinning(): boolean

Inherited from AbstractMaterialContent.isSkinning
- Defined in foundation/materials/core/AbstractMaterialContent.ts:193
Returns boolean

materialNodeUid

get materialNodeUid(): number

Inherited from AbstractMaterialContent.materialNodeUid
- Defined in foundation/materials/core/AbstractMaterialContent.ts:185
Returns number

objectUID

get objectUID(): number

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

Returns number

pixelInputConnections

get pixelInputConnections(): InputConnectionType[]

Inherited from AbstractMaterialContent.pixelInputConnections
- Defined in foundation/materials/core/AbstractMaterialContent.ts:259
Returns InputConnectionType[]

pixelShaderityObject

get pixelShaderityObject(): undefined | ShaderityObject

Inherited from AbstractMaterialContent.pixelShaderityObject
- Defined in foundation/materials/core/AbstractMaterialContent.ts:173
Returns undefined | ShaderityObject

shaderFunctionName

get shaderFunctionName(): string

Inherited from AbstractMaterialContent.shaderFunctionName
- Defined in foundation/materials/core/AbstractMaterialContent.ts:165
Returns string

uniqueName

get uniqueName(): string

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

Returns string

vertexInputConnections

get vertexInputConnections(): InputConnectionType[]

Inherited from AbstractMaterialContent.vertexInputConnections
- Defined in foundation/materials/core/AbstractMaterialContent.ts:255
Returns InputConnectionType[]

vertexShaderityObject

get vertexShaderityObject(): undefined | ShaderityObject

Inherited from AbstractMaterialContent.vertexShaderityObject
- Defined in foundation/materials/core/AbstractMaterialContent.ts:169
Returns undefined | ShaderityObject

Static dummyBlackCubeTexture

get dummyBlackCubeTexture(): Texture

Inherited from AbstractMaterialContent.dummyBlackCubeTexture
- Defined in foundation/materials/core/AbstractMaterialContent.ts:366
Returns Texture

Static dummyBlackTexture

get dummyBlackTexture(): Texture

Inherited from AbstractMaterialContent.dummyBlackTexture
- Defined in foundation/materials/core/AbstractMaterialContent.ts:360
Returns Texture

Static dummyBlueTexture

get dummyBlueTexture(): Texture

Inherited from AbstractMaterialContent.dummyBlueTexture
- Defined in foundation/materials/core/AbstractMaterialContent.ts:363
Returns Texture

Static dummyPbrKelemenSzirmayKalosBrdfLutTexture

get dummyPbrKelemenSzirmayKalosBrdfLutTexture(): Texture

Inherited from AbstractMaterialContent.dummyPbrKelemenSzirmayKalosBrdfLutTexture
- Defined in foundation/materials/core/AbstractMaterialContent.ts:369
Returns Texture

Static dummyWhiteTexture

get dummyWhiteTexture(): Texture

Inherited from AbstractMaterialContent.dummyWhiteTexture
- Defined in foundation/materials/core/AbstractMaterialContent.ts:357
Returns Texture

Methods

_copyFrom

_copyFrom(rnObject: RnObject): void

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

addPixelInputConnection

addPixelInputConnection(inputMaterialNode: AbstractMaterialContent, outputNameOfPrev: string, inputNameOfThis: string): void

Inherited from AbstractMaterialContent.addPixelInputConnection
- Defined in foundation/materials/core/AbstractMaterialContent.ts:243
Parameters
- inputMaterialNode: AbstractMaterialContent
- outputNameOfPrev: string
- inputNameOfThis: string
Returns void

addVertexInputConnection

addVertexInputConnection(inputMaterialNode: AbstractMaterialContent, outputNameOfPrev: string, inputNameOfThis: string): void

Inherited from AbstractMaterialContent.addVertexInputConnection
- Defined in foundation/materials/core/AbstractMaterialContent.ts:231
Parameters
- inputMaterialNode: AbstractMaterialContent
- outputNameOfPrev: string
- inputNameOfThis: string
Returns void

getPixelInput

getPixelInput(name: string): undefined | ShaderSocket

Inherited from AbstractMaterialContent.getPixelInput
- Defined in foundation/materials/core/AbstractMaterialContent.ts:289
Parameters
- name: string
Returns undefined | ShaderSocket

getPixelInputs

getPixelInputs(): ShaderSocket[]

Inherited from AbstractMaterialContent.getPixelInputs
- Defined in foundation/materials/core/AbstractMaterialContent.ts:298
Returns ShaderSocket[]

getPixelOutput

getPixelOutput(name: string): undefined | ShaderSocket

Inherited from AbstractMaterialContent.getPixelOutput
- Defined in foundation/materials/core/AbstractMaterialContent.ts:302
Parameters
- name: string
Returns undefined | ShaderSocket

getPixelOutputs

getPixelOutputs(): ShaderSocket[]

Inherited from AbstractMaterialContent.getPixelOutputs
- Defined in foundation/materials/core/AbstractMaterialContent.ts:311
Returns ShaderSocket[]

getShaderSemanticInfoFromName

getShaderSemanticInfoFromName(name: string): undefined | ShaderSemanticsInfo

Inherited from AbstractMaterialContent.getShaderSemanticInfoFromName
- Defined in foundation/materials/core/AbstractMaterialContent.ts:224
Parameters
- name: string
Returns undefined | ShaderSemanticsInfo

getTag

getTag(tagName: string): Tag

Inherited from AbstractMaterialContent.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 AbstractMaterialContent.getTagValue
- Defined in foundation/core/RnObject.ts:148
Gets the value of the tag.

Parameters
- tagName: string
  
  The tag name.
Returns any

getVertexInput

getVertexInput(name: string): undefined | ShaderSocket

Inherited from AbstractMaterialContent.getVertexInput
- Defined in foundation/materials/core/AbstractMaterialContent.ts:263
Parameters
- name: string
Returns undefined | ShaderSocket

getVertexInputs

getVertexInputs(): ShaderSocket[]

Inherited from AbstractMaterialContent.getVertexInputs
- Defined in foundation/materials/core/AbstractMaterialContent.ts:272
Returns ShaderSocket[]

getVertexOutput

getVertexOutput(name: string): undefined | ShaderSocket

Inherited from AbstractMaterialContent.getVertexOutput
- Defined in foundation/materials/core/AbstractMaterialContent.ts:276
Parameters
- name: string
Returns undefined | ShaderSocket

getVertexOutputs

getVertexOutputs(): ShaderSocket[]

Inherited from AbstractMaterialContent.getVertexOutputs
- Defined in foundation/materials/core/AbstractMaterialContent.ts:285
Returns ShaderSocket[]

hasTag

hasTag(tagName: string): boolean

Inherited from AbstractMaterialContent.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

matchTag

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

Inherited from AbstractMaterialContent.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 AbstractMaterialContent.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 AbstractMaterialContent.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 AbstractMaterialContent.removeTag
- Defined in foundation/core/RnObject.ts:180
Remove the tag.

Parameters
- tagName: string
  
  The tag name.
Returns void

setCustomSettingParametersToGpu

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

Overrides AbstractMaterialContent.setCustomSettingParametersToGpu
- Defined in foundation/materials/contents/CustomMaterialContent.ts:159
Parameters
- __namedParameters: { args: RenderingArg; firstTime: boolean; material: Material; shaderProgram: WebGLProgram }
  - args: RenderingArg
  - firstTime: boolean
  - material: Material
  - shaderProgram: WebGLProgram
Returns void

setDefaultInputValue

setDefaultInputValue(inputName: string, value: any): void

Inherited from AbstractMaterialContent.setDefaultInputValue
- Defined in foundation/materials/core/AbstractMaterialContent.ts:754
Parameters
- inputName: string
- value: any
Returns void

Protected setIsBillboard

setIsBillboard(shaderProgram: WebGLProgram, isBillboard: boolean): void

Inherited from AbstractMaterialContent.setIsBillboard
- Defined in foundation/materials/core/AbstractMaterialContent.ts:448
Parameters
- shaderProgram: WebGLProgram
- isBillboard: boolean
Returns void

Protected setLightsInfo

setLightsInfo(shaderProgram: WebGLProgram, lightComponents: LightComponent[], material: Material, setUniform: boolean): void

Inherited from AbstractMaterialContent.setLightsInfo
- Defined in foundation/materials/core/AbstractMaterialContent.ts:583
Parameters
- shaderProgram: WebGLProgram
- lightComponents: LightComponent[]
- material: Material
- setUniform: boolean
Returns void

setMorphInfo

setMorphInfo(shaderProgram: WebGLProgram, meshComponent: MeshComponent, primitive: Primitive, blendShapeComponent?: BlendShapeComponent): void

Inherited from AbstractMaterialContent.setMorphInfo
- Defined in foundation/materials/core/AbstractMaterialContent.ts:691
Parameters
- shaderProgram: WebGLProgram
- meshComponent: MeshComponent
- primitive: Primitive
- Optional blendShapeComponent: BlendShapeComponent
Returns void

Protected setNormalMatrix

setNormalMatrix(shaderProgram: WebGLProgram, normalMatrix: IMatrix33): void

Inherited from AbstractMaterialContent.setNormalMatrix
- Defined in foundation/materials/core/AbstractMaterialContent.ts:437
Parameters
- shaderProgram: WebGLProgram
- normalMatrix: IMatrix33
Returns void

Protected setProjection

setProjection(shaderProgram: WebGLProgram, cameraComponent: CameraComponent, isVr: boolean, displayIdx: number): void

Inherited from AbstractMaterialContent.setProjection
- Defined in foundation/materials/core/AbstractMaterialContent.ts:489
Parameters
- shaderProgram: WebGLProgram
- cameraComponent: CameraComponent
- isVr: boolean
- displayIdx: number
Returns void

setShaderSemanticsInfoArray

setShaderSemanticsInfoArray(shaderSemanticsInfoArray: ShaderSemanticsInfo[]): void

Inherited from AbstractMaterialContent.setShaderSemanticsInfoArray
- Defined in foundation/materials/core/AbstractMaterialContent.ts:203
Parameters
- shaderSemanticsInfoArray: ShaderSemanticsInfo[]
Returns void

Protected setSkinning

setSkinning(shaderProgram: WebGLProgram, setUniform: boolean, skeletalComponent?: SkeletalComponent): void

Inherited from AbstractMaterialContent.setSkinning
- Defined in foundation/materials/core/AbstractMaterialContent.ts:514
Parameters
- shaderProgram: WebGLProgram
- setUniform: boolean
- Optional skeletalComponent: SkeletalComponent
Returns void

Protected setViewInfo

setViewInfo(shaderProgram: WebGLProgram, cameraComponent: CameraComponent, isVr: boolean, displayIdx: number): void

Inherited from AbstractMaterialContent.setViewInfo
- Defined in foundation/materials/core/AbstractMaterialContent.ts:455
Parameters
- shaderProgram: WebGLProgram
- cameraComponent: CameraComponent
- isVr: boolean
- displayIdx: number
Returns void

Protected setWorldMatrix

setWorldMatrix(shaderProgram: WebGLProgram, worldMatrix: Matrix44): void

Inherited from AbstractMaterialContent.setWorldMatrix
- Defined in foundation/materials/core/AbstractMaterialContent.ts:429
Parameters
- shaderProgram: WebGLProgram
- worldMatrix: Matrix44
Returns void

Protected setupBasicInfo

setupBasicInfo(args: RenderingArg, shaderProgram: WebGLProgram, firstTime: boolean, material: Material, CameraComponentClass: typeof CameraComponent): void

Inherited from AbstractMaterialContent.setupBasicInfo
- Defined in foundation/materials/core/AbstractMaterialContent.ts:373
Parameters
- args: RenderingArg
- shaderProgram: WebGLProgram
- firstTime: boolean
- material: Material
- CameraComponentClass: typeof CameraComponent
Returns void

Private setupHdriParameters

setupHdriParameters(args: RenderingArg): { diffuseHdriType: number; meshRenderComponent: MeshRendererComponent; mipmapLevelNumber: number; specularHdriType: number }

- Defined in foundation/materials/contents/CustomMaterialContent.ts:324
Parameters
- args: RenderingArg
Returns { diffuseHdriType: number; meshRenderComponent: MeshRendererComponent; mipmapLevelNumber: number; specularHdriType: number }
- diffuseHdriType: number
- meshRenderComponent: MeshRendererComponent
- mipmapLevelNumber: number
- specularHdriType: number

tryToSetTag

tryToSetTag(tag: Tag): boolean

Inherited from AbstractMaterialContent.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 AbstractMaterialContent.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 AbstractMaterialContent.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 AbstractMaterialContent._reset
- Defined in foundation/core/RnObject.ts:245
internal
Returns void

Static getMaterialNode

getMaterialNode(materialNodeUid: number): AbstractMaterialContent

Inherited from AbstractMaterialContent.getMaterialNode
- Defined in foundation/materials/core/AbstractMaterialContent.ts:181
Parameters
- materialNodeUid: number
Returns AbstractMaterialContent

Static getRnObject

getRnObject(objectUid: number): RnObject

Inherited from AbstractMaterialContent.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 AbstractMaterialContent.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 initDefaultTextures

initDefaultTextures(): Promise<void>

Inherited from AbstractMaterialContent.initDefaultTextures
- Defined in foundation/materials/core/AbstractMaterialContent.ts:315
Returns Promise<void>

Static searchByTag

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

Inherited from AbstractMaterialContent.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

additionalShaderSemanticInfo: ShaderSemanticsInfo[]

alphaMode: AlphaModeEnum

Optional isClearCoat?: boolean

Optional isIridescence?: boolean

isLighting: boolean

isMorphing: boolean

Optional isShadow?: boolean

Optional isSheen?: boolean

isSkinning: boolean

Optional isSpecular?: boolean

Optional isTransmission?: boolean

Optional isVolume?: boolean

name: string

pixelShader: ShaderityObject

useNormalTexture: boolean

useTangentAttribute: boolean

vertexShader: ShaderityObject

Returns CustomMaterialContent

Properties

Protected __defaultInputValues

Protected __definitions

Protected __materialNodeUid

Protected __pixelInputConnections

Protected __pixelInputs

Protected __pixelOutputs

Protected Optional __pixelShaderityObject

Protected __semantics

Protected __shaderFunctionName

Protected __vertexInputConnections

Protected __vertexInputs

Protected __vertexOutputs

Protected Optional __vertexShaderityObject

Protected __webglResourceRepository

isSingleOperation

shaderType

Static Readonly InvalidObjectUID

Static __dummyBlackCubeTexture

Static __dummyBlackTexture

Static __dummyBlueTexture

Static __dummyPbrKelemenSzirmayKalosBrdfLutTexture

Static __dummySRGBGrayTexture

Static __dummyWhiteTexture

Static Protected Optional __gl

Static Private __globalDataRepository

Static Protected __semanticsMap

Static __sheenLutTextureUid

Static Protected __tmp_vector2

Static Protected __tmp_vector4

Static currentMaxObjectCount

Static materialNodes

Accessors

_semanticsInfoArray

Returns ShaderSemanticsInfo[]

definitions

Returns string

isLighting

Returns boolean

isMorphing

Returns boolean

isSkinning

Returns boolean

materialNodeUid

Returns number

objectUID

Returns number

pixelInputConnections

Returns InputConnectionType[]

pixelShaderityObject

Returns undefined | ShaderityObject

shaderFunctionName

Returns string