Class ClearCoatBlock
Hierarchy (View Summary)
- NodeMaterialBlock
- ClearCoatBlock
Index
Constructors
Properties
Accessors
Methods
Properties
comments
Gets or sets the comments associated with this block
inputs
Gets or sets a boolean indicating that only one input can be connected at a time
on
Observable raised when the block code is ready (if the code loading is async)
remap
Defines if the F0 value should be remapped to account for the interface change in the material.
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
build
-
get buildId(): number
Gets or sets the build Id
Returns number
-
set buildId(value: number): void
Parameters
- value: number
Returns void
clearcoat
-
Gets the clear coat object output component
Returns NodeMaterialConnectionPoint
code
-
get codeIsReady(): boolean
Gets a boolean indicating that this block has is code ready to be used
Returns boolean
index
-
Gets the ior input component
Returns NodeMaterialConnectionPoint
inputs
-
Gets the list of input points
Returns NodeMaterialConnectionPoint[]
intensity
-
Gets the intensity input component
Returns NodeMaterialConnectionPoint
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 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 isUnique(): boolean
Gets a boolean indicating that this block can only be used once per NodeMaterial
Returns boolean
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
normal
-
Gets the bump texture input component
Returns NodeMaterialConnectionPoint
outputs
-
Gets the list of output points
Returns NodeMaterialConnectionPoint[]
roughness
-
Gets the roughness input component
Returns NodeMaterialConnectionPoint
target
-
Gets or sets the target of the block
Returns NodeMaterialBlockTargets
-
Parameters
- value: NodeMaterialBlockTargets
Returns void
TBN
-
Gets the TBN input component
Returns NodeMaterialConnectionPoint
tint
-
Gets the tint "at distance" input component
Returns NodeMaterialConnectionPoint
tint
-
Gets the tint color input component
Returns NodeMaterialConnectionPoint
tint
-
Gets the tint thickness input component
Returns NodeMaterialConnectionPoint
uv
-
Gets the uv input component
Returns NodeMaterialConnectionPoint
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
world
-
Gets the world normal input component
Returns NodeMaterialConnectionPoint
world
-
Gets the world tangent input component
Returns NodeMaterialConnectionPoint
Methods
_
-
Deserializes the block
Parameters
- serializationObject: any
the object to deserialize from
- scene: Scene
the scene to deserialize in
- rootUrl: string
the root URL for assets
Returns void
- serializationObject: any
auto
-
Auto configure the block based on the material
Returns void
bind
-
Bind data to effect
Parameters
- effect: Effect
the effect to bind data to
- nodeMaterial: NodeMaterial
the node material
Optionalmesh: Meshthe mesh to bind data for
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 },
): ClearCoatBlock | 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 ClearCoatBlock | undefined
the current block
- other: NodeMaterialBlock
dispose
-
Release resources
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 and prepare the context for build
Parameters
- state: NodeMaterialBuildState
defines the state that will be used for the build
Returns void
- state: NodeMaterialBuildState
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
-
Prepare the list of defines
Parameters
- defines: NodeMaterialDefines
the list of defines to update
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,
): ClearCoatBlockRegister 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 ClearCoatBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeMaterialBlockConnectionPointTypes,
target?: NodeMaterialBlockTargets,
point?: NodeMaterialConnectionPoint,
): ClearCoatBlockRegister 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 ClearCoatBlock
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
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 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.
- newName: string
StaticGet
-
GetCode(
state: NodeMaterialBuildState,
ccBlock: Nullable<ClearCoatBlock>,
reflectionBlock: Nullable<ReflectionBlock>,
worldPosVarName: string,
generateTBNSpace: boolean,
vTBNAvailable: boolean,
worldNormalVarName: string,
): stringGets the main code of the block (fragment side)
Parameters
- state: NodeMaterialBuildState
current state of the node material building
- ccBlock: Nullable<ClearCoatBlock>
instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
- reflectionBlock: Nullable<ReflectionBlock>
instance of a ReflectionBlock null if the code must be generated without an active reflection module
- worldPosVarName: string
name of the variable holding the world position
- generateTBNSpace: boolean
if true, the code needed to create the TBN coordinate space is generated
- vTBNAvailable: boolean
indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
- worldNormalVarName: string
name of the variable holding the world normal
Returns string
the shader code
- state: NodeMaterialBuildState
Block used to implement the clear coat module of the PBR material