Class GraphVariable

The GraphVariable class implements a (local) variable within a Graph. It can be visible and editable only within the graph, or if set to public, also editable from outside.

Hierarchy (view full)

Constructors

constructor

Properties

defaultValue graph id isPublic name type

Methods

clone deleteMetaData enable getMetaData onRemove setMetaData setType validate

Constructors

constructor

Properties

defaultValue

defaultValue: any

The default value of the variable.

graph

graph: ImmutableGraph

The Graph that owns the variable.

Readonlyid

id: UUID

The UUID of the variable.

isPublic

isPublic: boolean

Determines if the variable will be modifiable when inspecting the resource.

name

name: string

The name of the variable.

Note

To change the name of a registered variable, use Graph.renameVariable.

type

type: GraphType

The GraphType of the variable.

Note

The GraphType itself is not serializable as it's identity must be globally unique. To solve this issue, the system serializes the system type via the _systemType field. Once the variable is deserialized or cloned, the GraphType is reconstructed at runtime.

Methods

clone

deleteMetaData

  • deleteMetaData<T>(key): any

  • Deletes the metadata associated with the given key from the user data.

    Type Parameters

    • T

      An interface containing a declaration of the meta data fields of the variable such as CarbonShaderGraphVariableMetaData.

    Parameters

    • key: keyof T

      The key of the metadata to delete.

    Returns any

    Note

    If the user data becomes empty after deletion, it sets the user data to undefined.

enable

  • enable(graph): void
  • Virtual

    Invoked when the variable was added to graph or after deserialized.

    Parameters

    Returns void

getMetaData

  • getMetaData<T, K>(key, defaultValue?): K

  • Retrieves metadata associated with the specified key.

    Type Parameters

    • T

      An interface containing a declaration of the meta data fields of the variable such as CarbonShaderGraphVariableMetaData.

    • K = any

    Parameters

    • key: keyof T

      The key for which to retrieve the metadata.

    • OptionaldefaultValue: K

    Returns K

    The metadata associated with the key, or undefined if no metadata is found.

onRemove

  • onRemove(): void
  • Virtual

    Invoked before the variable is removed from a Graph.

    Returns void

setMetaData

  • setMetaData<T>(key, value): any

  • Sets metadata for the graph variable.

    Type Parameters

    • T

      An interface containing a declaration of the meta data fields of the variable such as CarbonShaderGraphVariableMetaData.

    Parameters

    • key: keyof T

      The key for the metadata entry.

    • value: any

      The value to be associated with the key.

    Returns any

setType

  • setType(graphType, defaultValue?): void

  • Sets the type of the variable and assigns a new default value. If the defaultValue is not specified or undefined, a default value will be constructed.

    Parameters

    • graphType: GraphType

      The new type.

    • OptionaldefaultValue: any

    Returns void

validate

  • validate(validationStatus): GraphValidationStatus
  • Virtual

    Ensures that the state of the node is valid.

    Parameters

    Returns GraphValidationStatus

    Note

    Implementing classes must call super. The method is typically called after deserialization or major edits to the graph. If validation fails, error information must be added to the validationStatus map.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods