vrui::vruiCollabInterface Class Reference

base class for collaborative Userinterface elements More...

#include <vruiCollabInterface.h>

Inheritance diagram for vrui::vruiCollabInterface:

Public Types
enum	{   NONE = 10 , VALUEPOTI = 11 , HSVWHEEL = 12 , PUSHBUTTON = 13 ,   TOGGLEBUTTON = 14 , FunctionEditor = 15 , PinEditor = 16 }

Public Member Functions
	vruiCollabInterface (vruiCOIM *manager, const std::string &interfaceName, int iType=NONE)
	Constructor. More...
virtual	~vruiCollabInterface ()
	Destructor, removes references to this interface from its coim. More...
int	getType () const
	get the interface type More...
vruiCOIM *	getManager ()
virtual void	parseMessage (int type, unsigned int len, const char *message)
	this method is called when a message from a remote UI arrives More...

Protected Member Functions
void	setType (int interfaceType)
	set the type of the this interface More...
void	sendLockMessage (const char *message)
	lock the interaction with remote interfaces More...
void	sendOngoingMessage (const char *message)
	send interactions to remote interfaces More...
void	sendReleaseMessage (const char *message)
	unlock the interaction with remote interfaces More...
virtual void	remoteLock (const char *message)
	this method is called whenever a remote interaction is started. More...
virtual void	remoteOngoing (const char *message)
	this method is called whenever a remote interaction is going on. More...
virtual void	releaseRemoteLock (const char *message)
	this method is called whenever a remote interaction is finished. More...

Protected Attributes
int	remoteContext
	a remote context (if this UI element is used in several contexts) More...

Detailed Description

base class for collaborative Userinterface elements

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NONE
VALUEPOTI
HSVWHEEL
PUSHBUTTON
TOGGLEBUTTON
FunctionEditor
PinEditor

Constructor & Destructor Documentation

vruiCollabInterface()

vrui::vruiCollabInterface::vruiCollabInterface	(	vruiCOIM *	manager,
		const std::string &	interfaceName,
		int	iType = NONE
	)

Constructor.

Parameters

c	the current coim
interfaceName	symbolic name of this UI
iType	interface type

~vruiCollabInterface()

vrui::vruiCollabInterface::~vruiCollabInterface ( )

virtual

Destructor, removes references to this interface from its coim.

Member Function Documentation

getManager()

vruiCOIM * vrui::vruiCollabInterface::getManager ( )

inline

getType()

int vrui::vruiCollabInterface::getType

(

)

const

get the interface type

Returns

the type of this interface

parseMessage()

void vrui::vruiCollabInterface::parseMessage ( int  type, unsigned int  len, const char *  message  )

virtual

this method is called when a message from a remote UI arrives

Parameters

type	message type
len	message length
message	the message

releaseRemoteLock()

void vrui::vruiCollabInterface::releaseRemoteLock ( const char *  message )

protectedvirtual

this method is called whenever a remote interaction is finished.

local ineractions should be allowed again.

Parameters

message

custom message from remote ui

Reimplemented in vrui::coValuePoti.

remoteLock()

void vrui::vruiCollabInterface::remoteLock ( const char *  message )

protectedvirtual

this method is called whenever a remote interaction is started.

local ineractions should be locked now.

Parameters

message

custom message from remote ui

Reimplemented in vrui::coValuePoti.

remoteOngoing()

void vrui::vruiCollabInterface::remoteOngoing ( const char *  message )

protectedvirtual

this method is called whenever a remote interaction is going on.

local events should be generated.

Parameters

message

custom message from remote ui (e.g. current value)

Reimplemented in vrui::coValuePoti, and vrui::coSlopePoti.

sendLockMessage()

void vrui::vruiCollabInterface::sendLockMessage ( const char *  message )

protected

lock the interaction with remote interfaces

Parameters

message

custom message sent to remote uis

sendOngoingMessage()

void vrui::vruiCollabInterface::sendOngoingMessage ( const char *  message )

protected

send interactions to remote interfaces

Parameters

message

custom message (e.g. current value) sent to remote uis

sendReleaseMessage()

void vrui::vruiCollabInterface::sendReleaseMessage ( const char *  message )

protected

unlock the interaction with remote interfaces

Parameters

message

custom message sent to remote uis

setType()

void vrui::vruiCollabInterface::setType ( int  iType )

protected

set the type of the this interface

Parameters

iType

interface type

Member Data Documentation

remoteContext

int vrui::vruiCollabInterface::remoteContext

protected

a remote context (if this UI element is used in several contexts)

---

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

• vruiCollabInterface.h
• base/vruiCollabInterface.cpp