VisualShaderNodeFrame — C# API

class VisualShaderNodeFrameReckfellSharpInherits VisualShaderNodeResizableBase

A frame other visual shader nodes can be attached to for better organization.

A rectangular frame that can be used to group visual shader nodes together to improve organization. Nodes attached to the frame will move with it when it is dragged and it can automatically resize to enclose all attached nodes. Its title, description and color can be customized.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

VisualShaderNodeFrameConstructor

# VisualShaderNodeFrame

C#
public VisualShaderNodeFrame();

Properties5

AttachedNodesProperty

# AttachedNodes

C#
public int[] AttachedNodes { get; set; }

The list of nodes attached to the frame.

AutoshrinkProperty

# Autoshrink

C#
public bool Autoshrink { get; set; }

If true, the frame will automatically resize to enclose all attached nodes.

TintColorProperty

# TintColor

C#
public Color TintColor { get; set; }

The color of the frame when VisualShaderNodeFrame.TintColorEnabled is true.

TintColorEnabledProperty

# TintColorEnabled

C#
public bool TintColorEnabled { get; set; }

If true, the frame will be tinted with the color specified in VisualShaderNodeFrame.TintColor.

TitleProperty

# Title

C#
public string Title { get; set; }

The title of the node.

Methods13

AddAttachedNodevoid

# AddAttachedNode

C#
public void AddAttachedNode(int node);

Adds a node to the list of nodes attached to the frame. Should not be called directly, use the VisualShader.AttachNodeToFrame method instead.

Parameters
Name	Type	Default
`node`	`int`	—

GetAttachedNodesint[]

# GetAttachedNodes

C#
public int[] GetAttachedNodes();

Returns int[]

GetTintColorColor

# GetTintColor

C#
public Color GetTintColor();

Returns Color

GetTitlestring

# GetTitle

C#
public string GetTitle();

Returns string

IsAutoshrinkEnabledbool

# IsAutoshrinkEnabled

C#
public bool IsAutoshrinkEnabled();

Returns bool

IsTintColorEnabledbool

# IsTintColorEnabled

C#
public bool IsTintColorEnabled();

Returns bool

RemoveAttachedNodevoid

# RemoveAttachedNode

C#
public void RemoveAttachedNode(int node);

Removes a node from the list of nodes attached to the frame. Should not be called directly, use the VisualShader.DetachNodeFromFrame method instead.

Parameters
Name	Type	Default
`node`	`int`	—

SetAttachedNodes2 overloads

# SetAttachedNodes · 1/2

C#
public void SetAttachedNodes(int[] attachedNodes);

Parameters
Name	Type	Default
`attachedNodes`	`int[]`	—

# SetAttachedNodes · 2/2

C#
public void SetAttachedNodes(ReadOnlySpan<int> attachedNodes);

Parameters
Name	Type	Default
`attachedNodes`	`ReadOnlySpan<int>`	—

SetAutoshrinkEnabledvoid

# SetAutoshrinkEnabled

C#
public void SetAutoshrinkEnabled(bool enable);

Parameters
Name	Type	Default
`enable`	`bool`	—

SetTintColorvoid

# SetTintColor

C#
public void SetTintColor(Color color);

Parameters
Name	Type	Default
`color`	`Color`	—

SetTintColorEnabledvoid

# SetTintColorEnabled

C#
public void SetTintColorEnabled(bool enable);

Parameters
Name	Type	Default
`enable`	`bool`	—

SetTitlevoid

# SetTitle

C#
public void SetTitle(string title);

Parameters
Name	Type	Default
`title`	`string`	—