Class ConstantScalarVariableShaderNode<T>

A shader node that represents a constant scalar variable. This node extends the base ConstantVariableShaderNode specifically for scalar values, providing functionality to set and manage scalar constant values in shader programs.

Type Parameters

  • T extends ComponentTypeEnum

    The component type enum that defines the data type of the scalar value

Hierarchy

  • ConstantVariableShaderNode<typeof CompositionType.Scalar, T>
    • ConstantScalarVariableShaderNode

Constructors

constructor

Properties

__commonPart? __inputConnections __inputs __outputs __shaderFunctionName __shaderNodeUid _tags InvalidObjectUID _shaderNodes currentMaxObjectCount

Accessors

inputConnections objectUID shaderFunctionName shaderNodeUid uniqueName

Methods

_copyFrom addInputConnection getInput getInputs getOutput getOutputs getShaderCode getShaderFunctionNameDerivative getShaderStage getSocketOutput getTag getTagValue hasTag makeCallStatement matchTag matchTags matchTagsAsFreeStrings removeTag setDefaultInputValue setShaderStage tryToSetTag tryToSetUniqueName unregister validateTagString _reset getRnObject getRnObjectByName getShaderNodeByUid searchByTag

Constructors

constructor

Properties

Protected Optional__commonPart

__commonPart?: CommonShaderPart

Protected__inputConnections

__inputConnections: ShaderNodeInputConnectionType[] = []

Protected__inputs

__inputs: Socket<string, CompositionTypeEnum, ComponentTypeEnum, SocketDefaultValue>[] = []

Protected__outputs

__outputs: Socket<string, CompositionTypeEnum, ComponentTypeEnum, SocketDefaultValue>[] = []

Protected__shaderFunctionName

__shaderFunctionName: string

Protected__shaderNodeUid

__shaderNodeUid: number

_tags

_tags: RnTags = {}

Collection of tags associated with this object

Static ReadonlyInvalidObjectUID

InvalidObjectUID: -1 = -1

Invalid object UID constant

Static_shaderNodes

_shaderNodes: AbstractShaderNode[] = []

StaticcurrentMaxObjectCount

currentMaxObjectCount: number = 0

Current maximum object count for UID generation

Accessors

inputConnections

  • get inputConnections(): ShaderNodeInputConnectionType[]

  • Gets all input connections for this node.

    Returns ShaderNodeInputConnectionType[]

    An array of input connection configurations

objectUID

  • get objectUID(): number

  • Gets the unique object identifier

    Returns number

    The object's UID

shaderFunctionName

shaderNodeUid

uniqueName

  • get uniqueName(): string

  • Gets the unique name of this object

    Returns string

    The unique name string

Methods

_copyFrom

  • _copyFrom(rnObject): void
  • Internal

    Copies tag data from another RnObject instance to this object

    Parameters

    • rnObject: RnObject

      The source RnObject to copy tags from

    Returns void

addInputConnection

  • addInputConnection<N, T>(inputShaderNode, outputSocketOfInput, inputSocketOfThis): void

  • Adds an input connection to this node from another shader node. This establishes a data flow connection between the output of one node and the input of this node.

    Type Parameters

    Parameters

    • inputShaderNode: AbstractShaderNode

      The source shader node to connect from

    • outputSocketOfInput: Socket<string, N, T, SocketDefaultValue>

      The output socket of the source node

    • inputSocketOfThis: Socket<string, N, T, SocketDefaultValue>

      The input socket of this node to connect to

    Returns void

getInput

getInputs

getOutput

getOutputs

getShaderCode

  • getShaderCode(shaderStage): string

  • Retrieves the shader code for the specified shader stage. Returns appropriate code based on the current rendering approach (WebGL/WebGPU).

    Parameters

    • shaderStage: EnumIO

      The shader stage (vertex or fragment) to get code for

    Returns string

    The shader code string for the specified stage

getShaderFunctionNameDerivative

  • getShaderFunctionNameDerivative(): string

  • Gets the derivative shader function name for this node. By default, returns the same as the regular function name.

    Returns string

    The derivative function name used in shader code

getShaderStage

getSocketOutput

getTag

  • getTag(tagName): Tag

  • Retrieves a complete tag object (name and value) for the specified tag name

    Parameters

    • tagName: string

      The name of the tag to retrieve

    Returns Tag

    A Tag object containing the name and value

getTagValue

  • getTagValue(tagName): any

  • Retrieves the value associated with a specific tag name

    Parameters

    • tagName: string

      The name of the tag whose value to retrieve

    Returns any

    The tag value, or undefined if the tag doesn't exist

hasTag

  • hasTag(tagName): boolean

  • Checks whether this object has a tag with the specified name

    Parameters

    • tagName: string

      The name of the tag to check for

    Returns boolean

    True if the tag exists (value is not null/undefined), false otherwise

makeCallStatement

  • makeCallStatement(i, shaderNode, functionName, varInputNames, varOutputNames): string

  • Generates a function call statement for this shader node in the final shader code. This method constructs the appropriate function call syntax with proper parameter passing for both WebGL and WebGPU rendering approaches.

    Parameters

    • i: number

      The index of this node in the execution order

    • shaderNode: AbstractShaderNode

      The shader node to generate the call for

    • functionName: string

      The name of the function to call

    • varInputNames: string[][]

      Array of input variable names for each node

    • varOutputNames: string[][]

      Array of output variable names for each node

    Returns string

    The generated function call statement string

matchTag

  • matchTag(tagName, tagValue): boolean

  • Checks if this object has a tag with the specified name and value

    Parameters

    • tagName: string

      The tag name to match

    • tagValue: string

      The tag value to match

    Returns boolean

    True if the object has a matching tag, false otherwise

matchTags

  • matchTags(tags): boolean

  • Checks if this object has all the specified tags with exactly matching values

    Parameters

    • tags: RnTags

      Object containing tag names as keys and expected values

    Returns boolean

    True if all specified tags exist with matching values, false otherwise

matchTagsAsFreeStrings

  • matchTagsAsFreeStrings(stringArray): boolean

  • Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

    Parameters

    • stringArray: string[]

      Array of strings that must all be present in the combined tag string

    Returns boolean

    True if all strings are found in the combined tag string, false otherwise

removeTag

  • removeTag(tagName): void

  • Removes a tag from this object

    Parameters

    • tagName: string

      The name of the tag to remove

    Returns void

setDefaultInputValue

  • setDefaultInputValue(value): void

  • Sets the default input value for this constant scalar shader node. This method updates the underlying constant value used by the shader.

    Parameters

    • value: IScalar

      The scalar value to set as the constant input value

    Returns void

setShaderStage

  • setShaderStage(stage): void

  • Sets the shader stage for this node (Neutral, Vertex, or Fragment).

    Parameters

    • stage: ShaderStage

      The shader stage to assign to this node

    Returns void

tryToSetTag

  • tryToSetTag(tag): boolean

  • Attempts to set a tag on this object. If the tag already exists, it will be replaced.

    Parameters

    • tag: Tag

      The tag object containing the name and value to set

    Returns boolean

    True if the tag was successfully set, false if the tag name contains invalid characters

tryToSetUniqueName

  • tryToSetUniqueName(name, toAddNameIfConflict): boolean

  • Attempts to set a unique name for this object

    Parameters

    • name: string

      The desired unique name

    • toAddNameIfConflict: boolean

      If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

    Returns boolean

    True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

unregister

  • unregister(): void

  • Unregisters this object from all tracking collections. Should be called when the object is being destroyed.

    Returns void

validateTagString

  • validateTagString(val): boolean

  • Validates that a tag string contains only allowed characters (alphanumeric and underscore)

    Parameters

    • val: string

      The string to validate

    Returns boolean

    True if the string contains only valid characters, false if it contains invalid characters

Static_reset

  • _reset(): void
  • Internal

    Resets all static object tracking data. Used primarily for testing.

    Returns void

StaticgetRnObject

  • getRnObject(objectUid): undefined | RnObject

  • Retrieves an RnObject instance by its unique identifier

    Parameters

    • objectUid: number

      The unique identifier of the object to retrieve

    Returns undefined | RnObject

    The RnObject instance or undefined if not found or garbage collected

StaticgetRnObjectByName

  • getRnObjectByName(uniqueName): undefined | RnObject

  • Retrieves an RnObject instance by its unique name

    Parameters

    • uniqueName: string

      The unique name of the object to retrieve

    Returns undefined | RnObject

    The RnObject instance or undefined if not found or garbage collected

StaticgetShaderNodeByUid

StaticsearchByTag

  • searchByTag(tag, value): undefined | WeakRef<RnObject>

  • Searches for the first object that has a specific tag with the given value

    Parameters

    • tag: string

      The tag name to search for

    • value: string

      The tag value to match

    Returns undefined | WeakRef<RnObject>

    WeakRef to the first matching object, or undefined if not found

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods