The PickCallback class is group node with callbacks when some child is picked. More...

#include <Inventor/nodes/PickCallback.h>

Public Member Functions
	PickCallback (void)

const SoPickedPoint *	getCurrentPickedPoint (void) const

SbBool	isButton1 (void) const

SbBool	isButton2 (void) const

void	addCallback (void(callback)(void , SoPath ), void userdata)

void	removeCallback (void(callback)(void , SoPath ), void userdata)

SbVec2s	getEventPosition (void) const

SbBool	currentIsMouseDown (void) const

const SbViewportRegion &	getEventViewportRegion (void) const

Public Member Functions inherited from SoGroup
virtual SoType	getTypeId (void) const

	SoGroup (void)

	SoGroup (int nchildren)

virtual void	addChild (SoNode *node)

virtual void	insertChild (SoNode *child, int newchildindex)

virtual SoNode *	getChild (int index) const

virtual int	findChild (const SoNode *node) const

virtual int	getNumChildren (void) const

virtual void	removeChild (int childindex)

virtual void	removeChild (SoNode *child)

virtual void	removeAllChildren (void)

virtual void	replaceChild (int index, SoNode *newchild)

virtual void	replaceChild (SoNode oldchild, SoNode newchild)

virtual void	doAction (SoAction *action)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	callback (SoCallbackAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	pick (SoPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void	audioRender (SoAudioRenderAction *action)

virtual SoChildList *	getChildren (void) const

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

Public Member Functions inherited from SoNode
void	setOverride (const SbBool state)

SbBool	isOverride (void) const

void	setNodeType (const NodeType type)

NodeType	getNodeType (void) const

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

virtual SbBool	affectsState (void) const

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	grabEventsSetup (void)

virtual void	grabEventsCleanup (void)

virtual void	startNotify (void)

virtual void	notify (SoNotList *l)

SbUniqueId	getNodeId (void) const

virtual void	writeInstance (SoOutput *out)

virtual SoNode *	addToCopyDict (void) const

virtual SoFieldContainer *	copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)

SbBool	hasDefaultValues (void) const

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	set (const char *const fielddata)

void	get (SbString &fielddata)

virtual int	getFields (SoFieldList &l) const

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getField (const SbName &name) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

SbBool	enableNotify (const SbBool flag)

SbBool	isNotifyEnabled (void) const

SbBool	set (const char fielddata, SoInput input)

void	get (SbString &fielddata, SoOutput *out)

virtual SbBool	validateNewFieldValue (SoField field, void newval)

SbBool	getIsBuiltIn (void) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

void	setUserData (void *userdata) const

void *	getUserData (void) const

Public Member Functions inherited from SoBase
void	ref (void) const

void	unref (void) const

void	unrefNoDelete (void) const

int32_t	getRefCount (void) const

void	touch (void)

SbBool	isOfType (SoType type) const

virtual SbName	getName (void) const

virtual void	setName (const SbName &newname)

void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

const SoAuditorList &	getAuditors (void) const

SbBool	shouldWrite (void)

void	assertAlive (void) const

Static Public Member Functions
static void	initClass (void)

static void	setSchemeEvalFunctions (int(scriptcb)(const char ), void(filecb)(const char ))

Static Public Member Functions inherited from SoNode
static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static void	initClasses (void)

static SbUniqueId	getNextNodeId (void)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static void	getMatrixS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

static void	pickS (SoAction action, SoNode node)

static void	rayPickS (SoAction action, SoNode node)

static void	searchS (SoAction action, SoNode node)

static void	writeS (SoAction action, SoNode node)

static void	audioRenderS (SoAction action, SoNode node)

static void	getPrimitiveCountS (SoAction action, SoNode node)

Static Public Member Functions inherited from SoFieldContainer
static void	initCopyDict (void)

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static void	copyDone (void)

Static Public Member Functions inherited from SoBase
static void	initClass (void)

static SoType	getClassTypeId (void)

static void	addName (SoBase const base, const char const name)

static void	removeName (SoBase const base, const char const name)

static void	incrementCurrentWriteCounter (void)

static void	decrementCurrentWriteCounter (void)

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

static SbBool	getTraceRefs (void)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFBool	pickable

SoSFTrigger	trigger

SoSFBool	onMousePress

SoSFBool	onMouseRelease

SoSFBool	onButton1

SoSFBool	onButton2

SoSFBool	onButton3

SoSFString	schemeFile

SoSFString	schemeScript

SoSFVec3f	objectSpacePickedPoint

SoSFVec3f	worldSpacePickedPoint

SoSFBool	delayTrigger

Public Attributes inherited from SoNode
	INVENTOR

	VRML1

	VRML2

	INVENTOR_1

	INVENTOR_2_0

	INVENTOR_2_1

	INVENTOR_2_5

	INVENTOR_2_6

	COIN_1_0

	COIN_2_0

	EXTENSION

Protected Member Functions
virtual	~PickCallback ()

virtual void	handleEvent (SoHandleEventAction *action)

Protected Member Functions inherited from SoGroup
virtual const SoFieldData *	getFieldData (void) const

virtual	~SoGroup ()

virtual SbBool	readInstance (SoInput *in, unsigned short flags)

virtual SbBool	readChildren (SoInput *in)

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual void	destroy (void)

SbBool	hasMultipleWriteRefs (void) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName (void) const

Additional Inherited Members
Public Types inherited from SoNode
enum	NodeType

Protected Types inherited from SoBase
enum	BaseFlags

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static void	setNextActionMethodIndex (int index)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

Protected Attributes inherited from SoGroup
SoChildList *	children

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId

static int	nextActionMethodIndex

Detailed Description

The PickCallback class is group node with callbacks when some child is picked.

It provides an easy way of adding interactivity to your scene graph, since you can insert this group node in your inventor file, and just search for all PickCallback nodes when your program starts to add callbacks. You can also connect to the trigger field if you want some other node to trigger when something is picked.

Constructor & Destructor Documentation

◆ PickCallback()

PickCallback::PickCallback ( void )

Constructor.

◆ ~PickCallback()

PickCallback::~PickCallback ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ addCallback()

void PickCallback::addCallback	(	void()(void , SoPath *)	callback,
		void *	userdata
	)

Adds a callback that will be called when some node is picked.

See also: removeCallback()

◆ currentIsMouseDown()

SbBool PickCallback::currentIsMouseDown ( void ) const

◆ getCurrentPickedPoint()

const SoPickedPoint * PickCallback::getCurrentPickedPoint ( void ) const

◆ getEventPosition()

SbVec2s PickCallback::getEventPosition ( void ) const

◆ getEventViewportRegion()

const SbViewportRegion & PickCallback::getEventViewportRegion ( void ) const

◆ handleEvent()

void PickCallback::handleEvent ( SoHandleEventAction * action )

protectedvirtual

Coin method. Checks to see if some child is picked, and triggers callbacks when this happens.

Reimplemented from SoGroup.

◆ initClass()

void PickCallback::initClass ( void )

static

Required Coin method.

◆ isButton1()

SbBool PickCallback::isButton1 ( void ) const

◆ isButton2()

SbBool PickCallback::isButton2 ( void ) const

◆ removeCallback()

void PickCallback::removeCallback	(	void()(void , SoPath *)	callback,
		void *	userdata
	)

Removes a callback.

See also: addCallback()

◆ setSchemeEvalFunctions()

void PickCallback::setSchemeEvalFunctions	(	int()(const char )	scriptcb,
		void()(const char )	filecb
	)

static

Member Data Documentation

◆ delayTrigger

SoSFBool PickCallback::delayTrigger

◆ objectSpacePickedPoint

SoSFVec3f PickCallback::objectSpacePickedPoint

◆ onButton1

SoSFBool PickCallback::onButton1

◆ onButton2

SoSFBool PickCallback::onButton2

◆ onButton3

SoSFBool PickCallback::onButton3

◆ onMousePress

SoSFBool PickCallback::onMousePress

◆ onMouseRelease

SoSFBool PickCallback::onMouseRelease

◆ pickable

SoSFBool PickCallback::pickable

Can be set to FALSE to temporarily disable pick callbacks. Default value is TRUE.

◆ schemeFile

SoSFString PickCallback::schemeFile

◆ schemeScript

SoSFString PickCallback::schemeScript

◆ trigger

SoSFTrigger PickCallback::trigger

Will be triggered right after callbacks are called (if any).

◆ worldSpacePickedPoint

SoSFVec3f PickCallback::worldSpacePickedPoint

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

C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/PickCallback.h
C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/PickCallback.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members