MeshAttributeExistsBlock | Babylon.js API documentation

Class MeshAttributeExistsBlock

Block used to check if Mesh attribute of specified type exists and provide an alternative fallback input for to use in such case

Hierarchy (View Summary)

NodeMaterialBlock
- MeshAttributeExistsBlock

Constructors

constructor

new MeshAttributeExistsBlock(name: string): MeshAttributeExistsBlock
Creates a new MeshAttributeExistsBlock
Parameters
- name: string
  defines the block name
Returns MeshAttributeExistsBlock
Overrides NodeMaterialBlock.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:86355

Properties

attributeType

attributeType: MeshAttributeExistsBlockTypes

Defines which mesh attribute to use

comments

comments: string

Gets or sets the comments associated with this block

inputsAreExclusive

inputsAreExclusive: boolean

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

onCodeIsReadyObservable

onCodeIsReadyObservable: Observable<NodeMaterialBlock>

Observable raised when the block code is ready (if the code loading is async)

uniqueId

uniqueId: number

Gets or sets the unique id of the node

visibleInInspector

visibleInInspector: boolean

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

visibleOnFrame

visibleOnFrame: boolean

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

Accessors

buildId

get buildId(): number
Gets or sets the build Id

Returns number
Inherited from NodeMaterialBlock.buildId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84038
set buildId(value: number): void
Parameters
- value: number
Returns void
Inherited from NodeMaterialBlock.buildId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84039

codeIsReady

get codeIsReady(): boolean
Gets a boolean indicating that this block has is code ready to be used

Returns boolean
Inherited from NodeMaterialBlock.codeIsReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:83998

fallback

get fallback(): NodeMaterialConnectionPoint
Gets the fallback component when speciefied attribute doesn't exist

Returns NodeMaterialConnectionPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:86372

input

get input(): NodeMaterialConnectionPoint
Gets the input component

Returns NodeMaterialConnectionPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:86368

inputs

get inputs(): NodeMaterialConnectionPoint[]
Gets the list of input points

Returns NodeMaterialConnectionPoint[]
Inherited from NodeMaterialBlock.inputs
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84048

isFinalMerger

get isFinalMerger(): boolean
Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)

Returns boolean
Inherited from NodeMaterialBlock.isFinalMerger
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84018

isInput

get isInput(): boolean
Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)

Returns boolean
Inherited from NodeMaterialBlock.isInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84022

isLoop

get isLoop(): boolean
Gets a boolean indicating if this block is a loop

Returns boolean
Inherited from NodeMaterialBlock.isLoop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84034

isTeleportIn

get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in

Returns boolean
Inherited from NodeMaterialBlock.isTeleportIn
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84030

isTeleportOut

get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out

Returns boolean
Inherited from NodeMaterialBlock.isTeleportOut
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84026

isUnique

get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per NodeMaterial

Returns boolean
Inherited from NodeMaterialBlock.isUnique
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84014

name

get name(): string
Gets the name of the block

Returns string
Inherited from NodeMaterialBlock.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:83994
set name(newName: string): void
Sets the name of the block. Will check if the name is valid.
Parameters
- newName: string
Returns void
Inherited from NodeMaterialBlock.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84002

output

get output(): NodeMaterialConnectionPoint
Gets the output component

Returns NodeMaterialConnectionPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:86376

outputs

get outputs(): NodeMaterialConnectionPoint[]
Gets the list of output points

Returns NodeMaterialConnectionPoint[]
Inherited from NodeMaterialBlock.outputs
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84050

target

get target(): NodeMaterialBlockTargets
Gets or sets the target of the block

Returns NodeMaterialBlockTargets
Inherited from NodeMaterialBlock.target
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84043
set target(value: NodeMaterialBlockTargets): void
Parameters
- value: NodeMaterialBlockTargets
Returns void
Inherited from NodeMaterialBlock.target
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84044

willBeGeneratedIntoVertexShaderFromFragmentShader

get willBeGeneratedIntoVertexShaderFromFragmentShader(): boolean
Gets a boolean indicating that the code of this block will be promoted to vertex shader even if connected to fragment output

Returns boolean
Inherited from NodeMaterialBlock.willBeGeneratedIntoVertexShaderFromFragmentShader
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84206

Methods

autoConfigure

autoConfigure(
material: NodeMaterial,
additionalFilteringInfo?: (node: NodeMaterialBlock) => boolean,
): void
Lets the block try to connect some inputs automatically
Parameters
- material: NodeMaterial
  defines the hosting NodeMaterial
- OptionaladditionalFilteringInfo: (node: NodeMaterialBlock) => boolean
  optional additional filtering condition when looking for compatible blocks
Returns void
Inherited from NodeMaterialBlock.autoConfigure
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84196

bind

bind(
    effect: Effect,
    nodeMaterial: NodeMaterial,
    mesh?: Mesh,
    subMesh?: SubMesh,
): void
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
- Optionalmesh: Mesh
  defines the mesh that will be rendered
- OptionalsubMesh: SubMesh
  defines the submesh that will be rendered
Returns void
Inherited from NodeMaterialBlock.bind
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84089

build

build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean
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
Inherited from NodeMaterialBlock.build
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84231

clone

clone(scene: Scene, rootUrl?: string): null | NodeMaterialBlock
Clone the current block to a new identical block
Parameters
- scene: Scene
  defines the hosting scene
- OptionalrootUrl: string
  defines the root URL to use to load textures and relative dependencies
Returns null | NodeMaterialBlock
a copy of the current block
Inherited from NodeMaterialBlock.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84249

connectTo

connectTo(
other: NodeMaterialBlock,
options?: { input?: string; output?: string; outputSwizzle?: string },
): undefined | MeshAttributeExistsBlock
Connect current block with another block
Parameters
- other: NodeMaterialBlock
  defines the block to connect with
- Optionaloptions: { input?: string; output?: string; outputSwizzle?: string }
  define the various options to help pick the right connections
Returns undefined | MeshAttributeExistsBlock
the current block
Inherited from NodeMaterialBlock.connectTo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84153

dispose

dispose(): void
Release resources

Returns void
Inherited from NodeMaterialBlock.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84263

getClassName

getClassName(): string
Gets the current class name

Returns string
the class name
Overrides NodeMaterialBlock.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:86360

getFirstAvailableInput

getFirstAvailableInput(
forOutput?: Nullable<NodeMaterialConnectionPoint>,
): null | NodeMaterialConnectionPoint
Will return the first available input e.g. the first one which is not an uniform or an attribute
Parameters
- OptionalforOutput: Nullable<NodeMaterialConnectionPoint>
  defines an optional connection point to check compatibility with
Returns null | NodeMaterialConnectionPoint
the first available input or null
Inherited from NodeMaterialBlock.getFirstAvailableInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84125

getFirstAvailableOutput

getFirstAvailableOutput(
forBlock?: Nullable<NodeMaterialBlock>,
): null | NodeMaterialConnectionPoint
Will return the first available output e.g. the first one which is not yet connected and not a varying
Parameters
- OptionalforBlock: Nullable<NodeMaterialBlock>
  defines an optional block to check compatibility with
Returns null | NodeMaterialConnectionPoint
the first available input or null
Inherited from NodeMaterialBlock.getFirstAvailableOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84131

getInputByName

getInputByName(name: string): null | NodeMaterialConnectionPoint
Find an input by its name
Parameters
- name: string
  defines the name of the input to look for
Returns null | NodeMaterialConnectionPoint
the input or null if not found
Inherited from NodeMaterialBlock.getInputByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84056

getOutputByName

getOutputByName(name: string): null | NodeMaterialConnectionPoint
Find an output by its name
Parameters
- name: string
  defines the name of the output to look for
Returns null | NodeMaterialConnectionPoint
the output or null if not found
Inherited from NodeMaterialBlock.getOutputByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84062

getSiblingOutput

getSiblingOutput(
current: NodeMaterialConnectionPoint,
): null | NodeMaterialConnectionPoint
Gets the sibling of the given output
Parameters
- current: NodeMaterialConnectionPoint
  defines the current output
Returns null | NodeMaterialConnectionPoint
the next output in the list or null
Inherited from NodeMaterialBlock.getSiblingOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84137

initialize

initialize(state: NodeMaterialBuildState): void
Initialize the block and prepare the context for build
Parameters
- state: NodeMaterialBuildState
  defines the state that will be used for the build
Returns void
Inherited from NodeMaterialBlock.initialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84081

initializeDefines

initializeDefines(
    mesh: AbstractMesh,
    nodeMaterial: NodeMaterial,
    defines: NodeMaterialDefines,
    useInstances?: boolean,
): void
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
- OptionaluseInstances: boolean
  specifies that instances should be used
Returns void
Inherited from NodeMaterialBlock.initializeDefines
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84181

isAnAncestorOf

isAnAncestorOf(block: NodeMaterialBlock): boolean
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
Inherited from NodeMaterialBlock.isAnAncestorOf
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84143

isConnectedInFragmentShader

isConnectedInFragmentShader(): boolean
Gets a boolean indicating that this connection will be used in the fragment shader

Returns boolean
true if connected in fragment shader
Inherited from NodeMaterialBlock.isConnectedInFragmentShader
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84100

isReady

isReady(
    mesh: AbstractMesh,
    nodeMaterial: NodeMaterial,
    defines: NodeMaterialDefines,
    useInstances?: boolean,
): boolean
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
- OptionaluseInstances: boolean
  specifies that instances should be used
Returns boolean
true if the block is ready
Inherited from NodeMaterialBlock.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84215

prepareDefines

prepareDefines(
    mesh: AbstractMesh,
    nodeMaterial: NodeMaterial,
    defines: NodeMaterialDefines,
    useInstances?: boolean,
    subMesh?: SubMesh,
): void
Update 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
- OptionaluseInstances: boolean
  specifies that instances should be used
- OptionalsubMesh: SubMesh
  defines which submesh to render
Returns void
Inherited from NodeMaterialBlock.prepareDefines
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84190

provideFallbacks

provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void
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
Inherited from NodeMaterialBlock.provideFallbacks
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84173

registerInput

registerInput(
    name: string,
    type: NodeMaterialBlockConnectionPointTypes,
    isOptional?: boolean,
    target?: NodeMaterialBlockTargets,
    point?: NodeMaterialConnectionPoint,
): this
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
- OptionalisOptional: boolean
  defines a boolean indicating that this input can be omitted
- Optionaltarget: NodeMaterialBlockTargets
  defines the target to use to limit the connection point (will be VertexAndFragment by default)
- Optionalpoint: NodeMaterialConnectionPoint
  an already created connection point. If not provided, create a new one
Returns this
the current block
Inherited from NodeMaterialBlock.registerInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84110

registerOutput

registerOutput(
    name: string,
    type: NodeMaterialBlockConnectionPointTypes,
    target?: NodeMaterialBlockTargets,
    point?: NodeMaterialConnectionPoint,
): this
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
- Optionaltarget: NodeMaterialBlockTargets
  defines the target to use to limit the connection point (will be VertexAndFragment by default)
- Optionalpoint: NodeMaterialConnectionPoint
  an already created connection point. If not provided, create a new one
Returns this
the current block
Inherited from NodeMaterialBlock.registerOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84119

replaceRepeatableContent

replaceRepeatableContent(
    vertexShaderState: NodeMaterialBuildState,
    fragmentShaderState: NodeMaterialBuildState,
    mesh: AbstractMesh,
    defines: NodeMaterialDefines,
): void
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
Inherited from NodeMaterialBlock.replaceRepeatableContent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84204

serialize

serialize(): any
Serializes this block in a JSON representation

Returns any
the serialized block object
Overrides NodeMaterialBlock.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:86378

updateUniformsAndSamples

updateUniformsAndSamples(
    state: NodeMaterialBuildState,
    nodeMaterial: NodeMaterial,
    defines: NodeMaterialDefines,
    uniformBuffers: string[],
): void
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
Inherited from NodeMaterialBlock.updateUniformsAndSamples
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84167

validateBlockName

validateBlockName(newName: string): boolean
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.
Inherited from NodeMaterialBlock.validateBlockName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:84223

Class MeshAttributeExistsBlock

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeshAttributeExistsBlock

Properties

attributeType

comments

inputsAreExclusive

onCodeIsReadyObservable

uniqueId

visibleInInspector

visibleOnFrame

Accessors

buildId

Returns number

Parameters

Returns void

codeIsReady

Returns boolean

fallback

Returns NodeMaterialConnectionPoint

input

Returns NodeMaterialConnectionPoint

inputs

Returns NodeMaterialConnectionPoint[]

isFinalMerger

Returns boolean

isInput

Returns boolean

isLoop

Returns boolean

isTeleportIn

Returns boolean

isTeleportOut

Returns boolean

isUnique

Returns boolean

name

Returns string

Parameters

Returns void

output

Returns NodeMaterialConnectionPoint

outputs

Returns NodeMaterialConnectionPoint[]

target

Returns NodeMaterialBlockTargets

Parameters

Returns void

willBeGeneratedIntoVertexShaderFromFragmentShader

Returns boolean

Methods

autoConfigure

Parameters

Returns void

bind

Parameters

Returns void

build

Parameters

Returns boolean

clone

Parameters

Returns null | NodeMaterialBlock

connectTo

Parameters

Returns undefined | MeshAttributeExistsBlock

dispose

Returns void

getClassName

Returns string

getFirstAvailableInput

Parameters