Class TBNBlock

Block used to implement TBN matrix

Hierarchy

NodeMaterialBlock
- TBNBlock

Index

Constructors

constructor

Properties

Accessors

TBN
buildId
inputs
isFinalMerger
isInput
isUnique
name
normal
outputs
tangent
target
willBeGeneratedIntoVertexShaderFromFragmentShader
world

Constructors

constructor

new TBNBlock(name: string): TBNBlock

Overrides NodeMaterialBlock.constructor
- Defined in .temp/docdirectory/doc.d.ts:39344
Create a new TBNBlock

Parameters
- name: string
  
  defines the block name
Returns TBNBlock

Properties

commentsSearch playground for comments

comments: string

Gets or sets the comments associated with this block

inputsAreExclusiveSearch playground for inputsAreExclusive

inputsAreExclusive: boolean

Gets or sets a boolean indicating that only one input can be connected at a time

uniqueIdSearch playground for uniqueId

uniqueId: number

Gets or sets the unique id of the node

visibleInInspectorSearch playground for visibleInInspector

visibleInInspector: boolean

Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default)

visibleOnFrameSearch playground for visibleOnFrame

visibleOnFrame: boolean

Gets or sets a boolean indicating that this input can be edited from a collapsed frame

Accessors

TBN

get TBN(): NodeMaterialConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:39375
Gets the TBN output component

Returns NodeMaterialConnectionPoint

buildId

get buildId(): number
set buildId(value: number): any

Inherited from AddBlock.buildId
- Defined in .temp/docdirectory/doc.d.ts:42758
Gets or sets the build Id

Returns number
Inherited from AddBlock.buildId
- Defined in .temp/docdirectory/doc.d.ts:42759
Gets or sets the build Id

Parameters
- value: number
Returns any

inputs

get inputs(): NodeMaterialConnectionPoint[]

Inherited from AddBlock.inputs
- Defined in .temp/docdirectory/doc.d.ts:42768
Gets the list of input points

Returns NodeMaterialConnectionPoint[]

isFinalMerger

get isFinalMerger(): boolean

Inherited from AddBlock.isFinalMerger
- Defined in .temp/docdirectory/doc.d.ts:42750
Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)

Returns boolean

isInput

get isInput(): boolean

Inherited from AddBlock.isInput
- Defined in .temp/docdirectory/doc.d.ts:42754
Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)

Returns boolean

isUnique

get isUnique(): boolean

Inherited from AddBlock.isUnique
- Defined in .temp/docdirectory/doc.d.ts:42746
Gets a boolean indicating that this block can only be used once per NodeMaterial

Returns boolean

name

get name(): string
set name(newName: string): any

Inherited from AddBlock.name
- Defined in .temp/docdirectory/doc.d.ts:42730
Gets the name of the block

Returns string
Inherited from AddBlock.name
- Defined in .temp/docdirectory/doc.d.ts:42734
Sets the name of the block. Will check if the name is valid.

Parameters
- newName: string
Returns any

normal

get normal(): NodeMaterialConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:39363
Gets the normal input component

Returns NodeMaterialConnectionPoint

outputs

get outputs(): NodeMaterialConnectionPoint[]

Inherited from AddBlock.outputs
- Defined in .temp/docdirectory/doc.d.ts:42770
Gets the list of output points

Returns NodeMaterialConnectionPoint[]

tangent

get tangent(): NodeMaterialConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:39367
Gets the tangent input component

Returns NodeMaterialConnectionPoint

target

get target(): NodeMaterialBlockTargets
set target(value: NodeMaterialBlockTargets): any

Overrides AddBlock.target
- Defined in .temp/docdirectory/doc.d.ts:39376
Returns NodeMaterialBlockTargets
Overrides AddBlock.target
- Defined in .temp/docdirectory/doc.d.ts:39377
Parameters
- value: NodeMaterialBlockTargets
Returns any

willBeGeneratedIntoVertexShaderFromFragmentShader

get willBeGeneratedIntoVertexShaderFromFragmentShader(): boolean

Inherited from AddBlock.willBeGeneratedIntoVertexShaderFromFragmentShader
- Defined in .temp/docdirectory/doc.d.ts:42919
Gets a boolean indicating that the code of this block will be promoted to vertex shader even if connected to fragment output

Returns boolean

world

get world(): NodeMaterialConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:39371
Gets the world matrix input component

Returns NodeMaterialConnectionPoint

Methods

autoConfigureSearch playground for autoConfigure

autoConfigure(material: NodeMaterial): void

Overrides AddBlock.autoConfigure
- Defined in .temp/docdirectory/doc.d.ts:39378
Parameters
- material: NodeMaterial
Returns void

bindSearch playground for bind

bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void

Inherited from AddBlock.bind
- Defined in .temp/docdirectory/doc.d.ts:42807
Bind data to effect. Will only be called for blocks with isBindable === true

Parameters
- effect: Effect
  
  defines the effect to bind data to
- nodeMaterial: NodeMaterial
  
  defines the hosting NodeMaterial
- Optional mesh: Mesh
  
  defines the mesh that will be rendered
- Optional subMesh: SubMesh
  
  defines the submesh that will be rendered
Returns void

buildSearch playground for build

build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean

Inherited from AddBlock.build
- Defined in .temp/docdirectory/doc.d.ts:42943
Compile the current node and generate the shader code

Parameters
- state: NodeMaterialBuildState
  
  defines the current compilation state (uniforms, samplers, current string)
- activeBlocks: NodeMaterialBlock[]
  
  defines the list of active blocks (i.e. blocks to compile)
Returns boolean

true if already built

cloneSearch playground for clone

clone(scene: Scene, rootUrl?: string): NodeMaterialBlock | null

Inherited from AddBlock.clone
- Defined in .temp/docdirectory/doc.d.ts:42964
Clone the current block to a new identical block

Parameters
- scene: Scene
  
  defines the hosting scene
- Optional rootUrl: string
  
  defines the root URL to use to load textures and relative dependencies
Returns NodeMaterialBlock | null

a copy of the current block

connectToSearch playground for connectTo

connectTo(other: NodeMaterialBlock, options?: { input?: string; output?: string; outputSwizzle?: string }): this | undefined

Inherited from AddBlock.connectTo
- Defined in .temp/docdirectory/doc.d.ts:42868
Connect current block with another block

Parameters
- other: NodeMaterialBlock
  
  defines the block to connect with
- Optional options: { input?: string; output?: string; outputSwizzle?: string }
  
  define the various options to help pick the right connections
  - Optional input?: string
  - Optional output?: string
  - Optional outputSwizzle?: string
Returns this | undefined

the current block

disposeSearch playground for dispose

dispose(): void

Inherited from AddBlock.dispose
- Defined in .temp/docdirectory/doc.d.ts:42981
Release resources

Returns void

getClassNameSearch playground for getClassName

getClassName(): string

Overrides NodeMaterialBlock.getClassName
- Defined in .temp/docdirectory/doc.d.ts:39354
Gets the current class name

Returns string

the class name

getFirstAvailableInputSearch playground for getFirstAvailableInput

getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): NodeMaterialConnectionPoint | null

Inherited from AddBlock.getFirstAvailableInput
- Defined in .temp/docdirectory/doc.d.ts:42840
Will return the first available input e.g. the first one which is not an uniform or an attribute

Parameters
- Optional forOutput: Nullable<NodeMaterialConnectionPoint>
  
  defines an optional connection point to check compatibility with
Returns NodeMaterialConnectionPoint | null

the first available input or null

getFirstAvailableOutputSearch playground for getFirstAvailableOutput

getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): NodeMaterialConnectionPoint | null

Inherited from AddBlock.getFirstAvailableOutput
- Defined in .temp/docdirectory/doc.d.ts:42846
Will return the first available output e.g. the first one which is not yet connected and not a varying

Parameters
- Optional forBlock: Nullable<NodeMaterialBlock>
  
  defines an optional block to check compatibility with
Returns NodeMaterialConnectionPoint | null

the first available input or null

getInputByNameSearch playground for getInputByName

getInputByName(name: string): NodeMaterialConnectionPoint | null

Inherited from AddBlock.getInputByName
- Defined in .temp/docdirectory/doc.d.ts:42776
Find an input by its name

Parameters
- name: string
  
  defines the name of the input to look for
Returns NodeMaterialConnectionPoint | null

the input or null if not found

getOutputByNameSearch playground for getOutputByName

getOutputByName(name: string): NodeMaterialConnectionPoint | null

Inherited from AddBlock.getOutputByName
- Defined in .temp/docdirectory/doc.d.ts:42782
Find an output by its name

Parameters
- name: string
  
  defines the name of the output to look for
Returns NodeMaterialConnectionPoint | null

the output or null if not found

getSiblingOutputSearch playground for getSiblingOutput

getSiblingOutput(current: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint | null

Inherited from AddBlock.getSiblingOutput
- Defined in .temp/docdirectory/doc.d.ts:42852
Gets the sibling of the given output

Parameters
- current: NodeMaterialConnectionPoint
  
  defines the current output
Returns NodeMaterialConnectionPoint | null

the next output in the list or null

initializeSearch playground for initialize

initialize(state: NodeMaterialBuildState): void

Overrides AddBlock.initialize
- Defined in .temp/docdirectory/doc.d.ts:39359
Initialize the block and prepare the context for build

Parameters
- state: NodeMaterialBuildState
  
  defines the state that will be used for the build
Returns void

initializeDefinesSearch playground for initializeDefines

initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void

Inherited from AddBlock.initializeDefines
- Defined in .temp/docdirectory/doc.d.ts:42895
Initialize defines for shader compilation

Parameters
- mesh: AbstractMesh
  
  defines the mesh to be rendered
- nodeMaterial: NodeMaterial
  
  defines the node material requesting the update
- defines: NodeMaterialDefines
  
  defines the material defines to update
- Optional useInstances: boolean
  
  specifies that instances should be used
Returns void

isAnAncestorOfSearch playground for isAnAncestorOf

isAnAncestorOf(block: NodeMaterialBlock): boolean

Inherited from AddBlock.isAnAncestorOf
- Defined in .temp/docdirectory/doc.d.ts:42858
Checks if the current block is an ancestor of a given block

Parameters
- block: NodeMaterialBlock
  
  defines the potential descendant block to check
Returns boolean

true if block is a descendant

isReadySearch playground for isReady

isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean

Inherited from AddBlock.isReady
- Defined in .temp/docdirectory/doc.d.ts:42928
Checks if the block is ready

Parameters
- mesh: AbstractMesh
  
  defines the mesh to be rendered
- nodeMaterial: NodeMaterial
  
  defines the node material requesting the update
- defines: NodeMaterialDefines
  
  defines the material defines to update
- Optional useInstances: boolean
  
  specifies that instances should be used
Returns boolean

true if the block is ready

prepareDefinesSearch playground for prepareDefines

prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void

Overrides AddBlock.prepareDefines
- Defined in .temp/docdirectory/doc.d.ts:39379
Parameters
- mesh: AbstractMesh
- nodeMaterial: NodeMaterial
- defines: NodeMaterialDefines
Returns void

provideFallbacksSearch playground for provideFallbacks

provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void

Inherited from AddBlock.provideFallbacks
- Defined in .temp/docdirectory/doc.d.ts:42887
Add potential fallbacks if shader compilation fails

Parameters
- mesh: AbstractMesh
  
  defines the mesh to be rendered
- fallbacks: EffectFallbacks
  
  defines the current prioritized list of fallbacks
Returns void

registerInputSearch playground for registerInput

registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this

Inherited from AddBlock.registerInput
- Defined in .temp/docdirectory/doc.d.ts:42825
Register a new input. Must be called inside a block constructor

Parameters
- name: string
  
  defines the connection point name
- type: NodeMaterialBlockConnectionPointTypes
  
  defines the connection point type
- Optional isOptional: boolean
  
  defines a boolean indicating that this input can be omitted
- Optional target: NodeMaterialBlockTargets
  
  defines the target to use to limit the connection point (will be VertexAndFragment by default)
- Optional point: NodeMaterialConnectionPoint
  
  an already created connection point. If not provided, create a new one
Returns this

the current block

registerOutputSearch playground for registerOutput

registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this

Inherited from AddBlock.registerOutput
- Defined in .temp/docdirectory/doc.d.ts:42834
Register a new output. Must be called inside a block constructor

Parameters
- name: string
  
  defines the connection point name
- type: NodeMaterialBlockConnectionPointTypes
  
  defines the connection point type
- Optional target: NodeMaterialBlockTargets
  
  defines the target to use to limit the connection point (will be VertexAndFragment by default)
- Optional point: NodeMaterialConnectionPoint
  
  an already created connection point. If not provided, create a new one
Returns this

the current block

replaceRepeatableContentSearch playground for replaceRepeatableContent

replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void

Inherited from AddBlock.replaceRepeatableContent
- Defined in .temp/docdirectory/doc.d.ts:42917
Function called when a block is declared as repeatable content generator

Parameters
- vertexShaderState: NodeMaterialBuildState
  
  defines the current compilation state for the vertex shader
- fragmentShaderState: NodeMaterialBuildState
  
  defines the current compilation state for the fragment shader
- mesh: AbstractMesh
  
  defines the mesh to be rendered
- defines: NodeMaterialDefines
  
  defines the material defines to update
Returns void

serializeSearch playground for serialize

serialize(): any

Inherited from AddBlock.serialize
- Defined in .temp/docdirectory/doc.d.ts:42969
Serializes this block in a JSON representation

Returns any

the serialized block object

updateUniformsAndSamplesSearch playground for updateUniformsAndSamples

updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void

Inherited from AddBlock.updateUniformsAndSamples
- Defined in .temp/docdirectory/doc.d.ts:42881
Add uniforms, samplers and uniform buffers at compilation time

Parameters
- state: NodeMaterialBuildState
  
  defines the state to update
- nodeMaterial: NodeMaterial
  
  defines the node material requesting the update
- defines: NodeMaterialDefines
  
  defines the material defines to update
- uniformBuffers: string[]
  
  defines the list of uniform buffer names
Returns void

validateBlockNameSearch playground for validateBlockName

validateBlockName(newName: string): boolean

Inherited from AddBlock.validateBlockName
- Defined in .temp/docdirectory/doc.d.ts:42936
Validates the new name for the block node.

Parameters
- newName: string
  
  the new name to be given to the node.
Returns boolean

false if the name is a reserve word, else true.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

Returns TBNBlock

Properties

commentsSearch playground for comments

inputsAreExclusiveSearch playground for inputsAreExclusive

uniqueIdSearch playground for uniqueId

visibleInInspectorSearch playground for visibleInInspector

visibleOnFrameSearch playground for visibleOnFrame

Accessors

TBN

Returns NodeMaterialConnectionPoint

buildId

Returns number

Parameters

value: number

Returns any

inputs

Returns NodeMaterialConnectionPoint[]

isFinalMerger

Returns boolean

isInput

Returns boolean

isUnique

Returns boolean

name

Returns string

Parameters

newName: string

Returns any

normal

Returns NodeMaterialConnectionPoint

outputs

Returns NodeMaterialConnectionPoint[]

tangent

Returns NodeMaterialConnectionPoint

target

Returns NodeMaterialBlockTargets

Parameters

value: NodeMaterialBlockTargets

Returns any

willBeGeneratedIntoVertexShaderFromFragmentShader

Returns boolean

world

Returns NodeMaterialConnectionPoint

Methods

autoConfigureSearch playground for autoConfigure

Parameters

material: NodeMaterial

Returns void

bindSearch playground for bind

Parameters

effect: Effect

nodeMaterial: NodeMaterial

Optional mesh: Mesh

Optional subMesh: SubMesh

Returns void

buildSearch playground for build

Parameters

state: NodeMaterialBuildState

activeBlocks: NodeMaterialBlock[]

Returns boolean

cloneSearch playground for clone

Parameters

scene: Scene

Optional rootUrl: string

Returns NodeMaterialBlock | null

connectToSearch playground for connectTo

Parameters

other: NodeMaterialBlock

Optional options: { input?: string; output?: string; outputSwizzle?: string }

Optional input?: string