SoDiagram2DCurveSection3

InventorModule
genre Diagram
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll SoDiagram2D
definition SoDiagram2D.def
see also SoDiagram2D, SoDiagram2DCurveSection2
inherits from SoDiagram2DInteractionExtension
keywords split, line

Purpose

The module SoDiagram2DCurveSection3 renders a doubly split, colored background behind a diagram. The splits can be set interactively.

Usage

On initialization, the module splits at each third of the x-width of the curves.

Drag the splitters with the set mouse button and modifier to move it horizontally.

Windows

Default Panel

../../../Modules/Inventor/SoDiagram2D/mhelp/Images/Screenshots/SoDiagram2DCurveSection3._default.png

Input Fields

inCurve

name: inCurve, type: MLBase

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Caption1: String grabWidth: Float split1ValY: Double
Caption2: String Index (startPos): Integer split2ValY: Double
Caption3: String Index (endPos): Integer Splitter Color: Color
Color1: Color Index (split1Pos): Integer splitterChanged: Trigger
Color2: Color Index (split2Pos): Integer startValY: Double
Color3: Color interactionProviderID: String Valid: Bool
Cursor Shape: Enum keepLimits: Bool Value (startVal): Double
Drawing enabled: Bool Opacity: Float Value (endVal): Double
Editing enabled: Bool Reset: Trigger Value (split1Val): Double
endValY: Double Show Captions: Bool Value (split2Val): Double

Visible Fields

Drawing enabled

name: isEnabled, type: Bool, default: TRUE, deprecated name: \_isEnabled

If checked, the module renders the colored sections and the splitters behind the diagram.

see also SoDiagram2DExtension.isEnabled

Editing enabled

name: isEditingEnabled, type: Bool, default: TRUE, deprecated name: \_isEditingEnabled

If checked, the splitters can interactively be set.

see also SoDiagram2DExtension.isEditingEnabled

Cursor Shape

name: cursorShape, type: Enum, default: MOVE_HORI_CURSOR

see SoDiagram2DInteractionExtension.cursorShape

Valid

name: inputValid, type: Bool, persistent: no, deprecated name: \_inputValid

Shows whether the input is valid.

Index (startPos)

name: startPos, type: Integer, default: -1, deprecated name: \_startPos

Shows the index of the diagram at the start of the first section.

Index (endPos)

name: endPos, type: Integer, default: -1, deprecated name: \_endPos

Shows the index of the diagram at the start of the third section.

Index (split1Pos)

name: split1Pos, type: Integer, default: -1, deprecated name: \_split1Pos

Shows the index of the diagram at the first splitter.

Index (split2Pos)

name: split2Pos, type: Integer, default: -1, deprecated name: \_split2Pos

Shows the index of the diagram at the second splitter.

Value (startVal)

name: startVal, type: Double, default: 0, deprecated name: \_startVal

Shows the x-value of the diagram at the start of the first section.

Value (endVal)

name: endVal, type: Double, default: 0, deprecated name: \_endVal

Shows the x-value of the diagram at the end of the third section.

Value (split1Val)

name: split1Val, type: Double, default: 0, deprecated name: \_split1Val

Shows the x-value of the diagram at the first splitter.

Value (split2Val)

name: split2Val, type: Double, default: 0, deprecated name: \_split2Val

Shows the x-value of the diagram at the second splitter.

Color1

name: color1, type: Color, default: 1 0 0, deprecated name: \_color1

Sets the color of the first section.

Color2

name: color2, type: Color, default: 0 1 0, deprecated name: \_color2

Sets the color of the second (middle) section.

Color3

name: color3, type: Color, default: 0 0 1, deprecated name: \_color3

Sets the color of the third section.

Splitter Color

name: splitterColor, type: Color, default: 1 1 1, deprecated name: \_splitterColor

Sets the color of the splitters.

Opacity

name: opacity, type: Float, default: 0.25, minimum: 0, maximum: 1, deprecated name: \_opacity

Sets the overall opacity (of the three sections and the two splitters).

Caption1

name: caption1, type: String, default: Section 1, deprecated name: \_caption1

Sets the caption of the first section.

Caption2

name: caption2, type: String, default: Section 2, deprecated name: \_caption2

Sets the caption of the second (middle) section.

Caption3

name: caption3, type: String, default: Section 3, deprecated name: \_caption3

Sets the caption of the third section.

Show Captions

name: showCaptions, type: Bool, default: FALSE, deprecated name: \_showCaptions

If checked, the caption strings are shown.

Reset

name: reset, type: Trigger

If pressed, the splitters are set back to split the diagrams into even thirds in x-direction.

Hidden Fields

interactionProviderID

name: interactionProviderID, type: String

see SoDiagram2DExtension.interactionProviderID

startValY

name: startValY, type: Double, default: 0, deprecated name: \_startValY

endValY

name: endValY, type: Double, default: 0, deprecated name: \_endValY

split1ValY

name: split1ValY, type: Double, default: 0, deprecated name: \_split1ValY

split2ValY

name: split2ValY, type: Double, default: 0, deprecated name: \_split2ValY

grabWidth

name: grabWidth, type: Float, default: 5

Width of the area on which a section delimiter can be grabbed in pixels.

keepLimits

name: keepLimits, type: Bool, default: FALSE, deprecated name: \_keepLimits

splitterChanged

name: splitterChanged, type: Trigger