Create Plugins

Develop custom nodes using the power of Python.

First Look

Designer Window allows you to create and integrate your own custom blocks by utilizing the power of Python and its community. The figure below shows how an empty designer window looks like.

The Block Configuration section enables users to set up the basic properties of the custom block they are creating.

Block Configuration

Block Name

The "Block Name" field allows users to specify a name for their custom block. It is important to avoid using spaces or special characters in the block name.

Block Width & Height

The "Block Width" and "Block Height" fields enable users to define the size of their custom block. These values determine the dimensions of the block in the workspace.

Load, Save, and Reset Configuration Buttons

The "Load Block Configuration," "Save Block Configuration," and "Reset Block Configuration" buttons provide options to manage the block configurations efficiently. Users can load a previously saved configuration, save the current configuration for future use, and reset the block configuration to default settings if needed.

**Parameter Settings Section**

The Parameter Settings section allows users to define the input and output sockets of the custom block they are creating. Additionally, users can add and remove components within the block.

Input Socket List

The "Input Socket List" displays the currently defined input sockets for the custom block. Users can drag and drop the sockets to rearrange their order. To add a new input socket, click the "+" button, and to remove an existing input socket, click the "-" button.

Each input socket in the list has the following properties:

• Name: Users can enter a unique name for each input socket.

• Type: The type of the input socket, such as Image, Integer, Number, Boolean, String, and Generic.

Output Socket List

The "Output Socket List" displays the currently defined output sockets for the custom block. Users can add/subtract sockets to rearrange their order and count. To add a new output socket, click the "+" button, and to remove an existing output socket, click the "-" button.

Each output socket in the list has the following properties:

• Name: Users can enter a unique name for each output socket.

• Type: The type of the output socket, such as Image, Integer, Number, Boolean, String, and Generic.

Component List

The "Component List" displays the components currently added within the custom block. Users can drag and drop the components to rearrange their order. To add a new component, click the "+" button, and to remove an existing component, click the "-" button.

Each component in the list has the following properties:

• Name: Users can enter a unique name for each component.

• Type: The type of the component, such as TextInput, DropDown, Label Slider, SliderLabeled CheckBox, Button, Image, Table

**Generate Block Script Button**

The "GENERATE BLOCK SCRIPT" button creates a Python script that represents the custom block configuration. After configuring all the settings and defining the input/output sockets and components, users can click this button to generate the Python script for their custom block.

The generated script can then be saved and integrated into AugeLab Studio for use within the node editor.

Note: Ensure that all settings and configurations are properly defined before generating the block script.

**Code Editor**

The code editor area provides a text editor where users can view and edit the generated Python script for their custom block. The script is automatically updated when users change the block's configurations in the Designer Window. The code editor enables users to refine and customize the generated script as needed.

The code editor section uses _tab_s as indentation

Reloading Blocks into Designer Window

In order to reload a custom block, right-click on custom block name in Blocks section and click on "Load into Designer Window".