Zephyr3d

Appearance

Documentation / scene / VertexUVNode

Class: VertexUVNode ​

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

Vertex UV coordinate input node

Remarks ​

Provides access to per-vertex texture coordinates (UV coordinates) from the mesh. UV coordinates map 3D mesh vertices to 2D texture space, typically in the range [0, 1].

Used for:

  • Texture sampling (most common use)
  • Procedural pattern generation
  • Gradient effects based on position in UV space
  • Decal placement

Outputs:

  • Output 1: Full UV coordinates (vec2)
  • Output 2: U coordinate (horizontal, float)
  • Output 3: V coordinate (vertical, float)

Example ​

typescript
const uv = new VertexUVNode();

// Sample texture using UV coordinates
textureSample.connectInput(1, uv, 1);

// Use U coordinate for horizontal gradient
mixNode.connectInput(3, uv, 2);

Extends ​

Constructors ​

Constructor ​

new VertexUVNode(): VertexUVNode

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

Creates a new vertex UV node

Returns ​

VertexUVNode

Remarks ​

Initializes with 3 output slots: full UV and individual U, V 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:630

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:634

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:638

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:642

IEventTarget.dispatchEvent

Type Parameters ​

K ​

K extends "changed"

Parameters ​

type ​

K

args ​

...object[K]

Returns ​

void

Inherited from ​

BaseGraphNode.dispatchEvent

getSerializationCls() ​

static getSerializationCls(): object

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

Gets the serialization descriptor for this node type

Returns ​

object

Serialization class descriptor

ctor ​

ctor: typeof VertexUVNode = VertexUVNode

name ​

name: string = 'VertexUVNode'

getProps() ​

getProps(): any[]

Returns ​

any[]

toString() ​

toString(): string

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

Generates a string representation of this node

Returns ​

string

'vertex UV'

Overrides ​

BaseGraphNode.toString

validate() ​

protected validate(): string

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

Validates the node state

Returns ​

string

Empty string (always valid)

Remarks ​

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

Overrides ​

BaseGraphNode.validate

getType() ​

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

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

Gets the output type for a specific output slot

Parameters ​

id ​

number

The output slot ID

Returns ​

"vec2" | "float"

'float' for individual component outputs (id > 1), 'vec2' for full UV

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 ​

typescript
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

Released under the MIT License.

Copyright © Zephyr3d