.TH "SoLocateHighlight" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoLocateHighlight \- 
.PP
The \fBSoLocateHighlight\fP class highlights geometry under the cursor\&.
.PP
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\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/nodes/SoLocateHighlight\&.h>\fP
.PP
Inherits \fBSoSeparator\fP\&.
.PP
Inherited by \fBSoWWWAnchor\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBModes\fP { \fBAUTO\fP, \fBON\fP, \fBOFF\fP }"
.br
.ti -1c
.RI "enum \fBStyles\fP { \fBEMISSIVE\fP, \fBEMISSIVE_DIFFUSE\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const "
.br
.RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP"
.ti -1c
.RI "\fBSoLocateHighlight\fP (void)"
.br
.ti -1c
.RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "\fIThis static method returns the \fBSoType\fP object associated with objects of this class\&. \fP"
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "\fISets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. \fP"
.ti -1c
.RI "static void \fBturnOffCurrentHighlight\fP (\fBSoGLRenderAction\fP *action)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFColor\fP \fBcolor\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBstyle\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBmode\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const "
.br
.ti -1c
.RI "virtual \fB~SoLocateHighlight\fP ()"
.br
.ti -1c
.RI "virtual void \fBredrawHighlighted\fP (\fBSoAction\fP *act, SbBool flag)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoLocateHighlight\fP class highlights geometry under the cursor\&.
.PP
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\&. 

\fBFILE FORMAT/DEFAULTS:\fP 
.PP
.nf
LocateHighlight {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    color 0\&.3 0\&.3 0\&.3
    style EMISSIVE
    mode AUTO
}

.fi
.PP
 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBSoLocateHighlight::Modes\fP"
Enum type for behaviour modes\&. 
.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fIAUTO \fP\fP
Highlight when mouse cursor is over the contents of the node\&. 
.TP
\fB\fION \fP\fP
Always highlight\&. 
.TP
\fB\fIOFF \fP\fP
Never highlight\&. 
.SS "enum \fBSoLocateHighlight::Styles\fP"
Enum type for highlight styles\&. 
.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fIEMISSIVE \fP\fP
Highlight using emissive color override\&. 
.TP
\fB\fIEMISSIVE_DIFFUSE \fP\fP
Highlight useing emissive and diffuse color override\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoLocateHighlight::SoLocateHighlight (void)"
Constructor\&. 
.SS "SoLocateHighlight::~SoLocateHighlight ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoLocateHighlight::getTypeId (void) const\fC [virtual]\fP"

.PP
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. Usage example:
.PP
.PP
.nf
void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}
.fi
.PP
.PP
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in \fIall\fP 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 \fBInventor/nodes/SoSubNode\&.h\fP (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine\&.h (for engine classes) and so on\&.
.PP
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups\&. 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.PP
Reimplemented in \fBSoWWWAnchor\fP\&.
.SS "const \fBSoFieldData\fP ** SoLocateHighlight::getFieldDataPtr (void)\fC [static]\fP, \fC [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.PP
Reimplemented in \fBSoWWWAnchor\fP\&.
.SS "const \fBSoFieldData\fP * SoLocateHighlight::getFieldData (void) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.PP
Reimplemented in \fBSoWWWAnchor\fP\&.
.SS "void SoLocateHighlight::handleEvent (\fBSoHandleEventAction\fP *action)\fC [virtual]\fP"
Action method for \fBSoHandleEventAction\fP\&.
.PP
Inspects the event data from \fIaction\fP, and processes it if it is something which this node should react to\&.
.PP
Nodes influencing relevant state variables for how event handling is done also overrides this method\&. 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.PP
Reimplemented in \fBSoWWWAnchor\fP\&.
.SS "void SoLocateHighlight::GLRenderBelowPath (\fBSoGLRenderAction\fP *action)\fC [virtual]\fP"
SGI Open Inventor v2\&.1 obsoleted support for \fBSoGLRenderAction::addMethod()\fP\&. Instead, \fBGLRender()\fP might be called directly, and to optimize traversal, the \fBSoSeparator\fP node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change)\&. To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect\&.
.PP
\fBSoSeparator::GLRenderBelowPath()\fP do not traverse its children using \fBSoChildList::traverse()\fP, but calls \fBGLRenderBelowPath()\fP directly for all its children\&. 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.SS "void SoLocateHighlight::GLRenderInPath (\fBSoGLRenderAction\fP *action)\fC [virtual]\fP"
Implements the SoAction::IN_PATH traversal method for the rendering action\&. 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.SS "void SoLocateHighlight::turnOffCurrentHighlight (\fBSoGLRenderAction\fP *action)\fC [static]\fP"
Static method that can be used to turn off the current highlight\&. 
.SS "void SoLocateHighlight::redrawHighlighted (\fBSoAction\fP *act, SbBoolflag)\fC [protected]\fP, \fC [virtual]\fP"
Empty method in Coin\&. Can be used by subclasses to be told when status change\&. 
.PP
Reimplemented in \fBSoWWWAnchor\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSoSFColor\fP SoLocateHighlight::color"
The color used for highlighting\&. Default is [0\&.3, 0\&.3, 0\&.3], a dark gray\&. 
.SS "\fBSoSFEnum\fP SoLocateHighlight::style"
The highlight style\&. Default is \fBSoLocateHighlight::EMISSIVE\fP\&. 
.SS "\fBSoSFEnum\fP SoLocateHighlight::mode"
The highlight mode\&. Default is \fBSoLocateHighlight::AUTO\fP\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.