Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkSMSelectionLink Class Reference

Creates a link between two properties. More...

#include <vtkSMSelectionLink.h>

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

Public Types

typedef vtkSMLink Superclass
 
- Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
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
 
unsigned int GetNumberOfLinkedObjects () override
 Get the number of properties that are involved in this link. More...
 
vtkSMProxyGetLinkedProxy (int index) override
 Get a proxy involved in this link. More...
 
int GetLinkedObjectDirection (int index) override
 Get the direction of a Selection involved in this link (see vtkSMLink::UpdateDirections) More...
 
void RemoveAllLinks () override
 Remove all links. More...
 
void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator) override
 This method is used to initialize the object to the given protobuf state. More...
 
virtual void SetConvertToIndices (bool)
 Set/Get the convert to indices flag. More...
 
virtual bool GetConvertToIndices ()
 
void AddLinkedSelection (vtkSMProxy *proxy, int updateDir)
 Add a selection to the link. More...
 
void RemoveLinkedSelection (vtkSMProxy *proxy)
 Add a selection to the link. More...
 
- Public Member Functions inherited from vtkSMRemoteObject
void SetSession (vtkSMSession *) override
 Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...
 
bool HasGlobalID ()
 Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...
 
virtual void EnableLocalPushOnly ()
 Allow to switch off any push of state change to the server for that particular object. More...
 
virtual void DisableLocalPushOnly ()
 Enable the given remote object to communicate its state normally to the server location. More...
 
virtual bool IsLocalPushOnly ()
 Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...
 
virtual void SetLocation (vtkTypeUInt32)
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkTypeUInt32 GetLocation ()
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkTypeUInt32 GetGlobalID ()
 Get the global unique id for this object. More...
 
const char * GetGlobalIDAsString ()
 Get the global unique id for this object. More...
 
virtual void PrototypeOn ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
virtual void PrototypeOff ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
bool IsPrototype ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
virtual void SetPrototype (bool)
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
- Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. 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 vtkSMSelectionLinkNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSelectionLinkSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
static std::string CreatePrettyLabel (const std::string &name)
 Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
 
- 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

 vtkSMSelectionLink ()
 
 ~vtkSMSelectionLink () override
 
int LoadXMLState (vtkPVXMLElement *linkElement, vtkSMProxyLocator *locator) override
 Load the link state. More...
 
void SaveXMLState (const char *linkname, vtkPVXMLElement *parent) override
 Save the state of the link. More...
 
void UpdateVTKObjects (vtkSMProxy *vtkNotUsed(caller)) override
 Not implemented. More...
 
void PropertyModified (vtkSMProxy *vtkNotUsed(caller), const char *vtkNotUsed(pname)) override
 Not implemented. More...
 
void UpdateProperty (vtkSMProxy *vtkNotUsed(caller), const char *vtkNotUsed(pname)) override
 Not implemented. More...
 
virtual void SelectionModified (vtkSMSourceProxy *caller, unsigned int portIndex)
 This method find the caller in the link and update selection output accordingly. More...
 
void UpdateState () override
 Update the internal protobuf state. More...
 
- Protected Member Functions inherited from vtkSMRemoteObject
 vtkSMRemoteObject ()
 Default constructor. More...
 
 ~vtkSMRemoteObject () override
 Destructor. More...
 
void PushState (vtkSMMessage *msg)
 Subclasses can call this method to send a message to its state object on the server processes specified. More...
 
bool PullState (vtkSMMessage *msg)
 Subclasses can call this method to pull the state from the state-object on the server processes specified. More...
 
void SetGlobalID (vtkTypeUInt32 guid)
 Set the GlobalUniqueId. More...
 
vtkTypeUInt32 GetFilteredLocation ()
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject () override
 
- 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 &)
 

Friends

class vtkSMSelectionLinkInternals
 
class vtkSMSelectionLinkObserver
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32 GlobalID
 
vtkTypeUInt32 Location
 
bool Prototype
 
bool ClientOnlyLocationFlag
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Creates a link between two properties.

Can create M->N links. At the time when the link is created every output Selection is synchronized with the first input Selection.

Definition at line 21 of file vtkSMSelectionLink.h.

Member Typedef Documentation

◆ Superclass

Definition at line 25 of file vtkSMSelectionLink.h.

Constructor & Destructor Documentation

◆ vtkSMSelectionLink()

vtkSMSelectionLink::vtkSMSelectionLink ( )
protected

◆ ~vtkSMSelectionLink()

vtkSMSelectionLink::~vtkSMSelectionLink ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMSelectionLink* vtkSMSelectionLink::New ( )
static

◆ GetClassName()

virtual const char* vtkSMSelectionLink::GetClassName ( )
virtual

Reimplemented from vtkSMLink.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMLink.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkSMLink.

◆ AddLinkedSelection()

void vtkSMSelectionLink::AddLinkedSelection ( vtkSMProxy proxy,
int  updateDir 
)

Add a selection to the link.

updateDir determines whether the proxy used is an input or an output. When a selection of an input proxy changes, it's selection is set to all other output proxies in the link. A selection can be set to be both input and output by adding 2 links, one to INPUT and the other to OUTPUT When a link is added, all output Selection values are synchronized with that of the input.

◆ RemoveLinkedSelection()

void vtkSMSelectionLink::RemoveLinkedSelection ( vtkSMProxy proxy)

Add a selection to the link.

updateDir determines whether the proxy used is an input or an output. When a selection of an input proxy changes, it's selection is set to all other output proxies in the link. A selection can be set to be both input and output by adding 2 links, one to INPUT and the other to OUTPUT When a link is added, all output Selection values are synchronized with that of the input.

◆ GetNumberOfLinkedObjects()

unsigned int vtkSMSelectionLink::GetNumberOfLinkedObjects ( )
overridevirtual

Get the number of properties that are involved in this link.

Implements vtkSMLink.

◆ GetLinkedProxy()

vtkSMProxy* vtkSMSelectionLink::GetLinkedProxy ( int  index)
overridevirtual

Get a proxy involved in this link.

Implements vtkSMLink.

◆ GetLinkedObjectDirection()

int vtkSMSelectionLink::GetLinkedObjectDirection ( int  index)
overridevirtual

Get the direction of a Selection involved in this link (see vtkSMLink::UpdateDirections)

Implements vtkSMLink.

◆ RemoveAllLinks()

void vtkSMSelectionLink::RemoveAllLinks ( )
overridevirtual

Remove all links.

Implements vtkSMLink.

◆ LoadState()

void vtkSMSelectionLink::LoadState ( const vtkSMMessage msg,
vtkSMProxyLocator locator 
)
overridevirtual

This method is used to initialize the object to the given protobuf state.

Reimplemented from vtkSMLink.

◆ SetConvertToIndices()

virtual void vtkSMSelectionLink::SetConvertToIndices ( bool  )
virtual

Set/Get the convert to indices flag.

When on, the input selection will always be converted into an indices based selection before being applied to outputs

◆ GetConvertToIndices()

virtual bool vtkSMSelectionLink::GetConvertToIndices ( )
virtual

◆ LoadXMLState()

int vtkSMSelectionLink::LoadXMLState ( vtkPVXMLElement linkElement,
vtkSMProxyLocator locator 
)
overrideprotectedvirtual

Load the link state.

Implements vtkSMLink.

◆ SaveXMLState()

void vtkSMSelectionLink::SaveXMLState ( const char *  linkname,
vtkPVXMLElement parent 
)
overrideprotectedvirtual

Save the state of the link.

Implements vtkSMLink.

◆ UpdateVTKObjects()

void vtkSMSelectionLink::UpdateVTKObjects ( vtkSMProxy vtkNotUsedcaller)
inlineoverrideprotected

Not implemented.

Definition at line 96 of file vtkSMSelectionLink.h.

◆ PropertyModified()

void vtkSMSelectionLink::PropertyModified ( vtkSMProxy vtkNotUsedcaller,
const char *  vtkNotUsedpname 
)
inlineoverrideprotected

Not implemented.

Definition at line 101 of file vtkSMSelectionLink.h.

◆ UpdateProperty()

void vtkSMSelectionLink::UpdateProperty ( vtkSMProxy vtkNotUsedcaller,
const char *  vtkNotUsedpname 
)
inlineoverrideprotected

Not implemented.

Definition at line 106 of file vtkSMSelectionLink.h.

◆ SelectionModified()

virtual void vtkSMSelectionLink::SelectionModified ( vtkSMSourceProxy caller,
unsigned int  portIndex 
)
protectedvirtual

This method find the caller in the link and update selection output accordingly.

◆ UpdateState()

void vtkSMSelectionLink::UpdateState ( )
overrideprotectedvirtual

Update the internal protobuf state.

Implements vtkSMLink.

Friends And Related Function Documentation

◆ vtkSMSelectionLinkInternals

friend class vtkSMSelectionLinkInternals
friend

Definition at line 80 of file vtkSMSelectionLink.h.

◆ vtkSMSelectionLinkObserver

friend class vtkSMSelectionLinkObserver
friend

Definition at line 81 of file vtkSMSelectionLink.h.


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