SoLocateHighlight Class Reference
[Groups]

Special separator that performs locate highlighting. More...

#include <Inventor/nodes/SoLocateHighlight.h>

Inheritance diagram for SoLocateHighlight:

List of all members.

Classes
struct	MTstruct
Public Types
enum	Styles {   EMISSIVE,   EMISSIVE_DIFFUSE }
enum	Modes {   AUTO,   ON,   OFF }
Public Member Functions
virtual SoType	getTypeId () const
	SoLocateHighlight ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFColor	color
SoSFEnum	style
SoSFEnum	mode

---

Detailed Description

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

---

Member Enumeration Documentation

enum SoLocateHighlight::Modes

Possible values for the mode.

Enumerator:

AUTO	Highlight when mouse is over.
ON	Always highlight.
OFF	Never highlight (default).

enum SoLocateHighlight::Styles

Possible values for draw style.

Enumerator:

EMISSIVE	Changes emissive color only (default).
EMISSIVE_DIFFUSE	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.

---

Member Data Documentation

SoSFColor SoLocateHighlight::color

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

SoSFEnum SoLocateHighlight::mode

Whether to highlight or not.

Use enum Modes. Default OFF.

SoSFEnum SoLocateHighlight::style

Highlighting draw style.

Use enum Styles. Default EMISSIVE.

---

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

• Inventor/nodes/SoLocateHighlight.h