Class InputBlock
Hierarchy (View Summary)
- NodeMaterialBlock
- InputBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new InputBlock(
name: string,
target?: NodeMaterialBlockTargets,
type?: NodeMaterialBlockConnectionPointTypes,
): InputBlockCreates a new InputBlock
Parameters
- name: string
defines the block name
- target: NodeMaterialBlockTargets = NodeMaterialBlockTargets.Vertex
defines the target of that block (Vertex by default)
- type: NodeMaterialBlockConnectionPointTypes = NodeMaterialBlockConnectionPointTypes.AutoDetect
defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
Returns InputBlock
- name: string
Properties
comments
Gets or sets the comments associated with this block
convert
Gets or sets a boolean indicating if content needs to be converted to gamma space (for color3/4 only)
convert
Gets or sets a boolean indicating if content needs to be converted to linear space (for color3/4 only)
group
Gets or sets the group to use to display this block in the Inspector
inputs
Gets or sets a boolean indicating that only one input can be connected at a time
is
Gets or set a value indicating that this input can only get 0 and 1 values
is
Gets or sets a boolean indicating that the value of this input will not change after a build
matrix
Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix
max
Gets or set a value used to limit the range of float values
min
Gets or set a value used to limit the range of float values
on
Observable raised when the block code is ready (if the code loading is async)
on
Gets an observable raised when the value is changed
unique
Gets or sets the unique id of the node
visible
Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default)
visible
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
animation
-
Gets or sets the type of animation applied to the input
Returns AnimatedInputBlockTypes
-
Parameters
- value: AnimatedInputBlockTypes
Returns void
associated
-
get associatedVariableName(): string
Gets or sets the associated variable name in the shader
Returns string
-
set associatedVariableName(value: string): void
Parameters
- value: string
Returns void
build
-
get buildId(): number
Gets or sets the build Id
Returns number
-
set buildId(value: number): void
Parameters
- value: number
Returns void
code
-
get codeIsReady(): boolean
Gets a boolean indicating that this block has is code ready to be used
Returns boolean
declaration
-
get declarationVariableName(): string
Gets the declaration variable name in the shader
Returns string
inputs
-
Gets the list of input points
Returns NodeMaterialConnectionPoint[]
is
-
get isAttribute(): boolean
Gets or sets a boolean indicating that this connection point is coming from an attribute. In this case the connection point name must be the name of the attribute to use Can only be set on inputs
Returns boolean
-
set isAttribute(value: boolean): void
Parameters
- value: boolean
Returns void
is
-
get isFinalMerger(): boolean
Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
Returns boolean
is
-
get isInput(): boolean
Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
Returns boolean
is
-
get isLoop(): boolean
Gets a boolean indicating if this block is a loop
Returns boolean
is
-
get isSystemValue(): boolean
Gets a boolean indicating that the current connection point is a system value
Returns boolean
is
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is
-
get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out
Returns boolean
is
-
get isUndefined(): boolean
Gets a boolean indicating that this connection point not defined yet
Returns boolean
is
-
get isUniform(): boolean
Gets or sets a boolean indicating that this connection point is coming from an uniform. In this case the connection point name must be the name of the uniform to use. Can only be set on inputs
Returns boolean
-
set isUniform(value: boolean): void
Parameters
- value: boolean
Returns void
is
-
get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per NodeMaterial
Returns boolean
is
-
get isVarying(): boolean
Gets or sets a boolean indicating that this connection point is generating a varying variable. Can only be set on exit points
Returns boolean
-
set isVarying(value: boolean): void
Parameters
- value: boolean
Returns void
name
-
get name(): string
Gets the name of the block
Returns string
-
set name(newName: string): void
Sets the name of the block. Will check if the name is valid.
Parameters
- newName: string
Returns void
output
-
Gets the output component
Returns NodeMaterialConnectionPoint
outputs
-
Gets the list of output points
Returns NodeMaterialConnectionPoint[]
system
-
Gets or sets the current well known value or null if not defined as a system value
Returns Nullable<NodeMaterialSystemValues>
-
Parameters
- value: Nullable<NodeMaterialSystemValues>
Returns void
target
-
Gets or sets the target of the block
Returns NodeMaterialBlockTargets
-
Parameters
- value: NodeMaterialBlockTargets
Returns void
type
-
Gets or sets the connection point type (default is float)
Returns NodeMaterialBlockConnectionPointTypes
value
-
get value(): any
Gets or sets the value of that point. Please note that this value will be ignored if valueCallback is defined
Returns any
-
set value(value: any): void
Parameters
- value: any
Returns void
value
-
get valueCallback(): () => any
Gets or sets a callback used to get the value of that point. Please note that setting this value will force the connection point to ignore the value property
Returns () => any
-
set valueCallback(value: () => any): void
Parameters
- value: () => any
Returns void
will
-
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
Methods
_
-
Deserializes the block
Parameters
- serializationObject: any
defines the serialized object
- scene: Scene
defines the scene
- rootUrl: string
defines the root URL
Returns void
- serializationObject: any
animate
-
Animate the input if animationType !== None
Parameters
- scene: Scene
defines the rendering scene
Returns void
- scene: Scene
auto
-
autoConfigure(
material: NodeMaterial,
additionalFilteringInfo?: (node: NodeMaterialBlock) => boolean,
): voidLets the block try to connect some inputs automatically
Parameters
- material: NodeMaterial
defines the hosting NodeMaterial
- additionalFilteringInfo: (node: NodeMaterialBlock) => boolean = ...
optional additional filtering condition when looking for compatible blocks
Returns void
- material: NodeMaterial
bind
-
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: Meshdefines the mesh that will be rendered
OptionalsubMesh: SubMeshdefines the submesh that will be rendered
Returns void
- effect: Effect
build
-
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
- state: NodeMaterialBuildState
clone
-
Clone the current block to a new identical block
Parameters
- scene: Scene
defines the hosting scene
- rootUrl: string = ""
defines the root URL to use to load textures and relative dependencies
Returns NodeMaterialBlock | null
a copy of the current block
- scene: Scene
connect
-
connectTo(
other: NodeMaterialBlock,
options?: { input?: string; output?: string; outputSwizzle?: string },
): InputBlock | undefinedConnect 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 InputBlock | undefined
the current block
- other: NodeMaterialBlock
dispose
-
Releases the resources held by the block
Returns void
get
-
Gets the current class name
Returns string
the class name
get
-
getFirstAvailableInput(
forOutput?: Nullable<NodeMaterialConnectionPoint>,
): NodeMaterialConnectionPoint | nullWill return the first available input e.g. the first one which is not an uniform or an attribute
Parameters
- forOutput: Nullable<NodeMaterialConnectionPoint> = null
defines an optional connection point to check compatibility with
Returns NodeMaterialConnectionPoint | null
the first available input or null
- forOutput: Nullable<NodeMaterialConnectionPoint> = null
get
-
getFirstAvailableOutput(
forBlock?: Nullable<NodeMaterialBlock>,
): NodeMaterialConnectionPoint | nullWill return the first available output e.g. the first one which is not yet connected and not a varying
Parameters
- forBlock: Nullable<NodeMaterialBlock> = null
defines an optional block to check compatibility with
Returns NodeMaterialConnectionPoint | null
the first available input or null
- forBlock: Nullable<NodeMaterialBlock> = null
get
-
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
- name: string
get
-
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
- name: string
get
-
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
- current: NodeMaterialConnectionPoint
initialize
-
Initialize the block
Returns void
initialize
-
Initialize defines for shader compilation
Parameters
- defines: NodeMaterialDefines
defines the material defines to update
Returns void
- defines: NodeMaterialDefines
is
-
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
- block: NodeMaterialBlock
is
-
Gets a boolean indicating that this connection will be used in the fragment shader
Returns boolean
true if connected in fragment shader
is
-
isReady(
mesh: AbstractMesh,
nodeMaterial: NodeMaterial,
defines: NodeMaterialDefines,
useInstances?: boolean,
): booleanChecks 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
- useInstances: boolean = false
specifies that instances should be used
Returns boolean
true if the block is ready
- mesh: AbstractMesh
prepare
-
prepareDefines(
defines: NodeMaterialDefines,
nodeMaterial: NodeMaterial,
mesh?: AbstractMesh,
useInstances?: boolean,
subMesh?: SubMesh,
): voidUpdate defines for shader compilation
Parameters
- defines: NodeMaterialDefines
defines the material defines to update
- nodeMaterial: NodeMaterial
defines the node material requesting the update
Optionalmesh: AbstractMeshdefines the mesh to be rendered
- useInstances: boolean = false
specifies that instances should be used
OptionalsubMesh: SubMeshdefines which submesh to render
Returns void
- defines: NodeMaterialDefines
provide
-
Add potential fallbacks if shader compilation fails
Parameters
- fallbacks: EffectFallbacks
defines the current prioritized list of fallbacks
Optionalmesh: AbstractMeshdefines the mesh to be rendered
Returns void
- fallbacks: EffectFallbacks
register
-
registerInput(
name: string,
type: NodeMaterialBlockConnectionPointTypes,
isOptional?: boolean,
target?: NodeMaterialBlockTargets,
point?: NodeMaterialConnectionPoint,
): InputBlockRegister 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
- isOptional: boolean = false
defines a boolean indicating that this input can be omitted
Optionaltarget: NodeMaterialBlockTargetsdefines the target to use to limit the connection point (will be VertexAndFragment by default)
Optionalpoint: NodeMaterialConnectionPointan already created connection point. If not provided, create a new one
Returns InputBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeMaterialBlockConnectionPointTypes,
target?: NodeMaterialBlockTargets,
point?: NodeMaterialConnectionPoint,
): InputBlockRegister 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: NodeMaterialBlockTargetsdefines the target to use to limit the connection point (will be VertexAndFragment by default)
Optionalpoint: NodeMaterialConnectionPointan already created connection point. If not provided, create a new one
Returns InputBlock
the current block
- name: string
replace
-
replaceRepeatableContent(
vertexShaderState: NodeMaterialBuildState,
defines: NodeMaterialDefines,
mesh?: AbstractMesh,
): voidFunction called when a block is declared as repeatable content generator
Parameters
- vertexShaderState: NodeMaterialBuildState
defines the current compilation state for the vertex shader
- defines: NodeMaterialDefines
defines the material defines to update
Optionalmesh: AbstractMeshdefines the mesh to be rendered
Returns void
- vertexShaderState: NodeMaterialBuildState
serialize
-
Serializes the block
Returns any
the serialized object
set
-
Set the source of this connection point to a vertex attribute
Parameters
OptionalattributeName: stringdefines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
Returns InputBlock
the current connection point
set
-
Set the source of this connection point to a system value
Parameters
- value: Nullable<NodeMaterialSystemValues>
define the system value to use (world, view, etc...) or null to switch to manual value
Returns InputBlock
the current connection point
- value: Nullable<NodeMaterialSystemValues>
set
-
Set the input block to its default value (based on its type)
Returns void
update
-
updateUniformsAndSamples(
state: NodeMaterialBuildState,
nodeMaterial: NodeMaterial,
defines: NodeMaterialDefines,
uniformBuffers: string[],
): voidAdd 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
- state: NodeMaterialBuildState
validate
-
Validates if a name is a reserve word.
Parameters
- newName: string
the new name to be given to the node.
Returns boolean
false if the name is a reserve word, else true.
- newName: string
Block used to expose an input value