Top  | Previous | Next

Pipe Segment

Pipe Segments, apart<br>
and joined together

Pipe Segments, apart
and joined together

Description

The pipe segment component displays a quasi-3D pipe. In its basic form it looks very much like a rectangle with a round gradient. The difference comes in its advanced rendering of its edges and endcaps. You can configure each pipe segment's end to mate perfectly with another pipe segment butted up against it perpendicularly. The result looks like a pipe welded together in a 90° corner.

 

The control of the pipe's ends can be a bit confusing to a new user. It is done via 6 booleans - three per 'end'. End 1 is the top/left end, and End 2 is the bottom/right end. You turn off each boolean if there will be another pipe butted up against that side. The following diagram should make the naming conventions more clear:

 

shapes_PipeSegmentEnds

Properties

Appearance

Center Fill

The center of the fill gradient

Scripting name

mainColor

Data type

Color

Flags

bindable

Edge Fill

The edge of the fill gradient.

Scripting name

secondaryColor

Data type

Color

Flags

bindable

Outline Color

The color of the outline border

Scripting name

outlineColor

Data type

Color

Flags

bindable

End 1 Top?

Draw the border at end #1's top?

Scripting name

end1Top

Data type

boolean

End 1 Cap?

Draw the border at end #1's cap?

Scripting name

end1Cap

Data type

boolean

End 1 Bottom?

Draw the border at end #1's bottom?

Scripting name

end1Bottom

Data type

boolean

End 2 Top?

Draw the border at end #2's top?

Scripting name

end2Top

Data type

boolean

End 2 Cap?

Draw the border at end #2's cap?

Scripting name

end2Cap

Data type

boolean

End 2 Bottom?

Draw the border at end #2's bottom?

Scripting name

end2Bottom

Data type

boolean

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0

Default

1

Crosshair

2

Text

3

Wait

12

Hand

13

Move

4

SW Resize

5

SE Resize

6

NW Resize

7

NE Resize

8

N Resize

9

S Resize

10

W Resize

11

E Resize

Data

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

mouse
mouseMotion
propertyChange

 

Scripting Functions

This component has no special scripting functions.