vrui::coAction Class Reference

classes that are derived from coAction can be attached tho the scenegraph and will be called when user interacts with the object More...

#include <coAction.h>

Inheritance diagram for vrui::coAction:

Public Types
enum	Result { ACTION_DONE = 0x00 , ACTION_CALL_ON_MISS = 0x01 , ACTION_UNDEF = 0x02 }

Public Member Functions
	coAction ()
	Constructor. More...
virtual	~coAction ()
	Destructor. More...
virtual int	hit (vruiHit *hit)=0
	hit is called whenever the node, or any node underneath the node with this action is intersected return ACTION_CALL_ON_MISS if you want miss to be called otherwise return ACTION_DONE More...
virtual void	miss ()
	miss is called once after a hit, if the node is not intersected anymore More...
void	setFrame (unsigned int frame)
	INTERNAL set the framecounter (used to produce the miss call) More...
unsigned int	getFrame () const
	INTERNAL get the framecounter (used to produce the miss call) More...
void	setNode (vruiNode *)
	INTERNAL set the node this action belongs to. More...
void	addChild (coAction *)
	INTERNAL add a child action. More...
virtual int	hitAll (vruiHit *hit)
	INTERNAL same as miss/hit, but do it for all children as well. More...
virtual void	missAll ()
	INTERNAL same as miss/hit, but do it for all children as well. More...

Protected Attributes
std::string	actionName
	name of this action this can be used to distinguish betwenn different types of actions like touch and intersection actions More...

Detailed Description

classes that are derived from coAction can be attached tho the scenegraph and will be called when user interacts with the object

Member Enumeration Documentation

Result

enum vrui::coAction::Result

Enumerator
ACTION_DONE
ACTION_CALL_ON_MISS
ACTION_UNDEF

Constructor & Destructor Documentation

coAction()

vrui::coAction::coAction

(

)

Constructor.

~coAction()

vrui::coAction::~coAction ( )

virtual

Destructor.

Member Function Documentation

addChild()

void vrui::coAction::addChild

(

coAction *

child

)

INTERNAL add a child action.

getFrame()

unsigned int vrui::coAction::getFrame ( ) const

inline

INTERNAL get the framecounter (used to produce the miss call)

hit()

virtual int vrui::coAction::hit ( vruiHit *  hit )

pure virtual

hit is called whenever the node, or any node underneath the node with this action is intersected return ACTION_CALL_ON_MISS if you want miss to be called otherwise return ACTION_DONE

Implemented in vrui::coIconButtonToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coPotiToolboxItem, vrui::coSliderToolboxItem, vrui::coButton, vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coMenu, vrui::coPanel, vrui::coPopupHandle, vrui::coPotiMenuItem, vrui::coRotButton, vrui::coRowMenu, vrui::coRowMenuHandle, vrui::coSlider, vrui::coSliderMenuItem, vrui::coSubMenuItem, vrui::coTexturedBackground, vrui::coTextureRectBackground, vrui::coToolboxMenuHandle, vrui::coValuePoti, and vrui::coSubMenuToolboxItem.

hitAll()

int vrui::coAction::hitAll ( vruiHit *  hit )

virtual

INTERNAL same as miss/hit, but do it for all children as well.

miss()

void vrui::coAction::miss ( )

virtual

miss is called once after a hit, if the node is not intersected anymore

Reimplemented in vrui::coButton, vrui::coPushButton, vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coIconButtonToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coMenu, vrui::coPanel, vrui::coPopupHandle, vrui::coPotiMenuItem, vrui::coPotiToolboxItem, vrui::coRotButton, vrui::coRotPushButton, vrui::coRowMenu, vrui::coRowMenuHandle, vrui::coSlider, vrui::coSliderMenuItem, vrui::coSliderToolboxItem, vrui::coSubMenuItem, vrui::coTexturedBackground, vrui::coTextureRectBackground, vrui::coToolboxMenuHandle, vrui::coValuePoti, and vrui::coSubMenuToolboxItem.

missAll()

void vrui::coAction::missAll ( )

virtual

INTERNAL same as miss/hit, but do it for all children as well.

setFrame()

void vrui::coAction::setFrame ( unsigned int  frame )

inline

INTERNAL set the framecounter (used to produce the miss call)

setNode()

void vrui::coAction::setNode

(

vruiNode *

node

)

INTERNAL set the node this action belongs to.

Member Data Documentation

actionName

std::string vrui::coAction::actionName

protected

name of this action this can be used to distinguish betwenn different types of actions like touch and intersection actions

---

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

• coAction.h
• coAction.cpp