<WorkflowNode>

Implements a node that allows the user to specify input and output hotspots for workflow-based programming.

Registration

Class registration and implementation information is as follows:

Category Documentation
ImplementationC++
ModulePlugin-Domain-Workflow
Class HierarchyNode » Group » WorkflowNode
Data Interface NameWorkflowNode
Type StatusActive
Is Final TypeYes

<WorkflowNode> Properties

Properties are as follows:

Property Documentation
Source Render PassA link to a <RenderPassNode> that contains a rendering pass that performs the workload associated with the workflow tile.
Tile Source PathThis stores the path to the template tile if a workflow tile was created using another tile as a template.
Shader Source PathThis stores the path to the shader module used to render the preview geometry.
Vertex Position Attribute NameThe name of the vertex position attribute (typically 'position') in the vertex shader that is used to render this node.
Vertex Texcoord Attribute NameThe name of the vertex texture coordinate attribute (typically 'texcoord') in the vertex shader that is used to render this node.
Vertex Normal Attribute NameThe name of the vertex normal attribute (typically 'normal') in the vertex shader that is used to render this node.
Vertex Color Attribute NameThe name of the vertex color attribute (typically 'color') in the vertex shader that is used to render this node.
Title Rendering handlerA link to a node that contains rendering instructions for the title. You shouldn't need to set this value manually.
Panel Rendering handlerA link to a node that contains rendering instructions for the panel, which includes the sockets. You shouldn't need to set this value manually.
Preview Rendering handlerA link to a node that contains rendering instructions for the preview. This is usually automatically set by the application, but you may want to modify it in some situations.
OnCreate NamespaceA Simdify Scripting Language library name such as 'LibWorkflowOnCreate' containing functions to invoke when this <WorkloadNode> is created.
OnCreate FunctionThe name of the Simdify Scripting Language function such as 'OnCreate_Cubemap' to invoke when this <WorkloadNode> is created.
OnExecute NamespaceA Simdify Scripting Language library name such as 'LibWorkflowNodeGenerateImage' containing functions to invoke when this <WorkloadNode> is executed.
OnExecute FunctionThe name of the Simdify Scripting Language function such as 'Build2DArrayTextureRoot' to invoke when this <WorkloadNode> is executed.
EnabledIf true this <WorkloadNode> is enabled and executed during any build operation.
OnCall PathThe path to a Simdify Scripting Language file containing function to invoke when this <WorkloadNode> is called as a function from another document.
OnCall NamespaceA Simdify Scripting Language library name such as 'LibWorkflowNodeCallTerrain' defined in the Simdify Scripting Language script file specified above.
OnCall FunctionThe name of the Simdify Scripting Language function such as 'ExecuteTerrain' to invoke when this <WorkloadNode> is called as a function from another document.
Panel ColorSets the color of the <WorkloadNode> panel.
FontA link to a <FontNode> that defines a font for rendering the <WorkloadNode> title text.
Preview HeightThe height of the <WorkloadNode> in document units.
Preview WidthThe width of the <WorkloadNode> in document units.
Input Socket CountThe number of input sockets to render on the left side of the <WorkloadNode>.
Output Socket CountThe number of output sockets to render on the right side of the <WorkloadNode>.
ColorThe input socket color at the indicated index. The property sheet does not enumerate input socket colors when 'Input Socket Count' is zero.
ColorThe output socket color at the indicated index. The property sheet does not enumerate output socket colors when 'Output Socket Count' is zero.

<Group> Properties

Properties are as follows:

Property Documentation
VisibleToggles the <Group>'s visible/invisible". Child nodes are not visible when their parent <Group>'s is invisible.
CollisionsToggles collision detection on the <Group> node and its children". This is used for runtime export and has no effect in Simdify applications.
CullToggles view volume culling on/off". modifying this parameter may cause incorrect culling and other unexpected consequences.
Preserve CameraThis option is undocumented at present.
Generic Data SourceThis option provides the capability to connect a <Group>'s to a node that serves as a generic data source.
Bounding Box FrozenFreezes the bounding box at its current size. This is often used as a runtime flag, and modifying this parameter may cause incorrect culling.
Minimum XDisplays the minimum bounding box coordinate on the X axis.
Minimum YDisplays the minimum bounding box coordinate on the Y axis.
Minimum ZDisplays the minimum bounding box coordinate on the Z axis.
Maximum XDisplays the maximum bounding box coordinate on the X axis.
Maximum YDisplays the maximum bounding box coordinate on the Y axis.
Maximum ZDisplays the maximum bounding box coordinate on the Z axis.
Transform LockedLocks the node and prevents transformation of the node and its children. This is a runtime flag and has no effect in Simdify applications.
Position XDisplays the node's position on the X axis.
Position YDisplays the node's position on the Y axis.
Position ZDisplays the node's position on the Z axis.
Orientation XDisplays the node's orientation on the X axis.
Orientation YDisplays the node's orientation on the Y axis.
Orientation ZDisplays the node's orientation on the Z axis.
Scale XDisplays the node's scale on the X axis.
Scale YDisplays the node's scale on the Y axis.
Scale ZDisplays the node's scale on the Z axis.
BillboardSets the node as a billboard. Billboards rotate to face the camera. This feature has been preserved for compatibility purposes, but this functionality should be implemented with geometry shaders.

<Node> Properties

Properties are as follows:

Property Documentation
NameSets orthe name of the node. Do not use / or \ [forward slash and backslash] in the node name as this produces conflicts with resolving link nodes that reference external files.
ClassSets the class of the node.
IDSets the ID of the node. This must be unique for each document, but different documents can use the same ID.
Import DisabledDetermines whether or not the node is imported during an import process such as when nodes are imported from a template during document creation. Note that this flag is mostly in Simdify Scripting language.
Export DisabledDetermines whether or not the node is exported during an export process, or possibly other purposes. This flag is set to No and current Simdify exporters ignore it (but it can be very useful if you need to modify the exporters).
GuidEnumerates the Node's GUID.