---

SoExtSelection Class Reference

The SoExtSelection class can be used for extended selection functionality. More...

#include <Inventor/nodes/SoExtSelection.h>

Inheritance diagram for SoExtSelection::

List of all members.

Public Types
enum	LassoType { NOLASSO, LASSO, RECTANGLE }
enum	LassoPolicy { FULL_BBOX, PART_BBOX, FULL, PART }
Public Methods
	SoExtSelection (void)
void	useOverlay (SbBool overlay=TRUE)
SbBool	isUsingOverlay (void)
SoSeparator *	getOverlaySceneGraph (void)
void	setOverlayLassoColorIndex (const int index)
int	getOverlayLassoColorIndex (void)
void	setLassoColor (const SbColor &color)
const SbColor &	getLassoColor (void)
void	setLassoWidth (const float width)
float	getLassoWidth (void)
void	setOverlayLassoPattern (const unsigned short pattern)
unsigned short	getOverlayLassoPattern (void)
void	animateOverlayLasso (const SbBool animate=TRUE)
SbBool	isOverlayLassoAnimated (void)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
void	setLassoFilterCallback (SoLassoSelectionFilterCB *f, void *userdata=NULL, const SbBool callonlyifselectable=TRUE)
void	setTriangleFilterCallback (SoExtSelectionTriangleCB *func, void *userdata=NULL)
void	setLineSegmentFilterCallback (SoExtSelectionLineSegmentCB *func, void *userdata=NULL)
void	setPointFilterCallback (SoExtSelectionPointCB *func, void *userdata=NULL)
SbBool	wasShiftDown (void) const
Static Public Methods
void	initClass (void)
Public Attributes
SoSFEnum	lassoType
SoSFEnum	lassoPolicy
Protected Methods
virtual	~SoExtSelection ()

---

Detailed Description

The SoExtSelection class can be used for extended selection functionality.

This class enables you to select geometry by specifying a lasso (a polygon) or a rectangle on screen. When objects are selected, you'll receive the same callbacks as for the SoSelection node.

This node class is an extension versus the original SGI Inventor v2.1 API. It is based on the API of TGS Inventor's SoExtSelection, and we aim to be fully compatible with this node to enable users to switch between using Coin and TGS Inventor. Please contact us if you find discrepancies between Coin SoExtSelection and TGS SoExtSelection.

---

Member Enumeration Documentation

enum SoExtSelection::LassoType

Enum for type of lasso selection. Enumeration values: NOLASSO   Makes this node behave like a normal SoSelection node. LASSO   Selecti objects using a lasso. RECTANGLE   Select objects using a rectangle.

enum SoExtSelection::LassoPolicy

Enum for specifying how objects are selected. Enumeration values: FULL_BBOX   The entire bounding box must be inside the lasso/rectangle. PART_BBOX   Some part of the bounding box must intersect the lasso/rectangle. FULL   All primitives must be completely inside the lasso/rectangle. PART   Some primitive must intersect the lasso/rectangle.

---

Constructor & Destructor Documentation

SoExtSelection::SoExtSelection (  void )

Constructor.

SoExtSelection::~SoExtSelection (  )  [protected, virtual]

Destructor.

---

Member Function Documentation

void SoExtSelection::initClass (  void )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Reimplemented from SoSelection.

void SoExtSelection::useOverlay (  SbBool overlay = TRUE )

Specifies whether the overlay planes should be used to render the lasso. This method has been obsoleted in Coin, as most graphics cards comes without support for overlay rendering. A better strategy is to just "overlay" the lasso graphics on top of the scene after everything else has been rendered -- and this is the strategy we apply in Coin.

SbBool SoExtSelection::isUsingOverlay (  void )

Returns whether overlay planes are used to draw the lasso. See also: useOverlay().

SoSeparator * SoExtSelection::getOverlaySceneGraph (  void )

Returns the scene graph for overlay rendering. Will always return NULL in Coin, as this method has been obsoleted. (It is probably used in TGS Inventor from the SoXt / SoWin libraries' So[Xt|Win]RenderArea class to fetch the overlay graph to draw, and as such should be treated as an internal method.)

void SoExtSelection::setOverlayLassoColorIndex (  const int index )

Obsoleted in Coin, use SoExtSelection::setLassoColor() instead.

int SoExtSelection::getOverlayLassoColorIndex (  void )

Obsoleted in Coin, use SoExtSelection::getLassoColor() instead. See also: setOverlayLassoColorIndex().

void SoExtSelection::setLassoColor (  const SbColor & color )

Sets the lasso/rectangle line color. Default value is (1.0, 1.0, 1.0).

const SbColor & SoExtSelection::getLassoColor (  void )

Returns the lasso color.

void SoExtSelection::setLassoWidth (  const float width )

Sets the lasso line width. Default value is 1.0.

float SoExtSelection::getLassoWidth (  void )

Returns the lasso line width.

void SoExtSelection::setOverlayLassoPattern (  const unsigned short pattern )

Sets the lasso line pattern. Default value is 0xf0f0.

unsigned short SoExtSelection::getOverlayLassoPattern (  void )

Returns the lasso line pattern.

void SoExtSelection::animateOverlayLasso (  const SbBool animate = TRUE )

Sets whether the lasso should be animated by scrolling the line pattern.

SbBool SoExtSelection::isOverlayLassoAnimated (  void )

Returns whether the lasso is set to animate or not.

void SoExtSelection::handleEvent (  SoHandleEventAction * action )  [virtual]

Overloaded to handle lasso selection. Reimplemented from SoSelection.

void SoExtSelection::GLRenderBelowPath (  SoGLRenderAction * action )  [virtual]

Overloaded to render lasso. Reimplemented from SoSeparator.

void SoExtSelection::setLassoFilterCallback (  SoLassoSelectionFilterCB * f, void * userdata = NULL, const SbBool callonlyifselectable = TRUE )

The lasso selection filter callback is called when a node is about to be selected, and enables the application programmer to return a new path to be used when selecting. The new returned path should not be ref'd. SoExtSelection will ref() and unref() it. To cancel the selection, return NULL from the callback. if callonlyifselectable is TRUE, the callback will only be invoked when the path to the new node pass through the SoExtSelection node. This method is specific to Coin, and is not part of TGS OIV.

void SoExtSelection::setTriangleFilterCallback (  SoExtSelectionTriangleCB * func, void * userdata = NULL )

Sets the callback that will be called for every triangle inside the lasso/rectangle when selecting. The user should return FALSE if he/she wants to continue receiving callbacks. When the user returns TRUE, the object/shape is selected, and no more callbacks will be invoked for the object.

void SoExtSelection::setLineSegmentFilterCallback (  SoExtSelectionLineSegmentCB * func, void * userdata = NULL )

Sets the callback that will be called for every line segment inside the lasso/rectangle when selecting. The user should return FALSE if he/she wants to continue receiving callbacks. When the user returns TRUE, the object/shape is selected, and no more callbacks will be invoked for the object.

void SoExtSelection::setPointFilterCallback (  SoExtSelectionPointCB * func, void * userdata = NULL )

Sets the callback that will be called for every point inside the lasso/rectangle when selecting. The user should return FALSE if he/she wants to continue receiving callbacks. When the user returns TRUE, the object/shape is selected, and no more callbacks will be invoked for the object.

SbBool SoExtSelection::wasShiftDown (  void )  const

Returns whether the SHIFT key was pressed during the latest user interaction. This is useful if you want to respect the shift policy while selecting primitives. This method is specific to Coin, and is not part of TGS OIV.

---

Member Data Documentation

SoSFEnum SoExtSelection::lassoType

Field for lasso type. Default value is NOLASSO.

SoSFEnum SoExtSelection::lassoPolicy

Field for lasso policy. Default value is FULL_BBOX.

---

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

• SoExtSelection.cpp
• SoExtSelection.h

---