SoDiagram2DCurveSection2

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

Purpose

The module SoDiagram2DCurveSection2 renders a split, colored background behind a diagram. The split can be set interactively.

Usage

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

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

Windows

Default Panel

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

Input Fields

inCurve

name: inCurve, type: MLBase

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Caption1: String grabWidth: Float Splitter Color: Color
Caption2: String Index (startPos): Integer splitterChanged: Trigger
Color1: Color Index (endPos): Integer splitValY: Double
Color2: Color Index (splitPos): Integer startValY: Double
Cursor Shape: Enum interactionProviderID: String Valid: Bool
Drawing enabled: Bool Opacity: Float Value (startVal): Double
Editing enabled: Bool Reset: Trigger Value (endVal): Double
endValY: Double Show Captions: Bool Value (splitVal): Double

Visible Fields

Drawing enabled

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

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

see also SoDiagram2DExtension.isEnabled

Editing enabled

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

If checked, the splitter 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: 0, deprecated name: \_startPos

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

Index (endPos)

name: endPos, type: Integer, default: 0, deprecated name: \_endPos

Shows the index of the diagram at the end of the second section.

Index (splitPos)

name: splitPos, type: Integer, default: 0, deprecated name: \_splitPos

Shows the index of the diagram at the position of the 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 second section.

Value (splitVal)

name: splitVal, type: Double, default: 0, deprecated name: \_splitVal

Shows the x-value of the diagram at the position of the 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 section.

Splitter Color

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

Sets the color of the splitter.

Opacity

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

Sets the overall opacity (of the two sections and the splitter).

Caption1

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

Sets the caption string for the first section.

Caption2

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

Sets the caption string of the second 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 splitter is moved to the middle of the diagram 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

splitValY

name: splitValY, type: Double, default: 0, deprecated name: \_splitValY

grabWidth

name: grabWidth, type: Float, default: 5

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

splitterChanged

name: splitterChanged, type: Trigger