VTK  9.3.20240412
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenXRManagerConnection Class Reference

OpenXR manager connection no-op implementation. More...

#include <vtkOpenXRManagerConnection.h>

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

Public Types

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...
 
vtkOpenXRManagerConnectionNewInstance () const
 
virtual bool Initialize ()
 Function called by vtkOpenXRManager before OpenXR initialization. More...
 
virtual bool EndInitialize ()
 Function called by vtkOpenXRManager after OpenXR initialization. More...
 
virtual bool ConnectToRemote (XrInstance vtkNotUsed(instance), XrSystemId vtkNotUsed(id))
 
virtual const char * GetExtensionName ()
 Return the OpenXR extension name that corresponds to this connection strategy. More...
 
virtual bool HandleXrEvent (const XrEventDataBuffer &vtkNotUsed(eventData))
 Handle Xr events specific to this connection strategy. More...
 
void SetIPAddress (std::string ip)
 Specify the address to connect to. More...
 
std::string const & GetIPAddress () const
 Specify the address to connect to. 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkOpenXRManagerConnectionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenXRManagerConnectionSafeDownCast (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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenXRManagerConnection ()=default
 
 ~vtkOpenXRManagerConnection () override=default
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::string IPAddress
 
- 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

OpenXR manager connection no-op implementation.

Base class defining the connection strategy used by vtkOpenXRManager. It does not perform any operation and will result in vtkOpenXRManager initializing a regular Xr session without any connection.

See also
vtkOpenXRManager

Definition at line 25 of file vtkOpenXRManagerConnection.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkOpenXRManagerConnection.h.

Constructor & Destructor Documentation

◆ vtkOpenXRManagerConnection()

vtkOpenXRManagerConnection::vtkOpenXRManagerConnection ( )
protecteddefault

◆ ~vtkOpenXRManagerConnection()

vtkOpenXRManagerConnection::~vtkOpenXRManagerConnection ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkOpenXRManagerConnection* vtkOpenXRManagerConnection::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOpenXRManagerConnection::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.

Reimplemented in vtkOpenXRManagerRemoteConnection.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenXRManagerConnection::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenXRManagerConnection* vtkOpenXRManagerConnection::NewInstance ( ) const

◆ Initialize()

virtual bool vtkOpenXRManagerConnection::Initialize ( )
inlinevirtual

Function called by vtkOpenXRManager before OpenXR initialization.

Reimplemented in vtkOpenXRManagerRemoteConnection.

Definition at line 34 of file vtkOpenXRManagerConnection.h.

◆ EndInitialize()

virtual bool vtkOpenXRManagerConnection::EndInitialize ( )
inlinevirtual

Function called by vtkOpenXRManager after OpenXR initialization.

Reimplemented in vtkOpenXRManagerRemoteConnection.

Definition at line 39 of file vtkOpenXRManagerConnection.h.

◆ ConnectToRemote()

virtual bool vtkOpenXRManagerConnection::ConnectToRemote ( XrInstance   vtkNotUsedinstance,
XrSystemId   vtkNotUsedid 
)
inlinevirtual

Definition at line 41 of file vtkOpenXRManagerConnection.h.

◆ GetExtensionName()

virtual const char* vtkOpenXRManagerConnection::GetExtensionName ( )
inlinevirtual

Return the OpenXR extension name that corresponds to this connection strategy.

Reimplemented in vtkOpenXRManagerRemoteConnection.

Definition at line 49 of file vtkOpenXRManagerConnection.h.

◆ HandleXrEvent()

virtual bool vtkOpenXRManagerConnection::HandleXrEvent ( const XrEventDataBuffer &  vtkNotUsedeventData)
inlinevirtual

Handle Xr events specific to this connection strategy.

Definition at line 54 of file vtkOpenXRManagerConnection.h.

◆ SetIPAddress()

void vtkOpenXRManagerConnection::SetIPAddress ( std::string  ip)
inline

Specify the address to connect to.

Definition at line 60 of file vtkOpenXRManagerConnection.h.

◆ GetIPAddress()

std::string const& vtkOpenXRManagerConnection::GetIPAddress ( ) const
inline

Specify the address to connect to.

Definition at line 61 of file vtkOpenXRManagerConnection.h.

Member Data Documentation

◆ IPAddress

std::string vtkOpenXRManagerConnection::IPAddress
protected

Definition at line 69 of file vtkOpenXRManagerConnection.h.


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