Documentation / scene / VertexNormalNode

Class: VertexNormalNode

Defined in: libs/scene/src/utility/blueprint/material/inputs.ts:564

Vertex normal input node

Remarks

Provides access to per-vertex normal vectors in world space. Normals are unit vectors perpendicular to the surface, used extensively in lighting calculations and surface orientation effects.

Used for:

• Custom lighting calculations
• Fresnel effects (view-dependent shading)
• Rim lighting
• Normal-based masking
• Environment mapping

Outputs:

• Output 1: Full normal vector (vec3, normalized)
• Output 2: X component (float)
• Output 3: Y component (float)
• Output 4: Z component (float)

Example

const normal = new VertexNormalNode();
const viewDir = new ViewDirectionNode();

// Calculate Fresnel effect
const dot = new DotProductNode();
dot.connectInput(1, normal, 1);
dot.connectInput(2, viewDir, 1);

// Rim lighting using Y component
rimMask.connectInput(1, normal, 3);

Extends

• BaseGraphNode

Constructors

Constructor

new VertexNormalNode(): VertexNormalNode

Defined in: libs/scene/src/utility/blueprint/material/inputs.ts:571

Creates a new vertex normal node

Returns

VertexNormalNode

Remarks

Initializes with 4 output slots: full normal and individual X, Y, Z components.

Overrides

BaseGraphNode.constructor

Properties

_inputs

protected _inputs: GraphNodeInput[]

Defined in: libs/scene/src/utility/blueprint/node.ts:336

Internal storage for input slot definitions

Inherited from

BaseGraphNode._inputs

---

_outputs

protected _outputs: GraphNodeOutput[]

Defined in: libs/scene/src/utility/blueprint/node.ts:338

Internal storage for output slot definitions

Inherited from

BaseGraphNode._outputs

---

_error

protected _error: string

Defined in: libs/scene/src/utility/blueprint/node.ts:340

Internal storage for error message

Inherited from

BaseGraphNode._error

Accessors

isUniform

Get Signature

get isUniform(): boolean

Defined in: libs/scene/src/utility/blueprint/node.ts:357

Whether this node contains uniform value/texture

Returns

boolean

Whether this node has uniform value

Inherited from

BaseGraphNode.isUniform

---

paramName

Get Signature

get paramName(): string

Defined in: libs/scene/src/utility/blueprint/node.ts:363

Uniform parameter name

Returns

string

Uniform parameter name

Inherited from

BaseGraphNode.paramName

---

inputs

Get Signature

get inputs(): GraphNodeInput[]

Defined in: libs/scene/src/utility/blueprint/node.ts:380

Gets the input slot definitions array

Returns

GraphNodeInput[]

Array of input slot definitions

Inherited from

BaseGraphNode.inputs

---

outputs

Get Signature

get outputs(): GraphNodeOutput[]

Defined in: libs/scene/src/utility/blueprint/node.ts:384

Gets the output slot definitions array

Returns

GraphNodeOutput[]

Array of output slot definitions

Inherited from

BaseGraphNode.outputs

---

error

Get Signature

get error(): string

Defined in: libs/scene/src/utility/blueprint/node.ts:388

Gets the current error message

Returns

string

Set Signature

set error(str): void

Defined in: libs/scene/src/utility/blueprint/node.ts:391

Current error message, empty string if no error

Parameters

str

string

Returns

void

Current error message, empty string if no error

Inherited from

BaseGraphNode.error

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:594

IEventTarget.on

Type Parameters

K

K extends "changed"

Parameters

type

K

listener

EventListener<{ changed: []; }, K>

context?

unknown

Returns

void

Inherited from

BaseGraphNode.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:598

IEventTarget.once

Type Parameters

K

K extends "changed"

Parameters

type

K

listener

EventListener<{ changed: []; }, K>

context?

unknown

Returns

void

Inherited from

BaseGraphNode.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:602

IEventTarget.off

Type Parameters

K

K extends "changed"

Parameters

type

K

listener?

EventListener<{ changed: []; }>

context?

unknown

Returns

void

Inherited from

BaseGraphNode.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:606

IEventTarget.dispatchEvent

Type Parameters

K

K extends "changed"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

BaseGraphNode.dispatchEvent

---

toString()

toString(): string

Defined in: libs/scene/src/utility/blueprint/material/inputs.ts:585

Generates a string representation of this node

Returns

string

'vertex normal'

Overrides

BaseGraphNode.toString

---

getSerializationCls()

static getSerializationCls(): object

Defined in: libs/scene/src/utility/blueprint/material/inputs.ts:593

Gets the serialization descriptor for this node type

Returns

object

Serialization class descriptor

ctor

ctor: typeof VertexNormalNode = VertexNormalNode

name

name: string = 'VertexNormalNode'

getProps()

getProps(): any[]

Returns

any[]

---

validate()

protected validate(): string

Defined in: libs/scene/src/utility/blueprint/material/inputs.ts:610

Validates the node state

Returns

string

Empty string (always valid)

Remarks

Vertex normal nodes are always valid as they have no inputs.

Overrides

BaseGraphNode.validate

---

getType()

protected getType(id): "vec3" | "float"

Defined in: libs/scene/src/utility/blueprint/material/inputs.ts:619

Gets the output type for a specific output slot

Parameters

id

number

The output slot ID

Returns

"vec3" | "float"

'float' for individual component outputs (id > 1), 'vec3' for full normal

Overrides

BaseGraphNode.getType

---

getOutputType()

getOutputType(id): string

Defined in: libs/scene/src/utility/blueprint/node.ts:376

Gets the output type for a specific output slot

Parameters

id

number

The output slot ID

Returns

string

The type name of the output

Remarks

Default implementation delegates to the abstract getType() method. Can be overridden for more complex type logic.

Inherited from

BaseGraphNode.getOutputType

---

check()

check(): void

Defined in: libs/scene/src/utility/blueprint/node.ts:413

Validates the node and updates error state

Returns

void

Remarks

Calls the validate() method and stores the result in _error. Emits a 'changed' event if the error state changes.

Inherited from

BaseGraphNode.check

---

reset()

reset(): void

Defined in: libs/scene/src/utility/blueprint/node.ts:422

Clears the error state

Returns

void

Remarks

Sets _error to an empty string.

Inherited from

BaseGraphNode.reset

---

setInput()

setInput(id, node, inputId): void

Defined in: libs/scene/src/utility/blueprint/node.ts:443

Connects an input slot to another node's output

Parameters

id

number

The input slot ID to connect

node

BaseGraphNode

The source node to connect from

inputId

number

The output slot ID of the source node

Returns

void

Throws

Error if the input slot with the given ID doesn't exist

Example

const addNode = new AddNode();
const constantNode = new ConstantNode(5.0);

// Connect constantNode's output 0 to addNode's input 0
addNode.setInput(0, constantNode, 0);

Inherited from

BaseGraphNode.setInput