Ignition User Manual 8.1

User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

The following feature is new in Ignition version 8.1.10
Click here to check out the other new features
Pipes can be drawn within a coordinate container. These pipes can be used to visualize flow between separate objects on a view. 

Pipes are created by a dedicated drawing tool on the toolbar, as opposed to being dragged onto a container like other components. Pipes are effectively drawn on the bottom of the z-order in a coordinate container, hence any components added into the container will always be placed above the pipes. 

Each pipe consists of an origin, its connections, connections of connections, and so on. Each pipe is listed as a separate entry in the Project Browser, under "Pipes". 

Terminology 

A diagram of different pieces that make up a pipe object.

PipeAn object containing all the pipe connections and pipe segments. In addition, a Pipe contains a name, appearance, and appearance specific props.
Pipe ConnectionAn XY coordinate within the pipe. Visualized as a circle.
OriginThe first Pipe Connection within a pipe. Note that origins differ visually from other Pipe Connections, in that they contain a dot at their center. 
Pipe Segment

The segment formed by a Pipe Connection, and one of its immediate child connections. A segment is a visual representation of relationship between other connections. Each connection has an array of connection indices (starting at 0), and segments can be represented as a series of indices. For example, [0,1,0] would represent the first pipe, second connection, then first sub connection. 

Consider the simple pipe below. Segment [0,0] is between the origin and lower left connection. Segment [0,0,0] is between the lower left and lower right connections.

Diagram of pipe with three connections

We can add two new connections, which could look like the following.

Diagram of pipe with five connections.

Because of where we added our connections, both segment [0,0,0,0] and [0,0,0,1]. Since [0,0,0,1] was added later, it is the second child, hence the number 1. 

Note that segment indices are represented in the Project Browser. 

Example JSON 
[
  {
    "name": "pipe",
    "appearance": "auto",
    "flanges": true,
    "lineVariant": "solid",
    "start": "none",
    "end": "none",
    "fill": "",
    "stroke": "",
    "width": 10,
    "origin": {
      "x": 258,
      "y": 168,
      "connections": [
        {
          "x": 258,
          "y": 236,
          "connections": [
            {
              "x": 307,
              "y": 236,
              "connections": [
                {
                  "x": 360,
                  "y": 236
                },
                {
                  "x": 307,
                  "y": 168
                }
              ]
            }
          ]
        }
      ]
    }
  }
]

On this page ...


Creating Pipes

Click on the Pipe Drawing Tool  toward the top of the Designer. While active, clicking anywhere inside a coordinate container will create a new Pipe with an origin at the mouse location.

Note: 

Pipes can only be drawn in a Coordinate Container. The Pipe Draw Tool and Pipe Move Tool will be disabled while other types of containers are selected. 

By default, a Coordinate Container's aspectRatio property does not have a value. As such, setting your container's aspectRatio to a value like 1:1 when creating Pipes is recommended. This helps Pipes remain anchored to components if the components change size in proportion with the container.


A pipe origin without any child connections.

All connections, including the origin, can be repositioned by clicking and dragging. 

Dragging the origin to a new location.


New connections can be drawn by dragging the arrows around the connection. Letting go will create a new connection. By default, all segments are drawn orthogonally. Holding the Alt/Option key will allow the segment to be drawn in fixed angles at 15 degree increments. Alternatively, holding Shift while dragging allows the segment to be placed freely without snapping.

Adding connections to an existing origin.


New connections can be added to existing segments. Doing so allows the segment to split off into a new segment. 

Adding a new connection to the middle of a segment.


To delete a segment, click on a connection in the segment and press the Delete key, or by right-clicking and selecting "Delete". 

Existing connections can be moved by dragging. All attached segments will move with the origin. 

Dragging a connection to move adjacent segments.


If Shift is held while repositioning a connection, then connecting segments will bend. 

Holding Shift results in the pipes bending freely.

Moving Pipe Sets

The Pipe Move Tool  can be used to move an entire set of pipes, as well as resize the set. 

Using the Pipe Move Tool to move an entire pipe object.


Pipe Appearance Editor

While either the Pipe Draw Tool or Pipe Move Tool are selected, the top of the property editor will display some additional fields that can be used to modify the appearance of the selected set of pipes. Additional fields are displayed depending on the selected Appearance of the pipe. 

The pipe appearance editor.


When multiple pipes are selected, only shared fields are displayed. For example, one pipe with an appearance of P&ID and another using simple appearance are selected, only the Appearance and Width properties will be shown since those are the only fields available to both apperances. 

The pipe appearance editor when multiple pipes with a different style are selected.

In addition, a coordinate container that has one or more sets of pipes will display a pipes property in the Property Editor. Each origin is represented as an element in the pipes array. Each origin has X and Y coordinates, and an array of connections, which lead to other origins. 

Pipes PROPS in the property editor.


Pipe Properties

PropertyDescription
Pipe NameThe name of the selected set of pipes, as they appear in the Project Browser. 
Appearance

Changes the look of the pipes. Note that different appearances have additional properties. Examples of appearances are listed below:

Examples of the three pipe styles.

In addition to options above, there is an auto value will will cause the set to use the appearance specified under session.props.pipes.autoAppearance. 

WidthDetermines the width of pipes in pixels within a single set. 
Fill ColorThe fill color to use when appearance is set to either Simple or Mimic. This setting is ignored when appearance is set to P&ID.
Stroke ColorThe stoke color to use when appearance is set to either Simple or Mimic. This setting is ignored when appearance is set to P&ID.

Display flanges on pipe

(Mimic Appearance Only)

Determines if the pipe set should show flanges. 

Line Variation

(P&ID Appearance Only)

Allows a unique variation to be applied to the set. 

Examples of the four pipe variants.

Line Color

(P&ID Appearance Only)

The color to use for the pipe set. 

Start 

(P&ID Appearance Only)

Determines what the start of a pipe set look like. Applies to the starting origin of a set. 

End

(P&ID Appearance Only)

Determines what the end of a pipe set look like. Applies to all origins that don't lead into another origin. 


Visible

The following feature is new in Ignition version 8.1.13
Click here to check out the other new features
Determines whether the pipe set is visible or not. Default setting is True.

Combining Pipes

Dragging a pipe to another will combine the pipes. Combining pipes will cause the pipes to share the same appearance. However this combination can be overridden by pressing the Undo button (or by pressing Ctrl-Z/Command-Z) once. This allows different pipes to overlap without actually combining. 

Demonstrating how two pipes can be combined, and the combination being undone.

Additionally, a connection can be dragged onto it's immediate sibling or parent, which effectively removes the dragged connection. 


Component Anchors

While using the Pipe Drawing Tool, other components in the container will display anchor points. 

Anchor points around a Cylindrical Tank component.

Symbol type components have custom anchors, positioned at appropriate locations. 

Anchor points around the various symbol type components.

Dragging a segment near the anchor will cause the segment to snap to the anchor (unless the Shift key is currently being held). This can be useful when leading segments into different components. Note that anchors are only used to guide the segment in the designer. The pipes are not "connected" to the component, so moving the component later will not cause the pipe segment to move.




  • No labels