Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMProxyLocator Class Reference

is used to locate proxies referred to in state xmls while loading state files. More...

#include <vtkSMProxyLocator.h>

Inheritance diagram for vtkSMProxyLocator:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyLocator:
Collaboration graph
[legend]

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual vtkSMProxyLocateProxy (vtkTypeUInt32 globalID)
 Locate a proxy with the given "name". More...
 
virtual void Clear ()
 Clear the locator. More...
 
virtual void GetLocatedProxies (vtkCollection *collectionToFill)
 Copy all the Located proxy into the collection. More...
 
virtual void UseSessionToLocateProxy (bool useSessionToo)
 
virtual void AssignProxy (vtkTypeUInt32 id, vtkSMProxy *proxy)
 For custom applications managing custom state loading, one can use this method to register proxies with locator to use when LocateProxy() before attempting the standard route i.e. More...
 
void SetDeserializer (vtkSMDeserializer *)
 Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy(). More...
 
virtual vtkSMDeserializerGetDeserializer ()
 Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy(). More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session. More...
 
virtual void SetSession (vtkSMSession *s)
 Get/Set the session. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMProxyLocatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxyLocatorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMProxyLocator ()
 
 ~vtkSMProxyLocator () override
 
virtual vtkSMProxyNewProxy (vtkTypeUInt32 globalID)
 Create new proxy with the given id. More...
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSMDeserializerDeserializer
 
vtkWeakPointer< vtkSMSessionSession
 
bool LocateProxyWithSessionToo
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

is used to locate proxies referred to in state xmls while loading state files.

vtkSMProxyLocator is used to locate proxies referred to in state xmls (and otherwise) when loading state files.

Definition at line 36 of file vtkSMProxyLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkSMProxyLocator.h.

Constructor & Destructor Documentation

◆ vtkSMProxyLocator()

vtkSMProxyLocator::vtkSMProxyLocator ( )
protected

◆ ~vtkSMProxyLocator()

vtkSMProxyLocator::~vtkSMProxyLocator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxyLocator* vtkSMProxyLocator::New ( )
static

◆ GetClassName()

virtual const char* vtkSMProxyLocator::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

static int vtkSMProxyLocator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMProxyLocator::IsA ( const char *  type)
virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

static vtkSMProxyLocator* vtkSMProxyLocator::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkSMProxyLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMObject.

◆ LocateProxy()

virtual vtkSMProxy* vtkSMProxyLocator::LocateProxy ( vtkTypeUInt32  globalID)
virtual

Locate a proxy with the given "name".

If none can be found returns nullptr. If a proxy with the name was not previously located, it will ask the Deserializer (if any) to create a new proxy is possible.

◆ SetDeserializer()

void vtkSMProxyLocator::SetDeserializer ( vtkSMDeserializer )

Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy().

◆ GetDeserializer()

virtual vtkSMDeserializer* vtkSMProxyLocator::GetDeserializer ( )
virtual

Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy().

◆ GetSession()

virtual vtkSMSession* vtkSMProxyLocator::GetSession ( )
virtual

Get/Set the session.

◆ SetSession()

virtual void vtkSMProxyLocator::SetSession ( vtkSMSession s)
virtual

Get/Set the session.

◆ Clear()

virtual void vtkSMProxyLocator::Clear ( )
virtual

Clear the locator.

◆ GetLocatedProxies()

virtual void vtkSMProxyLocator::GetLocatedProxies ( vtkCollection collectionToFill)
virtual

Copy all the Located proxy into the collection.

This allow to keep a reference to them outside of the current locator. This is needed if we don't want to delete those proxy and if we want to Clear() the current ProxyLocator.

◆ UseSessionToLocateProxy()

virtual void vtkSMProxyLocator::UseSessionToLocateProxy ( bool  useSessionToo)
inlinevirtual

Definition at line 80 of file vtkSMProxyLocator.h.

◆ AssignProxy()

virtual void vtkSMProxyLocator::AssignProxy ( vtkTypeUInt32  id,
vtkSMProxy proxy 
)
virtual

For custom applications managing custom state loading, one can use this method to register proxies with locator to use when LocateProxy() before attempting the standard route i.e.

using the deserializer or session.

◆ NewProxy()

virtual vtkSMProxy* vtkSMProxyLocator::NewProxy ( vtkTypeUInt32  globalID)
protectedvirtual

Create new proxy with the given id.

Default implementation asks the Deserializer, if any, to create a new proxy.

Member Data Documentation

◆ Deserializer

vtkSMDeserializer* vtkSMProxyLocator::Deserializer
protected

Definition at line 103 of file vtkSMProxyLocator.h.

◆ Session

vtkWeakPointer<vtkSMSession> vtkSMProxyLocator::Session
protected

Definition at line 104 of file vtkSMProxyLocator.h.

◆ LocateProxyWithSessionToo

bool vtkSMProxyLocator::LocateProxyWithSessionToo
protected

Definition at line 105 of file vtkSMProxyLocator.h.


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