public class SoLocateHighlight extends SoSeparator
SoSeparator
that redraws itself in a different color when the cursor is over the contents of the separator.
The redraw happens for that separator only and not the entire window (redraw along the handle event pick path) and in the front buffer, to efficiently track the mouse motion. The highlighted redraw overrides the emissive and/or diffuse color of the subgraph based on the field values in this node.
NOTE: when using SoLightModel.BASE_COLOR
(to turn lighting off) only the diffuse color will be used to render objects, so EMISSIVE_DIFFUSE must be used for this node to have any effect.
To override the default mode (off), set environment variable IV_ALLOW_LOCATE_HIGHLIGHT to 1. This will allow locate highlighting to happen by default.
File format/default:
LocateHighlight {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
mode | OFF |
style | EMISSIVE |
color | 0.3 0.3 0.3 |
fastEditing | DISABLE |
Action behavior:
SoHandleEventAction
Checks to see if the cursor moves onto or off of the contents of the separator, and redraws appropriately (if mode
is AUTO), otherwise traverses as a normal separator.
SoGLRenderAction
Redraws either highlighted (if cursor is over the contents of the separator when mode
== AUTO or always if mode
== ON), otherwise traverses as a normal separator.
See also:
Modifier and Type | Class and Description |
---|---|
static class |
SoLocateHighlight.Modes
Possible values for the mode.
|
static class |
SoLocateHighlight.Styles
Possible values for draw style.
|
SoSeparator.Cachings, SoSeparator.FastEditings, SoSeparator.RenderUnitIds
SoNode.RenderModes
Inventor.ConstructorCommand
Modifier and Type | Field and Description |
---|---|
SoSFColor |
color
Highlighting color - default [.3, .3, .3].
|
SoSFEnum<SoLocateHighlight.Modes> |
mode
Whether to highlight or not.
|
SoSFEnum<SoLocateHighlight.Styles> |
style
Highlighting draw style.
|
boundingBoxCaching, fastEditing, pickCulling, renderCaching, renderCulling, renderUnitId
boundingBoxIgnoring
VERBOSE_LEVEL, ZeroHandle
Constructor and Description |
---|
SoLocateHighlight()
Creates a LocateHighlight node with default settings.
|
Modifier and Type | Method and Description |
---|---|
static void |
turnOffCurrentHighlight(SoGLRenderAction action)
This will de-highlight the currently highlighted node if any.
|
addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults
dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
getNativeResourceHandle
public final SoSFColor color
public final SoSFEnum<SoLocateHighlight.Styles> style
public final SoSFEnum<SoLocateHighlight.Modes> mode
public SoLocateHighlight()
public static void turnOffCurrentHighlight(SoGLRenderAction action)
Generated on July 31, 2019, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com