NodeModel
Constructors
No public constructors defined
Methods
| void Warning(String p,Boolean isPersistent) | stability index:1 |
|---|---|
| Return Value: none | |
| Set a warning on a node. | |
| p | |
| The warning text. | |
| isPersistent | |
| Is the warning persistent? If true, the warning will not be cleared when the node is next evaluated and any additional warning messages will be concatenated to the persistent error message. If false, the warning will be cleared on the next evaluation. |
| void NotifyAstBuildBroken(String p) | stability index:1 |
|---|---|
| Return Value: none | |
| Change the state of node to ElementState.AstBuildBroken and display "p" in tooltip window. | |
| p | |
| void RegisterInputPorts( ) | stability index:1 |
|---|---|
| Return Value: none | |
| Reads inputs list and adds ports for each input. |
| void RegisterOutputPorts( ) | stability index:1 |
|---|---|
| Return Value: none | |
| Reads outputs list and adds ports for each output |
| void RegisterAllPorts( ) | stability index:1 |
|---|---|
| Return Value: none | |
| Updates UI so that all ports reflect current state of node ports. |
| PortModel AddPort(PortType portType,PortData data,Int32 index) | stability index:1 |
|---|---|
| Return Value: none | |
| Add a port to this node. If the port already exists, return that port. | |
| portType | |
| data | |
| index | |
| String PrintExpression( ) | stability index:1 |
|---|---|
| Return Value: S-Expression | |
| Creates a Scheme representation of this dynNode and all connected dynNodes. |
| void RequestVisualUpdateAsync(IScheduler scheduler,EngineController engine,IRenderPackageFactory factory,Boolean forceUpdate) | stability index:1 |
|---|---|
| Return Value: none | |
| Call this method to asynchronously regenerate render package for this node. This method accesses core properties of a NodeModel and therefore is typically called on the main/UI thread. | |
| scheduler | |
| An IScheduler on which the task will be scheduled. | |
| engine | |
| The EngineController which will be used to get MirrorData for the node. | |
| factory | |
| An IRenderPackageFactory which will be used to generate IRenderPackage objects. | |
| forceUpdate | |
| Normally, render packages are only generated when the node's IsUpdated parameter is true. By setting forceUpdate to true, the render packages will be updated. |
| void DispatchOnUIThread(Action a) | stability index:1 |
|---|---|
| Return Value: none | |
| Called by nodes for behavior that they want to dispatch on the UI thread Triggers event to be received by the UI. If no UI exists, behavior will not be executed. | |
| a | |
| String GetDescriptionStringFromAttributes( ) | stability index:1 |
|---|---|
| Return Value: The value or "No description provided" | |
| Get the description from type information |
| IdentifierNode GetAstIdentifierForOutputIndex(Int32 outputIndex) | stability index:1 |
|---|---|
| Return Value: Identifier corresponding to the given output port. | |
| Fetches the ProtoAST Identifier for a given output port. | |
| outputIndex | |
| Index of the output port. |
| Type GetTypeHintForOutput(System.Int32) | stability index:1 |
|---|---|
| Return Value: none | |
| The possible type of output at specified port. This type information is not necessary to be accurate. |
| MirrorData GetValue(Int32 outPortIndex,EngineController engine) | stability index:1 |
|---|---|
| Return Value: none | |
| Gets the most recent value of this node stored in an EngineController that has evaluated it. | |
| outPortIndex | |
| engine | |
| void SetNickNameFromAttribute( ) | stability index:1 |
|---|---|
| Return Value: none | |
| Sets the nickname of this node from the attributes on the class definining it. |
| Boolean HasInput(Int32 data) | stability index:1 |
|---|---|
| Return Value: True if there is an input, false otherwise. | |
| Checks if there is an input for a certain port. | |
| data | |
| Index of the port to look for an input for. |
| Boolean HasConnectedInput(Int32 data) | stability index:1 |
|---|---|
| Return Value: True if there is an input, false otherwise. | |
| Checks if there is a connected input for a certain port. This does not count default values as an input. | |
| data | |
| Index of the port to look for an input for. |
| Boolean HasOutput(Int32 portData) | stability index:1 |
|---|---|
| Return Value: True if there is an output, false otherwise. | |
| Checks if there is an output for a certain port. | |
| portData | |
| Index of the port to look for an output for. |
| void ClearRuntimeError( ) | stability index:1 |
|---|---|
| Return Value: none | |
| Clears the errors/warnings that are generated when running the graph. If the node has a value supplied for the persistentWarning, then the node's State will be set to ElementState.Persistent and the ToolTipText will be set to the persistent warning. Otherwise, the State will be set to ElementState.Dead |
Properties
| String CreationName {get;} | stability index:1 |
|---|---|
| The unique name that was created the node by |
| ObservableCollection<PortData> InPortData {get;set;} | stability index:1 |
|---|---|
| Definitions for the Input Ports of this NodeModel. |
| ObservableCollection<PortData> OutPortData {get;set;} | stability index:1 |
|---|---|
| Definitions for the Output Ports of this NodeModel. |
| IEnumerable<ConnectorModel> AllConnectors {get;} | stability index:1 |
|---|---|
| All of the connectors entering and exiting the NodeModel. |
| Boolean IsCustomFunction {get;} | stability index:1 |
|---|---|
| Returns whether this node represents a built-in or custom function. |
| Boolean IsVisible {get;set;} | stability index:1 |
|---|---|
| Returns whether the node is to be included in visualizations. |
| Boolean IsUpstreamVisible {get;set;} | stability index:1 |
|---|---|
| Returns whether the node aggregates its upstream connections for visualizations. |
| Boolean IsInputNode {get;} | stability index:1 |
|---|---|
| Input nodes are used in Customizer and Presets. Input nodes can be numbers, number sliders, strings, bool, code blocks and custom nodes, which don't specify path. |
| Boolean IsSelectedInput {get;set;} | stability index:1 |
|---|---|
| Specifies whether an input node should be included in a preset. By default, this field is set to true. |
| ElementState State {get;set;} | stability index:1 |
|---|---|
| The Node's state, which determines the coloring of the Node in the canvas. |
| Boolean IsInErrorState {get;} | stability index:1 |
|---|---|
| If the state of node is Error or AstBuildBroken |
| String ToolTipText {get;set;} | stability index:1 |
|---|---|
| Text that is displayed as this Node's tooltip. |
| Boolean OverrideNameWithNickName {get;set;} | stability index:1 |
|---|---|
| Should we override the displayed name with this Node's NickName property? |
| String NickName {get;set;} | stability index:1 |
|---|---|
| The name that is displayed in the UI for this NodeModel. |
| ObservableCollection<PortModel> InPorts {get;set;} | stability index:1 |
|---|---|
| Collection of PortModels representing all Input ports. |
| ObservableCollection<PortModel> OutPorts {get;set;} | stability index:1 |
|---|---|
| Collection of PortModels representing all Output ports. |
| LacingStrategy ArgumentLacing {get;set;} | stability index:1 |
|---|---|
| Control how arguments lists of various sizes are laced. |
| String Name {get;} | stability index:1 |
|---|---|
| Name property |
| String Category {get;set;} | stability index:1 |
|---|---|
| Category property |
| MirrorData CachedValue {get;set;} | stability index:1 |
|---|---|
| The value of this node after the most recent computation As this property could be modified by the virtual machine, it's dangerous to access this value without using the active Scheduler. Use the Scheduler to remove the possibility of race conditions. |
| List<String> Tags {get;} | stability index:1 |
|---|---|
| Search tags for this Node. |
| String Description {get;set;} | stability index:1 |
|---|---|
| Description of this Node. |
| IdentifierNode AstIdentifierForPreview {get;} | stability index:1 |
|---|---|
| ProtoAST Identifier for result of the node before any output unpacking has taken place. If there is only one output for the node, this is equivalent to GetAstIdentifierForOutputIndex(0). |
| Boolean IsConvertible {get;} | stability index:1 |
|---|---|
| If this node is allowed to be converted to AST node in nodes to code conversion. |
| String AstIdentifierBase {get;} | stability index:1 |
|---|---|
| Return a variable whose value will be displayed in preview window. Derived nodes may overwrite this function to display default value of this node. E.g., code block node may want to display the value of the left hand side variable of last statement. |
| Boolean DisplayLabels {get;set;} | stability index:1 |
|---|---|
| Enable or disable label display. Default is false. |
| Boolean IsPartiallyApplied {get;} | stability index:1 |
|---|---|
| Is this node being applied partially, resulting in a partial function? |
| Boolean RaisesModificationEvents {get;set;} | stability index:1 |
|---|---|
| Indicate if the node should respond to NodeModified event. It always should be true, unless is temporarily set to false to avoid flood of Modified event. |
| Boolean IsTopMostNode {get;} | stability index:1 |
|---|---|
| If node is connected to some other node(other than Output) then it is not a 'top' node |
Events
| Modified** | stability index:1 |
|---|---|
| Event fired when the node's DesignScript AST should be recompiled |
| ConnectorAdded** | stability index:1 |
|---|---|
| Event fired when a new ConnectorModel has been attached to one of this node's inputs. |
| RequestRenderPackages** | stability index:1 |
|---|---|