SoLocateHighlight: The solocatehighlight class highlights geometry under the cursor. note: this node is supposed to draw to the front buffer. however, in coin we always draw to the back buffer, forcing a scene redraw whenever a highlight state changes.

SYNOPSIS

#include <Inventor/nodes/SoLocateHighlight.h>

Inherits SoSeparator.

Inherited by SoWWWAnchor.

Public Types

enum Modes { AUTO, ON, OFF }

enum Styles { EMISSIVE, EMISSIVE_DIFFUSE }

Public Member Functions

virtual SoType getTypeId (void) const

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. SoLocateHighlight (void)

virtual void handleEvent (SoHandleEventAction *action)

virtual void GLRenderBelowPath (SoGLRenderAction *action)

virtual void GLRenderInPath (SoGLRenderAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)

static void initClass (void)

static void turnOffCurrentHighlight (SoGLRenderAction *action)

Public Attributes

SoSFColor color

SoSFEnum style

SoSFEnum mode

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

virtual ~SoLocateHighlight ()

virtual void redrawHighlighted (SoAction *act, SbBool flag)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members

Detailed Description

The SoLocateHighlight class highlights geometry under the cursor.

Note: this node is supposed to draw to the front buffer. However, in Coin we always draw to the back buffer, forcing a scene redraw whenever a highlight state changes.

FILE FORMAT/DEFAULTS:

LocateHighlight {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    color 0.3 0.3 0.3
    style EMISSIVE
    mode AUTO
}

Member Enumeration Documentation

enum \fBSoLocateHighlight::Modes\fP

Enum type for behaviour modes.

Enumerator

AUTO: Highlight when mouse cursor is over the contents of the node.
ON: Always highlight.
OFF: Never highlight.

enum \fBSoLocateHighlight::Styles\fP

Enum type for highlight styles.

Enumerator

EMISSIVE: Highlight using emissive color override.
EMISSIVE_DIFFUSE: Highlight useing emissive and diffuse color override.

Constructor & Destructor Documentation

SoLocateHighlight::SoLocateHighlight (void)

Constructor.

SoLocateHighlight::~SoLocateHighlight ()\fC [protected]\fP, \fC [virtual]\fP

Destructor.

Member Function Documentation

\fBSoType\fP SoLocateHighlight::getTypeId (void) const\fC [virtual]\fP

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.