com.openinventor.inventor.nodes

Class SoLocateHighlight

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoGroup

com.openinventor.inventor.nodes.SoSeparator

com.openinventor.inventor.nodes.SoLocateHighlight

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoWWWAnchor

public class SoLocateHighlight
extends SoSeparator

Special separator that performs locate highlighting. This is a subclass of 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 {

renderCaching	AUTO
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:

SoSeparator, SoSelection, SoMaterial

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoLocateHighlight.Modes Possible values for the mode.
static class	SoLocateHighlight.Styles Possible values for draw style.

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoSeparator

SoSeparator.Cachings, SoSeparator.FastEditings, SoSeparator.RenderUnitIds

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO Deprecated. Use SoLocateHighlight.Modes.AUTO instead.
SoSFColor	color Highlighting color - default [.3, .3, .3].
static int	EMISSIVE Deprecated. Use SoLocateHighlight.Styles.EMISSIVE instead.
static int	EMISSIVE_DIFFUSE Deprecated. Use SoLocateHighlight.Styles.EMISSIVE_DIFFUSE instead.
SoSFEnum<SoLocateHighlight.Modes>	mode Whether to highlight or not.
static int	OFF Deprecated. Use SoLocateHighlight.Modes.OFF instead.
static int	ON Deprecated. Use SoLocateHighlight.Modes.ON instead.
SoSFEnum<SoLocateHighlight.Styles>	style Highlighting draw style.

Fields inherited from class com.openinventor.inventor.nodes.SoSeparator

boundingBoxCaching, CLEAR_ZBUFFER, directVizCaching, DISABLE, fastEditing, KEEP_ZBUFFER, pickCulling, renderCaching, renderCulling, renderUnitId

Fields inherited from class com.openinventor.inventor.nodes.SoGroup

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoLocateHighlight() Creates a LocateHighlight node with default settings.

Method Summary

Modifier and Type	Method and Description
static void	turnOffCurrentHighlight(SoGLRenderAction action)

Methods inherited from class com.openinventor.inventor.nodes.SoSeparator

getNumRenderCaches, setNumRenderCaches

Methods inherited from class com.openinventor.inventor.nodes.SoGroup

addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMISSIVE

@Deprecated
public static final int EMISSIVE

Deprecated. Use SoLocateHighlight.Styles.EMISSIVE instead.

EMISSIVE_DIFFUSE

@Deprecated
public static final int EMISSIVE_DIFFUSE

Deprecated. Use SoLocateHighlight.Styles.EMISSIVE_DIFFUSE instead.

AUTO

@Deprecated
public static final int AUTO

Deprecated. Use SoLocateHighlight.Modes.AUTO instead.

ON

@Deprecated
public static final int ON

Deprecated. Use SoLocateHighlight.Modes.ON instead.

OFF

@Deprecated
public static final int OFF

Deprecated. Use SoLocateHighlight.Modes.OFF instead.

color

public final SoSFColor color

Highlighting color - default [.3, .3, .3].

style

public final SoSFEnum<SoLocateHighlight.Styles> style

Highlighting draw style. . Default EMISSIVE.

mode

public final SoSFEnum<SoLocateHighlight.Modes> mode

Whether to highlight or not. . Default OFF.

Constructor Detail

SoLocateHighlight

public SoLocateHighlight()

Creates a LocateHighlight node with default settings.

Method Detail

turnOffCurrentHighlight

public static void turnOffCurrentHighlight(SoGLRenderAction action)