SoLocateHighlight Class Reference

VSG extension Special separator that performs locate highlighting. More...

#include <Inventor/nodes/SoLocateHighlight.h>

Inheritance diagram for SoLocateHighlight:
SoSeparator SoGroup SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject SoWWWAnchor

List of all members.

Public Types

enum  Styles {
enum  Modes {

Public Member Functions

virtual SoType getTypeId () const
 SoLocateHighlight ()

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFColor color
SoSFEnum style
SoSFEnum mode


static SoDEPRECATED void turnOffCurrentHighlight (SoGLRenderAction *action)

Detailed Description

VSG extension 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.




SoSeparator, SoSelection, SoMaterial

Member Enumeration Documentation

Possible values for the mode.


Highlight when mouse is over.


Always highlight.


Never highlight (default).

Possible values for draw style.


Changes emissive color only (default).


Changes emissive and diffuse colors.

Constructor & Destructor Documentation

SoLocateHighlight::SoLocateHighlight (  ) 

Creates a LocateHighlight node with default settings.

Member Function Documentation

static SoType SoLocateHighlight::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoSeparator.

Reimplemented in SoWWWAnchor.

virtual SoType SoLocateHighlight::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoSeparator.

Reimplemented in SoWWWAnchor.

static SoDEPRECATED void SoLocateHighlight::turnOffCurrentHighlight ( SoGLRenderAction action  )  [static]

This will de-highlight the currently highlighted node if any.

this should be called when the cursor leaves a window or a mode changes happen which would prevent a highlighted node from receiving more mouse motion events. The GL render action used to render into that window needs to be passed to correctly un-highlight.


Deprecated since Open Inventor 10810
This method is useless because the current highlighting of the subgraph is automatically turned off when switching from picking to viewing mode in viewers such as examiner viewers. However if your are using a custom viewer, you must send an SoLocation2Event::EventSource::OTHER event when switching modes instead of calling turnOffCurrentHighlight.

Member Data Documentation

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

Whether to highlight or not.

Use enum Modes. Default OFF.

Highlighting draw style.

Use enum Styles. Default EMISSIVE.

The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved.