DistanceBlock

Block used to get the distance between 2 values

Hierarchy

Index

Constructors

constructor

Find examples in Playground

Properties

buildId

Find examples in Playground
buildId: number

Gets or sets the build Id

inputs

Find examples in Playground

Gets the list of input points

isFinalMerger

Find examples in Playground
isFinalMerger: boolean

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

isInput

Find examples in Playground
isInput: boolean

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

left

Find examples in Playground

Gets the left operand input component

name

Find examples in Playground
name: string

Gets or sets the name of the block

output

Find examples in Playground

Gets the output component

outputs

Find examples in Playground

Gets the list of output points

right

Find examples in Playground

Gets the right operand input component

target

Find examples in Playground

Gets or sets the target of the block

uniqueId

Find examples in Playground
uniqueId: number

Gets or sets the unique id of the node

Methods

autoConfigure

Find examples in Playground

bind

Find examples in Playground
  • 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

    Returns void

build

Find examples in Playground
  • 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

clone

Find examples in Playground
  • 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 Nullable<NodeMaterialBlock>

    a copy of the current block

connectTo

Find examples in Playground
  • Connect current block with another block

    Parameters

    • other: NodeMaterialBlock

      defines the block to connect with

    • Optional options: object

      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

getClassName

Find examples in Playground
  • getClassName(): string

getFirstAvailableInput

Find examples in Playground

getFirstAvailableOutput

Find examples in Playground

getInputByName

Find examples in Playground

getOutputByName

Find examples in Playground

getSiblingOutput

Find examples in Playground

initialize

Find examples in Playground

initializeDefines

Find examples in Playground
  • 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

    • Optional useInstances: boolean

      specifies that instances should be used

    Returns void

isReady

Find examples in Playground
  • 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

    • Optional useInstances: boolean

      specifies that instances should be used

    Returns boolean

    true if the block is ready

prepareDefines

Find examples in Playground
  • prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): 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

    • Optional useInstances: boolean

      specifies that instances should be used

    Returns void

provideFallbacks

Find examples in Playground

registerInput

Find examples in Playground
  • 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)

    Returns this

    the current block

registerOutput

Find examples in Playground

replaceRepeatableContent

Find examples in Playground

serialize

Find examples in Playground
  • serialize(): any
  • Serializes this block in a JSON representation

    Returns any

    the serialized block object

updateUniformsAndSamples

Find examples in Playground

Generated using TypeDoc