SoBorderMenu

InventorModule

genre	Interaction
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoMenu
definition	SoMenu.def
see also	SoPopupMenu, SoFixedMenu, SoMenuItem, SoInteractionMapping, SoView2DMenuItem, SoView2DMenu
inherits from	SoRectangularMenuBase
keywords	node, button, selection, popup, radiobox, openinventor, managed, interaction

Purpose

The node SoBorderMenu shows a menu of SoMenuItem items arranged at a border or corner of the view.

Usage

See SoRectangularMenuBase.

Interaction

The default mouse button is the left mouse button. This can be overridden with SoInteractionMapping.

Tips

You should place this node before any other node that reacts to the same mouse/key button combination, so that this node has the chance to react to the mouse button first. This is because the menu is always displayed on top of the other scene, and a user would expect a mouse click on the menu to act on the menu and not on something that is shown behind the menu.

Windows

Default Panel

Output Fields

self

name: self, type: SoNode

see SoRectangularMenuBase.self

Parameter Fields

Field Index

Alpha (backgroundAlpha): Float	Enabled: Bool	Menu Direction: Enum
Alpha (backgroundAlphaSelected): Float	Font Size: Integer	Menu Id: String
Background Color: Color	Gap Between Icon and Text: Integer	Mouse Over Color Factor: Float
Background Color Selected: Color	Horizontal Border Offset: Float	On: Bool
Border Alignment: Enum	hoverItemID: String	Outer Border: Float
Color: Color	Icon Blend Mode: Enum	popupDelay: Float
Color Selected: Color	Inner Border: Float	Text Shadow: Bool
Disable ZBuffer: Bool	interactionProviderID: String	Vertical Border Offset: Float
drawBackground: Bool	lastClickedItemId: String

Visible Fields

On

name: on, type: Bool, default: TRUE

see SoRectangularMenuBase.on

Enabled

name: enabled, type: Bool, default: TRUE

see SoRectangularMenuBase.enabled

Menu Id

name: menuId, type: String

see SoRectangularMenuBase.menuId

Icon Blend Mode

name: iconBlendMode, type: Enum, default: IconReplace

see SoRectangularMenuBase.iconBlendMode

Color

name: color, type: Color, default: 1 1 1

see SoRectangularMenuBase.color

Color Selected

name: colorSelected, type: Color, default: 1 1 1

see SoRectangularMenuBase.colorSelected

Background Color

name: backgroundColor, type: Color, default: 0.5 0.5 0.5

see SoRectangularMenuBase.backgroundColor

Alpha (backgroundAlpha)

name: backgroundAlpha, type: Float, default: 0.80000001, minimum: 0, maximum: 1

see SoRectangularMenuBase.backgroundAlpha

Background Color Selected

name: backgroundColorSelected, type: Color, default: 0.699999988079071 0.699999988079071 0.699999988079071

see SoRectangularMenuBase.backgroundColorSelected

Alpha (backgroundAlphaSelected)

name: backgroundAlphaSelected, type: Float, default: 0.80000001, minimum: 0, maximum: 1

see SoRectangularMenuBase.backgroundAlphaSelected

Mouse Over Color Factor

name: mouseOverColorFactor, type: Float, default: 0.80000001, minimum: 0, maximum: 1

see SoRectangularMenuBase.mouseOverColorFactor

Disable ZBuffer

name: disableZBuffer, type: Bool, default: TRUE

see SoRectangularMenuBase.disableZBuffer

Font Size

name: fontSize, type: Integer, default: 10, minimum: 0

see SoRectangularMenuBase.fontSize

Text Shadow

name: textShadow, type: Bool, default: TRUE

see SoRectangularMenuBase.textShadow

Outer Border

name: itemOuterBorder, type: Float, default: 1, minimum: 0

see SoRectangularMenuBase.itemOuterBorder

Inner Border

name: itemInnerBorder, type: Float, default: 3, minimum: 0

see SoRectangularMenuBase.itemInnerBorder

Gap Between Icon and Text

name: textIconGap, type: Integer, default: 4, minimum: 0

see SoRectangularMenuBase.textIconGap

Border Alignment

name: borderAlignment, type: Enum, default: BORDER_LEFT

Where to put the menu.

Values:

Title	Name
​Top Left	​BORDER_TOP_LEFT
​Top Right	​BORDER_TOP_RIGHT
​Bottom Left	​BORDER_BOTTOM_LEFT
​Bottom Right	​BORDER_BOTTOM_RIGHT
​Top	​BORDER_TOP
​Left	​BORDER_LEFT
​Right	​BORDER_RIGHT
​Bottom	​BORDER_BOTTOM

Menu Direction

name: menuDirection, type: Enum, default: DIR_VERTICAL

Defines the direction in which to arrange the menu items.

For the BORDER_LEFT and BORDER_RIGHT Border Alignment this should be DIR_VERTICAL, for BORDER_TOP and BORDER_BOTTOM this should be DIR_HORIZONTAL, and for the corners this is free to select.

Values:

Title	Name
​Horizontal	​DIR_HORIZONTAL
​Vertical	​DIR_VERTICAL

Vertical Border Offset

name: verticalBorderOffset, type: Float, default: 4, minimum: 0

Sets a vertical border offset.

Horizontal Border Offset

name: horizontalBorderOffset, type: Float, default: 4, minimum: 0

Sets a horizontal border offset.

Hidden Fields

interactionProviderID

name: interactionProviderID, type: String

see SoRectangularMenuBase.interactionProviderID

drawBackground

name: drawBackground, type: Bool, default: TRUE

see SoRectangularMenuBase.drawBackground

lastClickedItemId

name: lastClickedItemId, type: String, persistent: no

see SoRectangularMenuBase.lastClickedItemId

hoverItemID

name: hoverItemID, type: String

see SoRectangularMenuBase.hoverItemID

popupDelay

name: popupDelay, type: Float, default: 250, minimum: 0, maximum: 2000

see SoRectangularMenuBase.popupDelay