SoLassoScreenDrawer Class Reference

Interactively draw a lasso in normalized screen space. More...

#include <Inventor/drawers/SoLassoScreenDrawer.h>

Inheritance diagram for SoLassoScreenDrawer:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoLassoScreenDrawer ()
	Constructor.
virtual void	reset ()
	Clears the points in the line and resets internal state to initial values.
Public Member Functions inherited from SoPolyLineScreenDrawer
	SoPolyLineScreenDrawer ()
	Constructor.
virtual void	clear ()
	Convenience method to clear the points in the line.
Public Member Functions inherited from SoScreenDrawer
	SoScreenDrawer ()
	Constructor.
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 SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
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.
Static Public Member Functions inherited from SoPolyLineScreenDrawer
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoScreenDrawer
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.

Additional Inherited Members
Public Attributes inherited from SoPolyLineScreenDrawer
SoSFUInt32	simplificationThreshold
	Threshold (in pixels) used to simplify line when it is finished.
SoSFBool	doCCW
	Make the line counter-clockwise when it is finalized.
SoSFColor	color
	Color of line.
SoMFVec2f	point
	Points of line.
SoSFBool	isClosed
	Close the line during display (connect last point to first point).
SoSFUShort	linePattern
	Stipple pattern.
SoSFInt32	linePatternScaleFactor
	Stipple pattern scale factor.
SoSFFloat	lineWidth
	Width of lines.
SbEventHandler< const EventArg & >	onStart
	Event raised when starting to draw a polyline.
SbEventHandler< const EventArg & >	onMove
	Event raised during polyline drawing.
SbEventHandler< EventArg & >	onFinish
	Event raised when the line is finished.
Public Attributes inherited from SoScreenDrawer
SoSFNode	sceneGraph
	Scene graph to render.

Detailed Description

Interactively draw a lasso in normalized screen space.

This class can be used to interactively draw a lasso (freeform shape) on screen.

When the lasso is finished, an event is raised to notify the application (see SoPolyLineScreenDrawer::onFinish ). Points are returned as normalized coordinates in the range -1..1, which is conveniently the default view volume for an SoOrthographicCamera node.

The line color and simplification threshold are specified by fields in the parent class SoPolyLineScreenDrawer.

Please see SoPolyLineScreenDrawer for general notes and code example.

Lasso specific notes:

• The simplificationThreshold field does apply to this node.
• If user finishes a lasso, then the next click will automatically clear the polyline (begin a new lasso).
• SbEventHandlers:
  • OnStart : Triggered on LeftMouseDown input event.
  • OnMove : Triggered on MouseMove input events (after Start).
  • OnFinish : Triggered on LeftMouseUp input event.

[C++]
Screen drawer classes must be initialized by calling SoInteraction::init(). High level viewer init methods, like SoWin::init(), automatically do this. However, if the application is calling SoDB::init() directly, then it is usually necessary to also call SoInteraction::init() before using the screen drawer classes.

USAGE

• Press left mouse and drag to draw the lasso.
• Release to finish the lasso.
• Press Escape to cancel construction of the lasso.

FILE FORMAT/DEFAULT

LassoScreenDrawer {

point	[]
color	1 0 0
simplificationThreshold	5
isClosed	TRUE

}

SEE ALSO

SoEllipseScreenDrawer, SoPolyLineScreenDrawer, SoPolygonScreenDrawer, SoRectangleScreenDrawer

Definition at line 87 of file SoLassoScreenDrawer.h.

Constructor & Destructor Documentation

SoLassoScreenDrawer()

SoLassoScreenDrawer::SoLassoScreenDrawer

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoLassoScreenDrawer::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoLassoScreenDrawer::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoPolyLineScreenDrawer.

reset()

virtual void SoLassoScreenDrawer::reset ( )

virtual

Clears the points in the line and resets internal state to initial values.

This cancels any current drawing.

Since Open Inventor 10.7.3

Reimplemented from SoPolyLineScreenDrawer.

---

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

• Inventor/drawers/SoLassoScreenDrawer.h