vtkVRCollaborationClient Class Reference

#include <vtkVRCollaborationClient.h>

Inheritance diagram for vtkVRCollaborationClient:

Collaboration diagram for vtkVRCollaborationClient:

Classes
class	Argument
struct	Pose

Public Types
enum	ArgumentType { Double = 0 , Int32 , String }
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkVRCollaborationClient *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
	vtkVRCollaborationClient (const vtkVRCollaborationClient &)=delete
vtkVRCollaborationClient &	operator= (const vtkVRCollaborationClient &)=delete
virtual void	Render ()
virtual bool	Initialize (vtkOpenGLRenderer *)
void	Disconnect ()
virtual void	AddArguments (vtksys::CommandLineArguments &arguments)
void	SetCollabHost (std::string const &val)
void	SetCollabSession (std::string const &val)
void	SetCollabName (std::string const &val)
void	SetCollabPort (int val)
void	SetLogCallback (std::function< void(std::string const &data, vtkLogger::Verbosity verbosity)> cb)
void	SetScaleCallback (std::function< double()> cb)
vtkOpenGLRenderer *	GetRenderer ()
bool	GetConnected ()
void	SendAMessage (std::string const &msgType)
	method signatures to send messages with Arguments and extract them out of messages More...
void	SendAMessage (std::string const &msgType, std::vector< Argument > const &args)
	method signatures to send messages with Arguments and extract them out of messages More...
std::vector< Argument >	GetMessageArguments ()
	method signatures to send messages with Arguments and extract them out of messages More...
void	SendPoseMessage (std::string const &msgType, int index, double pos[3], double dir[3])
	method signatures to send messages with Arguments and extract them out of messages More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkVRCollaborationClient *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkVRCollaborationClient *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVRCollaborationClient ()
	~vtkVRCollaborationClient () override
void	Log (vtkLogger::Verbosity verbosity, std::string const &msg)
void	HandleCollabMessage ()
bool	AvatarIdle (std::string id)
void	EraseIdleAvatars ()
vtkSmartPointer< vtkOpenGLAvatar >	GetAvatar (std::string id)
void	SendLatestDevicePoses ()
void	UpdateAvatarPoseFromCamera ()
virtual void	HandleBroadcastMessage (std::string const &otherID, std::string const &type)
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	EventCallback (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
std::string	CollabID
std::string	CollabHost
std::string	CollabSession
std::string	CollabName
int	CollabPort
std::function< void(std::string const &data, vtkLogger::Verbosity)>	Callback
std::function< double()>	ScaleCallback
bool	DisplayOwnAvatar
bool	PublishAvailable
double	NeedHeartbeat
double	NeedReply
int	RetryCount
bool	Connected
vtkCallbackCommand *	EventCommand
long	MoveObserver
vtkOpenGLRenderer *	Renderer
vtkOpenGLRenderWindow *	RenderWindow
vtkNew< vtkTransform >	TempTransform
double	YourLastAvatarUpdateTime
bool	HasPoseForDevice [vtkEventDataNumberOfDevices]
Pose	DevicePoses [vtkEventDataNumberOfDevices]
std::map< std::string, vtkSmartPointer< vtkOpenGLAvatar > >	Avatars
std::map< std::string, double[vtkEventDataNumberOfDevices]>	AvatarUpdateTime
vtkVRCollaborationClientInternal *	Internal
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 42 of file vtkVRCollaborationClient.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkVRCollaborationClient::Superclass

Definition at line 46 of file vtkVRCollaborationClient.h.

Member Enumeration Documentation

ArgumentType

enum vtkVRCollaborationClient::ArgumentType

Enumerator
Double
Int32
String

Definition at line 55 of file vtkVRCollaborationClient.h.

Constructor & Destructor Documentation

vtkVRCollaborationClient() [1/2]

vtkVRCollaborationClient::vtkVRCollaborationClient ( const vtkVRCollaborationClient &  )

delete

vtkVRCollaborationClient() [2/2]

vtkVRCollaborationClient::vtkVRCollaborationClient ( )

protected

~vtkVRCollaborationClient()

vtkVRCollaborationClient::~vtkVRCollaborationClient ( )

overrideprotected

Member Function Documentation

New()

static vtkVRCollaborationClient * vtkVRCollaborationClient::New ( )

static

IsTypeOf()

static vtkTypeBool vtkVRCollaborationClient::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkVRCollaborationClient::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkVRCollaborationClient * vtkVRCollaborationClient::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkVRCollaborationClient::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkVRCollaborationClient * vtkVRCollaborationClient::NewInstance

(

)

const

PrintSelf()

void vtkVRCollaborationClient::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

operator=()

vtkVRCollaborationClient & vtkVRCollaborationClient::operator= ( const vtkVRCollaborationClient &  )

delete

SendAMessage() [1/2]

void vtkVRCollaborationClient::SendAMessage

(

std::string const &

msgType

)

method signatures to send messages with Arguments and extract them out of messages

SendAMessage() [2/2]

void vtkVRCollaborationClient::SendAMessage	(	std::string const &	msgType,
		std::vector< Argument > const &	args
	)

method signatures to send messages with Arguments and extract them out of messages

GetMessageArguments()

std::vector< Argument > vtkVRCollaborationClient::GetMessageArguments

(

)

method signatures to send messages with Arguments and extract them out of messages

SendPoseMessage()

void vtkVRCollaborationClient::SendPoseMessage	(	std::string const &	msgType,
		int	index,
		double	pos[3],
		double	dir[3]
	)

method signatures to send messages with Arguments and extract them out of messages

Render()

virtual void vtkVRCollaborationClient::Render ( )

virtual

Initialize()

virtual bool vtkVRCollaborationClient::Initialize ( vtkOpenGLRenderer *  )

virtual

Disconnect()

void vtkVRCollaborationClient::Disconnect

(

)

AddArguments()

virtual void vtkVRCollaborationClient::AddArguments ( vtksys::CommandLineArguments &  arguments )

virtual

SetCollabHost()

void vtkVRCollaborationClient::SetCollabHost ( std::string const &  val )

inline

Definition at line 108 of file vtkVRCollaborationClient.h.

SetCollabSession()

void vtkVRCollaborationClient::SetCollabSession ( std::string const &  val )

inline

Definition at line 109 of file vtkVRCollaborationClient.h.

SetCollabName()

void vtkVRCollaborationClient::SetCollabName ( std::string const &  val )

inline

Definition at line 110 of file vtkVRCollaborationClient.h.

SetCollabPort()

void vtkVRCollaborationClient::SetCollabPort ( int  val )

inline

Definition at line 111 of file vtkVRCollaborationClient.h.

SetLogCallback()

void vtkVRCollaborationClient::SetLogCallback ( std::function< void(std::string const &data, vtkLogger::Verbosity verbosity)>  cb )

inline

Definition at line 114 of file vtkVRCollaborationClient.h.

SetScaleCallback()

void vtkVRCollaborationClient::SetScaleCallback ( std::function< double()>  cb )

inline

Definition at line 121 of file vtkVRCollaborationClient.h.

GetRenderer()

vtkOpenGLRenderer * vtkVRCollaborationClient::GetRenderer ( )

inline

Definition at line 124 of file vtkVRCollaborationClient.h.

GetConnected()

bool vtkVRCollaborationClient::GetConnected ( )

inline

Definition at line 127 of file vtkVRCollaborationClient.h.

Log()

void vtkVRCollaborationClient::Log ( vtkLogger::Verbosity  verbosity, std::string const &  msg  )

protected

HandleCollabMessage()

void vtkVRCollaborationClient::HandleCollabMessage ( )

protected

AvatarIdle()

bool vtkVRCollaborationClient::AvatarIdle ( std::string  id )

protected

EraseIdleAvatars()

void vtkVRCollaborationClient::EraseIdleAvatars ( )

protected

GetAvatar()

vtkSmartPointer< vtkOpenGLAvatar > vtkVRCollaborationClient::GetAvatar ( std::string  id )

protected

SendLatestDevicePoses()

void vtkVRCollaborationClient::SendLatestDevicePoses ( )

protected

UpdateAvatarPoseFromCamera()

void vtkVRCollaborationClient::UpdateAvatarPoseFromCamera ( )

protected

HandleBroadcastMessage()

virtual void vtkVRCollaborationClient::HandleBroadcastMessage ( std::string const &  otherID, std::string const &  type  )

protectedvirtual

EventCallback()

static void vtkVRCollaborationClient::EventCallback ( vtkObject *  object, unsigned long  event, void *  clientdata, void *  calldata  )

staticprotected

Member Data Documentation

CollabID

std::string vtkVRCollaborationClient::CollabID

protected

Definition at line 136 of file vtkVRCollaborationClient.h.

CollabHost

std::string vtkVRCollaborationClient::CollabHost

protected

Definition at line 137 of file vtkVRCollaborationClient.h.

CollabSession

std::string vtkVRCollaborationClient::CollabSession

protected

Definition at line 138 of file vtkVRCollaborationClient.h.

CollabName

std::string vtkVRCollaborationClient::CollabName

protected

Definition at line 139 of file vtkVRCollaborationClient.h.

CollabPort

int vtkVRCollaborationClient::CollabPort

protected

Definition at line 140 of file vtkVRCollaborationClient.h.

Callback

std::function<void(std::string const& data, vtkLogger::Verbosity)> vtkVRCollaborationClient::Callback

protected

Definition at line 142 of file vtkVRCollaborationClient.h.

ScaleCallback

std::function<double()> vtkVRCollaborationClient::ScaleCallback

protected

Definition at line 143 of file vtkVRCollaborationClient.h.

DisplayOwnAvatar

bool vtkVRCollaborationClient::DisplayOwnAvatar

protected

Definition at line 145 of file vtkVRCollaborationClient.h.

PublishAvailable

bool vtkVRCollaborationClient::PublishAvailable

protected

Definition at line 146 of file vtkVRCollaborationClient.h.

NeedHeartbeat

double vtkVRCollaborationClient::NeedHeartbeat

protected

Definition at line 150 of file vtkVRCollaborationClient.h.

NeedReply

double vtkVRCollaborationClient::NeedReply

protected

Definition at line 151 of file vtkVRCollaborationClient.h.

RetryCount

int vtkVRCollaborationClient::RetryCount

protected

Definition at line 152 of file vtkVRCollaborationClient.h.

Connected

bool vtkVRCollaborationClient::Connected

protected

Definition at line 154 of file vtkVRCollaborationClient.h.

EventCommand

vtkCallbackCommand* vtkVRCollaborationClient::EventCommand

protected

Definition at line 164 of file vtkVRCollaborationClient.h.

MoveObserver

long vtkVRCollaborationClient::MoveObserver

protected

Definition at line 167 of file vtkVRCollaborationClient.h.

Renderer

vtkOpenGLRenderer* vtkVRCollaborationClient::Renderer

protected

Definition at line 169 of file vtkVRCollaborationClient.h.

RenderWindow

vtkOpenGLRenderWindow* vtkVRCollaborationClient::RenderWindow

protected

Definition at line 170 of file vtkVRCollaborationClient.h.

TempTransform

vtkNew<vtkTransform> vtkVRCollaborationClient::TempTransform

protected

Definition at line 172 of file vtkVRCollaborationClient.h.

YourLastAvatarUpdateTime

double vtkVRCollaborationClient::YourLastAvatarUpdateTime

protected

Definition at line 175 of file vtkVRCollaborationClient.h.

HasPoseForDevice

bool vtkVRCollaborationClient::HasPoseForDevice[vtkEventDataNumberOfDevices]

protected

Definition at line 176 of file vtkVRCollaborationClient.h.

DevicePoses

Pose vtkVRCollaborationClient::DevicePoses[vtkEventDataNumberOfDevices]

protected

Definition at line 182 of file vtkVRCollaborationClient.h.

Avatars

std::map<std::string, vtkSmartPointer<vtkOpenGLAvatar> > vtkVRCollaborationClient::Avatars

protected

Definition at line 185 of file vtkVRCollaborationClient.h.

AvatarUpdateTime

std::map<std::string, double[vtkEventDataNumberOfDevices]> vtkVRCollaborationClient::AvatarUpdateTime

protected

Definition at line 186 of file vtkVRCollaborationClient.h.

Internal

vtkVRCollaborationClientInternal* vtkVRCollaborationClient::Internal

protected

Definition at line 189 of file vtkVRCollaborationClient.h.

---

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

• Rendering/VR/vtkVRCollaborationClient.h