SmSwitchboardOperator Class Reference

The SwitchboardOperator class is a group node that can toggle children on and off arbitrarily based on keyboard events. More...

#include <SmallChange/nodes/SmSwitchboardOperator.h>

Inherits SmSwitchboard.

Public Types
enum	Behavior {   NONE, TOGGLE, HOLD, INVERSE_HOLD,   TIME_HOLD }
enum	Key {   ANY = SoKeyboardEvent::ANY, UNDEFINED = SoKeyboardEvent::UNDEFINED, LEFT_SHIFT = SoKeyboardEvent::LEFT_SHIFT, RIGHT_SHIFT = SoKeyboardEvent::RIGHT_SHIFT,   LEFT_CONTROL = SoKeyboardEvent::LEFT_CONTROL, RIGHT_CONTROL = SoKeyboardEvent::RIGHT_CONTROL, LEFT_ALT = SoKeyboardEvent::LEFT_ALT, RIGHT_ALT = SoKeyboardEvent::RIGHT_ALT,   CAPS_LOCK = SoKeyboardEvent::CAPS_LOCK, A = SoKeyboardEvent::A, B = SoKeyboardEvent::B, C = SoKeyboardEvent::C,   D = SoKeyboardEvent::D, E = SoKeyboardEvent::E, F = SoKeyboardEvent::F, G = SoKeyboardEvent::G,   H = SoKeyboardEvent::H, I = SoKeyboardEvent::I, J = SoKeyboardEvent::J, K = SoKeyboardEvent::K,   L = SoKeyboardEvent::L, M = SoKeyboardEvent::M, N = SoKeyboardEvent::N, O = SoKeyboardEvent::O ,   Q = SoKeyboardEvent::Q, R = SoKeyboardEvent::R, S = SoKeyboardEvent::S, T = SoKeyboardEvent::T,   U = SoKeyboardEvent::U, V = SoKeyboardEvent::V, W = SoKeyboardEvent::W, X = SoKeyboardEvent::X,   Y = SoKeyboardEvent::Y, Z = SoKeyboardEvent::Z, NUMBER_0 = SoKeyboardEvent::NUMBER_0, NUMBER_1 = SoKeyboardEvent::NUMBER_1,   NUMBER_2 = SoKeyboardEvent::NUMBER_2, NUMBER_3 = SoKeyboardEvent::NUMBER_3, NUMBER_4 = SoKeyboardEvent::NUMBER_4, NUMBER_5 = SoKeyboardEvent::NUMBER_5,   NUMBER_6 = SoKeyboardEvent::NUMBER_6, NUMBER_7 = SoKeyboardEvent::NUMBER_7, NUMBER_8 = SoKeyboardEvent::NUMBER_8, NUMBER_9 = SoKeyboardEvent::NUMBER_9,   MINUS = SoKeyboardEvent::MINUS, EQUAL = SoKeyboardEvent::EQUAL, SPACE = SoKeyboardEvent::SPACE, BACKSPACE = SoKeyboardEvent::BACKSPACE,   TAB = SoKeyboardEvent::TAB, RETURN = SoKeyboardEvent::RETURN, BRACKETLEFT = SoKeyboardEvent::BRACKETLEFT, BRACKETRIGHT = SoKeyboardEvent::BRACKETRIGHT,   SEMICOLON = SoKeyboardEvent::SEMICOLON, APOSTROPHE = SoKeyboardEvent::APOSTROPHE, COMMA = SoKeyboardEvent::COMMA, PERIOD = SoKeyboardEvent::PERIOD,   SLASH = SoKeyboardEvent::SLASH, BACKSLASH = SoKeyboardEvent::BACKSLASH, GRAVE = SoKeyboardEvent::GRAVE }
Public Types inherited from SoNode
enum	NodeType

Public Member Functions
	SmSwitchboardOperator (void)
	SmSwitchboardOperator (int numchildren)
virtual void	handleEvent (SoHandleEventAction *action)
Public Member Functions inherited from SmSwitchboard
	SmSwitchboard (void)
	SmSwitchboard (int numchildren)
virtual void	doAction (SoAction *action)
virtual void	callback (SoCallbackAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	pick (SoPickAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	search (SoSearchAction *action)
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	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 Public Member Functions inherited from SmSwitchboard
static void	initClass (void)
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
SoMFEnum	key
SoMFEnum	behavior
SoMFInt32	msecs
Public Attributes inherited from SmSwitchboard
SoMFBool	enable
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	~SmSwitchboardOperator (void)
Protected Member Functions inherited from SmSwitchboard
virtual	~SmSwitchboard (void)
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
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 SwitchboardOperator class is a group node that can toggle children on and off arbitrarily based on keyboard events.

Member Enumeration Documentation

Behavior

enum SmSwitchboardOperator::Behavior

Enumerator
NONE
TOGGLE
HOLD
INVERSE_HOLD
TIME_HOLD

Key

enum SmSwitchboardOperator::Key

Enumerator
ANY
UNDEFINED
LEFT_SHIFT
RIGHT_SHIFT
LEFT_CONTROL
RIGHT_CONTROL
LEFT_ALT
RIGHT_ALT
CAPS_LOCK
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
Q
R
S
T
U
V
W
X
Y
Z
NUMBER_0
NUMBER_1
NUMBER_2
NUMBER_3
NUMBER_4
NUMBER_5
NUMBER_6
NUMBER_7
NUMBER_8
NUMBER_9
MINUS
EQUAL
SPACE
BACKSPACE
TAB
RETURN
BRACKETLEFT
BRACKETRIGHT
SEMICOLON
APOSTROPHE
COMMA
PERIOD
SLASH
BACKSLASH
GRAVE

Constructor & Destructor Documentation

SmSwitchboardOperator() [1/2]

SmSwitchboardOperator::SmSwitchboardOperator

(

void

)

SmSwitchboardOperator() [2/2]

SmSwitchboardOperator::SmSwitchboardOperator

(

int

numchildren

)

~SmSwitchboardOperator()

SmSwitchboardOperator::~SmSwitchboardOperator ( void  )

protectedvirtual

Member Function Documentation

handleEvent()

void SmSwitchboardOperator::handleEvent ( SoHandleEventAction *  action )

virtual

Reimplemented from SmSwitchboard.

initClass()

void SmSwitchboardOperator::initClass ( void  )

static

Member Data Documentation

behavior

SoMFEnum SmSwitchboardOperator::behavior

key

SoMFEnum SmSwitchboardOperator::key

msecs

SoMFInt32 SmSwitchboardOperator::msecs

---

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

• C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/SmSwitchboardOperator.h
• C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/SwitchboardOperator.cpp