reckfellENGINE

VoxelGraphFunction

График для получения или обработки рядов 3D значений.

На этой странице
class VoxelGraphFunctionReckfellSharpНаследует Resource

График для получения или обработки рядов 3D значений.

В нем содержится график, который может использоваться для обработки рядов значений, таких, как положение вокселя (при использовании в качестве основной функции генератора), или для повторного использования в других графиках (как подграф). В настоящее время этот класс хранит только график, он не может сам по себе осуществлять реальную обработку. Обычно он встроен в другой ресурс, который затем использует график определенным образом. Чтобы создать с ним воксели, смотри. VoxelGeneratorGraph. Узлы могут быть соединены вместе с их выходом и вводом в следующие узлы. Неподсоединенные вводимые данные могут иметь стандартные значения или имплицитные соединения по умолчанию. У узлов также могут быть "параметры", которые являются константами, установленными на узел. Уровни приходятся на три основных семейства: вводимые ресурсы (только имеют мероприятия), мероприятия (только вводимые ресурсы) и другие (которые имеют как вводимые, так и выходные ресурсы для некоторых расчетов). Entity - типы идентифицируются с энумом; VoxelGraphFunction.NodeTypeIdЭта энцима не должна использоваться в постоянных контекстах (таких, как сохранение файлов), поскольку ее значения могут меняться между версиями. Графы могут обрабатывать только 32-битные значения в плавающей точке. Описание типов узлов присутствует в диалоговом узле редактора графа или на [url]https://voxel-tools.readthedocs.io/en/latest/graph_nodes[/url].

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

VoxelGraphFunctionКонструктор
# VoxelGraphFunction
C#
public VoxelGraphFunction();

Свойства3

GraphDataСвойство
# GraphData
C#
public Reckfell.Collections.Dictionary GraphData { get; set; }
InputDefinitionsСвойство
# InputDefinitions
C#
public Reckfell.Collections.Array InputDefinitions { get; set; }
OutputDefinitionsСвойство
# OutputDefinitions
C#
public Reckfell.Collections.Array OutputDefinitions { get; set; }

Методы34

AddConnectionvoid
# AddConnection
C#
public void AddConnection(uint srcNodeId, uint srcPortIndex, uint dstNodeId, uint dstPortIndex);

Подключает выход узла к входу другого узла. Подсоединение узла к самому себе или таким образом, который может привести его обратно к себе, не поддерживается.

Параметры
ИмяТипПо умолчанию
srcNodeIduint—
srcPortIndexuint—
dstNodeIduint—
dstPortIndexuint—
CanConnectbool
# CanConnect
C#
public bool CanConnect(uint srcNodeId, uint srcPortIndex, uint dstNodeId, uint dstPortIndex);

Испытания на соединение двух портов.

Параметры
ИмяТипПо умолчанию
srcNodeIduint—
srcPortIndexuint—
dstNodeIduint—
dstPortIndexuint—
Возвращает bool
Clearvoid
# Clear
C#
public void Clear();

Удаляет все узлы из графика. Input и определения выходных данных не будут очищены.

CreateFunctionNodeuint
# CreateFunctionNode
C#
public uint CreateFunctionNode(VoxelGraphFunction function, Vector2 position, uint id = 0);

Создает узел, основанный на существующем графике (создает "подграфический пример").

Параметры
ИмяТипПо умолчанию
functionVoxelGraphFunction—
positionVector2—
iduint0
Возвращает uint
CreateNodeuint
# CreateNode
C#
public uint CreateNode(VoxelGraphFunction.NodeTypeId typeId, Vector2 position, uint id = 0);

Создает узел графа данного типа в определенном визуальном положении. :: position параметр не влияет на то, как будет функционировать график, хотя он помогает организовать узлы. Может быть указан факультативный идентификационный номер. Эта функция затем возвращает идентификатор узла, который может быть полезен для изменения других свойств узла позднее.

Параметры
ИмяТипПо умолчанию
typeIdVoxelGraphFunction.NodeTypeId—
positionVector2—
iduint0
Возвращает uint
FindNodeByNameuint
# FindNodeByName
C#
public uint FindNodeByName(StringName name);

Найдет узел с указанным именем и возвратит ID. Если узел не найден, возвращает 0.

Параметры
ИмяТипПо умолчанию
nameStringName—
Возвращает uint
GetConnectionsReckfell.Collections.Array
# GetConnections
C#
public Reckfell.Collections.Array GetConnections();

Получает массив, описывающий все связи между узлами. Диапазон имеет следующий формат:

Текст
[
    {
        "src_node_id": int,
        "src_port_index": int,
        "dst_node_id": int,
        "dst_port_index": int
    },
    ...
]
Возвращает Reckfell.Collections.Array
GetNodeDefaultInputVariant
# GetNodeDefaultInput
C#
public Variant GetNodeDefaultInput(uint nodeId, int inputIndex);
Параметры
ИмяТипПо умолчанию
nodeIduint—
inputIndexint—
Возвращает Variant
GetNodeDefaultInputsAutoconnectbool
# GetNodeDefaultInputsAutoconnect
C#
public bool GetNodeDefaultInputsAutoconnect(uint nodeId);
Параметры
ИмяТипПо умолчанию
nodeIduint—
Возвращает bool
GetNodeGuiPositionVector2
# GetNodeGuiPosition
C#
public Vector2 GetNodeGuiPosition(uint nodeId);

Найдите позицию узла в редакторе графа.

Параметры
ИмяТипПо умолчанию
nodeIduint—
Возвращает Vector2
GetNodeGuiSizeVector2
# GetNodeGuiSize
C#
public Vector2 GetNodeGuiSize(uint nodeId);

Узнайте размер узла в редакторе графа.

Параметры
ИмяТипПо умолчанию
nodeIduint—
Возвращает Vector2
GetNodeIdsint[]
# GetNodeIds
C#
public int[] GetNodeIds();

Найдите список идентифицирующих всех узлов в графике. Примечание: порядок возврата удостоверений личности не гарантирован после добавления или удаления узлов.

Возвращает int[]
GetNodeInputIndexint
# GetNodeInputIndex
C#
public int GetNodeInputIndex(uint nodeId, string inputName);

Получает вводный индекс узла из имени входа.

Параметры
ИмяТипПо умолчанию
nodeIduint—
inputNamestring—
Возвращает int
GetNodeNameStringName
# GetNodeName
C#
public StringName GetNodeName(uint nodeId);
Параметры
ИмяТипПо умолчанию
nodeIduint—
Возвращает StringName
GetNodeOutputIndexint
# GetNodeOutputIndex
C#
public int GetNodeOutputIndex(uint nodeId, string outputName);

Получает индекс выпуска узла по названию вывода.

Параметры
ИмяТипПо умолчанию
nodeIduint—
outputNamestring—
Возвращает int
GetNodeParamVariant
# GetNodeParam
C#
public Variant GetNodeParam(uint nodeId, int paramIndex);

Найти параметр узла. Индекс параметров соответствует положению, в котором он появляется при просмотре в редакторе.

Параметры
ИмяТипПо умолчанию
nodeIduint—
paramIndexint—
Возвращает Variant
GetNodeTypeCountint
# GetNodeTypeCount
C#
public int GetNodeTypeCount();
Возвращает int
GetNodeTypeIdVoxelGraphFunction.NodeTypeId
# GetNodeTypeId
C#
public VoxelGraphFunction.NodeTypeId GetNodeTypeId(uint nodeId);

Найдите идентификатор узла в графике.

Параметры
ИмяТипПо умолчанию
nodeIduint—
Возвращает VoxelGraphFunction.NodeTypeId
GetNodeTypeInfoReckfell.Collections.Dictionary
# GetNodeTypeInfo
C#
public Reckfell.Collections.Dictionary GetNodeTypeInfo(int typeId);
Параметры
ИмяТипПо умолчанию
typeIdint—
Возвращает Reckfell.Collections.Dictionary
PasteGraphWithPreGeneratedIds2 перегрузки
# PasteGraphWithPreGeneratedIds · 1/2
C#
public void PasteGraphWithPreGeneratedIds(VoxelGraphFunction graph, int[] nodeIds, Vector2 guiOffset);

Копировать узлы в другой график, и только связи между ними. Ресурсы в параметрах узла будут дублироваться, если у них нет файлового пути. Если node_ids имеет ненулевой размер, определяет скопированные узлы в графике назначения в том же порядке, что и VoxelGraphFunction.GetNodeIds :: от исходного графика. У массива должен быть тот же размер, что и количество копированных узлов, и идентификаторы не должны существовать в графике назначения. Если массив пуст, то он будет генерирован.

Параметры
ИмяТипПо умолчанию
graphVoxelGraphFunction—
nodeIdsint[]—
guiOffsetVector2—
# PasteGraphWithPreGeneratedIds · 2/2
C#
public void PasteGraphWithPreGeneratedIds(VoxelGraphFunction graph, ReadOnlySpan<int> nodeIds, Vector2 guiOffset);

Копировать узлы в другой график, и только связи между ними. Ресурсы в параметрах узла будут дублироваться, если у них нет файлового пути. Если node_ids имеет ненулевой размер, определяет скопированные узлы в графике назначения в том же порядке, что и VoxelGraphFunction.GetNodeIds :: от исходного графика. У массива должен быть тот же размер, что и количество копированных узлов, и идентификаторы не должны существовать в графике назначения. Если массив пуст, то он будет генерирован.

Параметры
ИмяТипПо умолчанию
graphVoxelGraphFunction—
nodeIdsReadOnlySpan<int>—
guiOffsetVector2—
RemoveConnectionvoid
# RemoveConnection
C#
public void RemoveConnection(uint srcNodeId, uint srcPortIndex, uint dstNodeId, uint dstPortIndex);

Удаляет существующую связь между двумя узлами графика.

Параметры
ИмяТипПо умолчанию
srcNodeIduint—
srcPortIndexuint—
dstNodeIduint—
dstPortIndexuint—
RemoveNodevoid
# RemoveNode
C#
public void RemoveNode(uint nodeId);

Удаляет узел из графика.

Параметры
ИмяТипПо умолчанию
nodeIduint—
SetExpressionNodeInputs2 перегрузки
# SetExpressionNodeInputs · 1/2
C#
public void SetExpressionNodeInputs(uint nodeId, ReadOnlySpan<string> names);

Настройка входных данных для Expression Узел. names - список входных имен, используемых в выражении. Если вы создаёте Expression Узел из кода, ты должен позвонить по этому методу после.

Параметры
ИмяТипПо умолчанию
nodeIduint—
namesReadOnlySpan<string>—
# SetExpressionNodeInputs · 2/2
C#
public void SetExpressionNodeInputs(uint nodeId, string[] names);

Настройка входных данных для Expression Узел. names - список входных имен, используемых в выражении. Если вы создаёте Expression Узел из кода, ты должен позвонить по этому методу после.

Параметры
ИмяТипПо умолчанию
nodeIduint—
namesstring[]—
SetNodeDefaultInputvoid
# SetNodeDefaultInput
C#
public void SetNodeDefaultInput(uint nodeId, int inputIndex, Variant value);

Устанавливает значение входа узла, когда он остается не подключенным.

Параметры
ИмяТипПо умолчанию
nodeIduint—
inputIndexint—
valueVariant—
SetNodeDefaultInputByNamevoid
# SetNodeDefaultInputByName
C#
public void SetNodeDefaultInputByName(uint nodeId, string inputName, Variant value);

Устанавливает значение входа узла, когда он остается не подключенным. Ввод определяется его именем, как показано в редакторе.

Параметры
ИмяТипПо умолчанию
nodeIduint—
inputNamestring—
valueVariant—
SetNodeDefaultInputsAutoconnectvoid
# SetNodeDefaultInputsAutoconnect
C#
public void SetNodeDefaultInputsAutoconnect(uint nodeId, bool enabled);

Устанавливает ввод узла без входного соединения автоматически создаст соединение по умолчанию, когда будет составлен график. Это доступно только на конкретных узлах (например, 2D или 3D по умолчанию звука XYZ).

Параметры
ИмяТипПо умолчанию
nodeIduint—
enabledbool—
SetNodeGuiPositionvoid
# SetNodeGuiPosition
C#
public void SetNodeGuiPosition(uint nodeId, Vector2 position);

Устанавливает визуальное положение узла графа, как это будет показано в редакторе.

Параметры
ИмяТипПо умолчанию
nodeIduint—
positionVector2—
SetNodeGuiSizevoid
# SetNodeGuiSize
C#
public void SetNodeGuiSize(uint nodeId, Vector2 size);

Устанавливает визуальный размер узла графа, как он появится в редакторе.

Параметры
ИмяТипПо умолчанию
nodeIduint—
sizeVector2—
SetNodeNamevoid
# SetNodeName
C#
public void SetNodeName(uint nodeId, StringName name);

Устанавливает название узла.

Параметры
ИмяТипПо умолчанию
nodeIduint—
nameStringName—
SetNodeParamvoid
# SetNodeParam
C#
public void SetNodeParam(uint nodeId, int paramIndex, Variant value);

Установите параметр узла. Индекс параметров соответствует положению, в котором параметр появляется при просмотре в редакторе.

Параметры
ИмяТипПо умолчанию
nodeIduint—
paramIndexint—
valueVariant—
SetNodeParamByNamevoid
# SetNodeParamByName
C#
public void SetNodeParamByName(uint nodeId, string paramName, Variant value);

Установите параметр узла, используя его имя в редакторе.

Параметры
ИмяТипПо умолчанию
nodeIduint—
paramNamestring—
valueVariant—
SetNodeParamNullvoid
# SetNodeParamNull
C#
public void SetNodeParamNull(int nodeId, int paramIndex);

Установите параметр узла на null. Этот метод существует только для того, чтобы обойти вопрос с Reckfell's UndoRedo Предпочитать использовать VoxelGraphFunction.SetNodeParam.

Параметры
ИмяТипПо умолчанию
nodeIdint—
paramIndexint—

Сигналы и события2

CompiledСобытие
# Compiled
C#
public event Action Compiled;

Включено после завершения составления графика, даже если компиляция не сработала.

NodeNameChangedСобытие
# NodeNameChanged
C#
public event VoxelGraphFunction.NodeNameChangedEventHandler NodeNameChanged;
Параметры обработчика
ИмяТипПо умолчанию
nodeIdlong—

VoxelGraphFunction.NodeTypeId

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.