VTK  9.3.20240614
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkVRCollaborationClient Class Reference

#include <vtkVRCollaborationClient.h>

Inheritance diagram for vtkVRCollaborationClient:
[legend]
Collaboration diagram for vtkVRCollaborationClient:
[legend]

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.
 
vtkVRCollaborationClientNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
 vtkVRCollaborationClient (const vtkVRCollaborationClient &)=delete
 
vtkVRCollaborationClientoperator= (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)
 
vtkOpenGLRendererGetRenderer ()
 
bool GetConnected ()
 
void SendAMessage (std::string const &msgType)
 method signatures to send messages with Arguments and extract them out of messages
 
void SendAMessage (std::string const &msgType, std::vector< Argument > const &args)
 method signatures to send messages with Arguments and extract them out of messages
 
std::vector< ArgumentGetMessageArguments ()
 method signatures to send messages with Arguments and extract them out of messages
 
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
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkVRCollaborationClientNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVRCollaborationClientSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVRCollaborationClient ()
 
 ~vtkVRCollaborationClient () override
 
void Log (vtkLogger::Verbosity verbosity, std::string const &msg)
 
void HandleCollabMessage ()
 
bool AvatarIdle (std::string id)
 
void EraseIdleAvatars ()
 
vtkSmartPointer< vtkOpenGLAvatarGetAvatar (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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- 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 *)
 
virtual void ObjectFinalize ()
 
 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
 
vtkCallbackCommandEventCommand
 
long MoveObserver
 
vtkOpenGLRendererRenderer
 
vtkOpenGLRenderWindowRenderWindow
 
vtkNew< vtkTransformTempTransform
 
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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 32 of file vtkVRCollaborationClient.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkVRCollaborationClient.h.

Member Enumeration Documentation

◆ ArgumentType

Enumerator
Double 
Int32 
String 

Definition at line 45 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 98 of file vtkVRCollaborationClient.h.

◆ SetCollabSession()

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

Definition at line 99 of file vtkVRCollaborationClient.h.

◆ SetCollabName()

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

Definition at line 100 of file vtkVRCollaborationClient.h.

◆ SetCollabPort()

void vtkVRCollaborationClient::SetCollabPort ( int  val)
inline

Definition at line 101 of file vtkVRCollaborationClient.h.

◆ SetLogCallback()

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

Definition at line 104 of file vtkVRCollaborationClient.h.

◆ SetScaleCallback()

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

Definition at line 111 of file vtkVRCollaborationClient.h.

◆ GetRenderer()

vtkOpenGLRenderer * vtkVRCollaborationClient::GetRenderer ( )
inline

Definition at line 114 of file vtkVRCollaborationClient.h.

◆ GetConnected()

bool vtkVRCollaborationClient::GetConnected ( )
inline

Definition at line 117 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 126 of file vtkVRCollaborationClient.h.

◆ CollabHost

std::string vtkVRCollaborationClient::CollabHost
protected

Definition at line 127 of file vtkVRCollaborationClient.h.

◆ CollabSession

std::string vtkVRCollaborationClient::CollabSession
protected

Definition at line 128 of file vtkVRCollaborationClient.h.

◆ CollabName

std::string vtkVRCollaborationClient::CollabName
protected

Definition at line 129 of file vtkVRCollaborationClient.h.

◆ CollabPort

int vtkVRCollaborationClient::CollabPort
protected

Definition at line 130 of file vtkVRCollaborationClient.h.

◆ Callback

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

Definition at line 132 of file vtkVRCollaborationClient.h.

◆ ScaleCallback

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

Definition at line 133 of file vtkVRCollaborationClient.h.

◆ DisplayOwnAvatar

bool vtkVRCollaborationClient::DisplayOwnAvatar
protected

Definition at line 135 of file vtkVRCollaborationClient.h.

◆ PublishAvailable

bool vtkVRCollaborationClient::PublishAvailable
protected

Definition at line 136 of file vtkVRCollaborationClient.h.

◆ NeedHeartbeat

double vtkVRCollaborationClient::NeedHeartbeat
protected

Definition at line 140 of file vtkVRCollaborationClient.h.

◆ NeedReply

double vtkVRCollaborationClient::NeedReply
protected

Definition at line 141 of file vtkVRCollaborationClient.h.

◆ RetryCount

int vtkVRCollaborationClient::RetryCount
protected

Definition at line 142 of file vtkVRCollaborationClient.h.

◆ Connected

bool vtkVRCollaborationClient::Connected
protected

Definition at line 144 of file vtkVRCollaborationClient.h.

◆ EventCommand

vtkCallbackCommand* vtkVRCollaborationClient::EventCommand
protected

Definition at line 154 of file vtkVRCollaborationClient.h.

◆ MoveObserver

long vtkVRCollaborationClient::MoveObserver
protected

Definition at line 157 of file vtkVRCollaborationClient.h.

◆ Renderer

vtkOpenGLRenderer* vtkVRCollaborationClient::Renderer
protected

Definition at line 159 of file vtkVRCollaborationClient.h.

◆ RenderWindow

vtkOpenGLRenderWindow* vtkVRCollaborationClient::RenderWindow
protected

Definition at line 160 of file vtkVRCollaborationClient.h.

◆ TempTransform

vtkNew<vtkTransform> vtkVRCollaborationClient::TempTransform
protected

Definition at line 162 of file vtkVRCollaborationClient.h.

◆ YourLastAvatarUpdateTime

double vtkVRCollaborationClient::YourLastAvatarUpdateTime
protected

Definition at line 165 of file vtkVRCollaborationClient.h.

◆ HasPoseForDevice

bool vtkVRCollaborationClient::HasPoseForDevice[vtkEventDataNumberOfDevices]
protected

Definition at line 166 of file vtkVRCollaborationClient.h.

◆ DevicePoses

Pose vtkVRCollaborationClient::DevicePoses[vtkEventDataNumberOfDevices]
protected

Definition at line 172 of file vtkVRCollaborationClient.h.

◆ Avatars

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

Definition at line 175 of file vtkVRCollaborationClient.h.

◆ AvatarUpdateTime

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

Definition at line 176 of file vtkVRCollaborationClient.h.

◆ Internal

vtkVRCollaborationClientInternal* vtkVRCollaborationClient::Internal
protected

Definition at line 179 of file vtkVRCollaborationClient.h.


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