Vector3TransformBlock

Block used to transform a vector3 with a matrix

Hierarchy

Index

Constructors

constructor

Find examples in Playground

Properties

buildId

Find examples in Playground
buildId: number

Gets or sets the build Id

complement

Find examples in Playground
complement: number

Defines the value to use to complement Vector3 to transform it to a Vector4

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)

name

Find examples in Playground
name: string

Gets or sets the name of the block

outputs

Find examples in Playground

Gets the list of output points

target

Find examples in Playground

Gets or sets the target of the block

transform

Find examples in Playground

Gets the matrix transform input

vector

Find examples in Playground

Gets the vector input

Methods

autoConfigure

Find examples in Playground
  • autoConfigure(): void

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

    Returns this | undefined

    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

initialize

Find examples in Playground

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 VetexAndFragment by default)

    Returns this

    the current block

registerOutput

Find examples in Playground

replaceRepeatableContent

Find examples in Playground

Generated using TypeDoc