SoLocateHighlight - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 2.5.0
Note : Coin

NAMESoLocateHighlight − The SoLocateHighlight class highlights geometry under the cursor​.

SYNOPSIS
#include <Inventor/nodes/SoLocateHighlight​.h> Inherits SoSeparator​. Inherited by SoWWWAnchor​.

Public Typesenum Modes { AUTO, ON, OFF }
enum Styles { EMISSIVE, EMISSIVE_DIFFUSE }

Public Member Functionsvirtual SoType getTypeId (void) const
SoLocateHighlight (void)
virtual void handleEvent (SoHandleEventAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)

Static Public Member Functionsstatic SoType getClassTypeId (void)
static void initClass (void)
static void turnOffCurrentHighlight (SoGLRenderAction *action)

Public AttributesSoSFColor color
SoSFEnum style
SoSFEnum mode

Protected Member Functionsvirtual const SoFieldData * getFieldData (void) const
virtual ~SoLocateHighlight ()
virtual void redrawHighlighted (SoAction *act, SbBool flag)

Static Protected Member Functionsstatic const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members

Detailed DescriptionThe 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 SoLocateHighlight::ModesEnum type for behaviour modes​. Enumerator AUTO  Highlight when mouse cursor is over the contents of the node​. ON  Always highlight​. OFF  Never highlight​.

enum SoLocateHighlight::StylesEnum 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​. References AUTO, color, EMISSIVE, EMISSIVE_DIFFUSE, mode, OFF, ON, and style​.

SoLocateHighlight::~SoLocateHighlight () [protected], [virtual]Destructor​.

Member Function Documentation

SoType SoLocateHighlight::getTypeId (void) const [virtual]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 } else if (node->getTypeId()​.isOfType(SoGroup::getClassTypeId())) { SoGroup * group = (SoGroup *)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​. Reimplemented from SoSeparator​. Reimplemented in SoWWWAnchor​.

const SoFieldData * SoLocateHighlight::getFieldData (void) const [protected], [virtual]Returns a pointer to the class-wide field data storage object for this instance​. If no fields are present, returns NULL​. Reimplemented from SoSeparator​. Reimplemented in SoWWWAnchor​.

void SoLocateHighlight::handleEvent (SoHandleEventAction * action) [virtual]Action method for SoHandleEventAction​. Inspects the event data from action, and processes it if it is something which this node should react to​. Nodes influencing relevant state variables for how event handling is done also overrides this method​. Reimplemented from SoSeparator​. Reimplemented in SoWWWAnchor​. References AUTO, SoPath::containsPath(), SoPath::copy(), SoAction::getCurPath(), SoHandleEventAction::getEvent(), SoPickedPoint::getPath(), SoHandleEventAction::getPickedPoint(), SoSeparator::handleEvent(), mode, redrawHighlighted(), SoBase::ref(), and SoBase::touch()​. Referenced by SoWWWAnchor::handleEvent()​.

void SoLocateHighlight::GLRenderBelowPath (SoGLRenderAction * action) [virtual]SGI Open Inventor v2​.1 obsoleted support for SoGLRenderAction::addMethod()​. Instead, GLRender() might be called directly, and to optimize traversal, the SoSeparator 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​. SoSeparator::GLRenderBelowPath() do not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children​. Reimplemented from SoSeparator​. References SoAction::getState(), SoSeparator::GLRenderBelowPath(), mode, ON, SoState::pop(), and SoState::push()​.

void SoLocateHighlight::GLRenderInPath (SoGLRenderAction * action) [virtual]Implements the SoAction::IN_PATH traversal method for the rendering action​. Reimplemented from SoSeparator​. References SoAction::getState(), SoSeparator::GLRenderInPath(), mode, ON, SoState::pop(), and SoState::push()​.

void SoLocateHighlight::turnOffCurrentHighlight (SoGLRenderAction * action) [static]Static method that can be used to turn off the current highlight​.

void SoLocateHighlight::redrawHighlighted (SoAction * act, SbBool flag) [protected], [virtual]Empty method in Coin​. Can be used by subclasses to be told when status change​. Reimplemented in SoWWWAnchor​. Referenced by handleEvent(), and SoWWWAnchor::redrawHighlighted()​.

Member Data Documentation

SoSFColor SoLocateHighlight::colorThe color used for highlighting​. Default is [0​.3, 0​.3, 0​.3], a dark gray​. Referenced by SoLocateHighlight()​.

SoSFEnum SoLocateHighlight::styleThe highlight style​. Default is SoLocateHighlight::EMISSIVE​. Referenced by SoLocateHighlight()​.

SoSFEnum SoLocateHighlight::modeThe highlight mode​. Default is SoLocateHighlight::AUTO​. Referenced by GLRenderBelowPath(), GLRenderInPath(), handleEvent(), and SoLocateHighlight()​.

AuthorGenerated automatically by Doxygen for Coin from the source code​.
0
Johanes Gumabo
Data Size   :   34,859 byte
man-SoLocateHighlight.3coin2Build   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   3 / 238,335
Visitor ID   :     :  
Visitor IP   :   18.226.28.97   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.