Version: Unity 6.6 Alpha (6000.6)
LanguageEnglish
  • C#

PortReference

struct in Unity.GraphToolkit.Editor.GraphVisualization

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Identifies a port inside a visualization PortReference.Context so visualization changes can be applied to it.

Obtain a PortReference from Context.GetPortReference, providing the unique identifier of the port. The reference is only meaningful for the PortReference.Context that produced it. You can use its methods to set, retrieve, or clear the port preview for that specific port in the graph canvas. Port preview is a visualization feature that displays a label next to a port in the graph canvas. This label provides additional information about the port's value or state. Two PortReference values are equal when they share the same PortReference.PortID and refer to the same PortReference.Context instance.

Additional resources: PortReference.Context, Context.GetPortReference

 using var context = Registry.CreateVisualizationContext(graph.ID);
 context.GetPortReference(portID).SetPreview("42.0");
 if (context.GetPortReference(portID).TryGetPreview(out var displayValue))
     Debug.Log(displayValue);
 context.GetPortReference(portID).ClearPreview();

Properties

Property Description
Context Visualization context that produced the current port reference.
PortID Unique identifier of the port the reference points to.

Public Methods

Method Description
ClearPreview Clears the port preview for the specified port.
Equals Indicates whether the current PortReference is equal to another PortReference.
GetHashCode Returns a hash code for the current PortReference.
SetPreview Sets the string value to display in a port preview for a given port.
TryGetPreview Retrieves the current string value assigned to the port preview for a given port.

Operators

Operator Description
operator != Compares two PortReference values for inequality.
operator == Compares two PortReference values for equality.