SoLocateHighlight Class Reference

Special separator that performs locate highlighting. More...

#include <Inventor/nodes/SoLocateHighlight.h>

Inheritance diagram for SoLocateHighlight:

Public Types
enum	Styles {   EMISSIVE ,   EMISSIVE_DIFFUSE }
	Possible values for draw style. More...
enum	Modes {   AUTO ,   ON ,   OFF }
	Possible values for the mode. More...
Public Types inherited from SoSeparator
enum	CacheEnabled {   OFF ,   ON ,   AUTO }
	Possible values for caching. More...
enum	FastEditing {   DISABLE = 0x01 ,   KEEP_ZBUFFER = 0x02 ,   CLEAR_ZBUFFER = 0x03 }
	Fast editing policy enumeration values. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoLocateHighlight ()
	Creates a LocateHighlight node with default settings.
Public Member Functions inherited from SoSeparator
	SoSeparator ()
	Creates a separator node with default settings.
	SoSeparator (int nChildren)
	Constructor that takes approximate number of children.
Public Member Functions inherited from SoGroup
	SoGroup ()
	Creates an empty group node.
	SoGroup (int nChildren)
	Constructor that takes approximate number of children.
virtual void	addChild (SoNode *child)
	Adds a child as last one in group.
virtual void	insertChild (SoNode *child, int newChildIndex)
	Adds a child so that it becomes the one with the given index.
virtual SoNode *	getChild (int index) const
	Returns pointer the child node with the given index.
virtual int	findChild (const SoNode *child) const
	Finds index of given child within group.
virtual int	getNumChildren () const
	Returns number of children.
virtual void	removeChild (int index)
	Removes child with given index from group.
virtual void	removeChild (SoNode *child)
	Removes first instance of given child from group.
virtual void	removeAllChildren ()
	Removes all children from group.
virtual void	replaceChild (int index, SoNode *newChild)
	Replaces child with given index with new child.
virtual void	replaceChild (SoNode *oldChild, SoNode *newChild)
	Replaces first instance of given child with new child.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Deprecated
static SoDEPRECATED void	turnOffCurrentHighlight (SoGLRenderAction *action)
	This will de-highlight the currently highlighted node if any.
Static Public Member Functions inherited from SoSeparator
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoGroup
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFColor	color
	Highlighting color - default [.3, .3, .3].
SoSFEnum	style
	Highlighting draw style.
SoSFEnum	mode
	Whether to highlight or not.
Public Attributes inherited from SoSeparator
SoSFEnum	boundingBoxCaching
	Whether to cache during bounding box traversal.
SoSFEnum	renderCulling
	Whether to cull during rendering traversal.
SoSFEnum	pickCulling
	Whether to cull during picking traversal.
SoSFEnum	fastEditing
	Specifies the fast edit mode of the separator node.
SoSFInt32	renderUnitId
	Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.
SoDEPRECATED SoSFEnum	renderCaching
	Whether to cache during rendering traversal.
Public Attributes inherited from SoGroup
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Additional Inherited Members
Related Symbols inherited from SoSeparator
#define	SO_RENDERUNITID_NONE   (-1)
	Don't traverse any children.
#define	SO_RENDERUNITID_INHERIT   (-2)
	Inherit value from state.
#define	SO_RENDERUNITID_ALL   (-3)
	Traverse all children.

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.

Limitations:

• When using a SceneExaminer, subgraph can remain highlighted after switching from selection mode to viewing mode.
• When using an examiner viewer or a SceneExaminer, subgraph can remain unhighlighted when switching from viewing mode to selection mode until the mouse is moved.

• The SceneOrbiter does not have such limitation.

  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 {

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

Definition at line 131 of file SoLocateHighlight.h.

Member Enumeration Documentation

Modes

enum SoLocateHighlight::Modes

Possible values for the mode.

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

Definition at line 151 of file SoLocateHighlight.h.

Styles

enum SoLocateHighlight::Styles

Possible values for draw style.

Enumerator
EMISSIVE	Changes emissive color only (default)
EMISSIVE_DIFFUSE	Changes emissive and diffuse colors.

Definition at line 139 of file SoLocateHighlight.h.

Constructor & Destructor Documentation

SoLocateHighlight()

SoLocateHighlight::SoLocateHighlight

(

)

Creates a LocateHighlight node with default settings.

Member Function Documentation

getClassTypeId()

static SoType SoLocateHighlight::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoLocateHighlight::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoSeparator.

Reimplemented in SoWWWAnchor.

turnOffCurrentHighlight()

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.

Member Data Documentation

color

SoSFColor SoLocateHighlight::color

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

Definition at line 171 of file SoLocateHighlight.h.

mode

SoSFEnum SoLocateHighlight::mode

Whether to highlight or not.

Use enum Modes. Default OFF.

Definition at line 181 of file SoLocateHighlight.h.

style

SoSFEnum SoLocateHighlight::style

Highlighting draw style.

Use enum Styles. Default EMISSIVE.

Definition at line 176 of file SoLocateHighlight.h.

---

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

• Inventor/nodes/SoLocateHighlight.h