ParaView
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)
 
unsigned int GetNumberOfLinkedObjects ()
 Get the number of properties that are involved in this link. More...
 
vtkSMProxyGetLinkedProxy (int index)
 Get a proxy involved in this link. More...
 
int GetLinkedObjectDirection (int index)
 Get the direction of a Selection involved in this link (see vtkSMLink::UpdateDirections) More...
 
virtual void RemoveAllLinks ()
 Remove all links. More...
 
virtual void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator)
 This method is used to initialize the object to the given protobuf state. More...
 
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 PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetSession (vtkSMSession *)
 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 normaly 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
void PrintSelf (ostream &os, vtkIndent indent)
 
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 vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

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)
 

Protected Member Functions

 vtkSMSelectionLink ()
 
 ~vtkSMSelectionLink ()
 
virtual int LoadXMLState (vtkPVXMLElement *linkElement, vtkSMProxyLocator *locator)
 Load the link state. More...
 
virtual void SaveXMLState (const char *linkname, vtkPVXMLElement *parent)
 Save the state of the link. More...
 
virtual void UpdateVTKObjects (vtkSMProxy *vtkNotUsed(caller))
 Not implemented. More...
 
virtual void PropertyModified (vtkSMProxy *vtkNotUsed(caller), const char *vtkNotUsed(pname))
 Not implemented. More...
 
virtual void UpdateProperty (vtkSMProxy *vtkNotUsed(caller), const char *vtkNotUsed(pname))
 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...
 
virtual void UpdateState ()
 Update the internal protobuf state. More...
 
- Protected Member Functions inherited from vtkSMRemoteObject
 vtkSMRemoteObject ()
 Default constructor. More...
 
virtual ~vtkSMRemoteObject ()
 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 ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

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
 

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 33 of file vtkSMSelectionLink.h.

Member Typedef Documentation

§ Superclass

Definition at line 37 of file vtkSMSelectionLink.h.

Constructor & Destructor Documentation

§ vtkSMSelectionLink()

vtkSMSelectionLink::vtkSMSelectionLink ( )
protected

§ ~vtkSMSelectionLink()

vtkSMSelectionLink::~vtkSMSelectionLink ( )
protected

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 
)

§ 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 ( )
virtual

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

Implements vtkSMLink.

§ GetLinkedProxy()

vtkSMProxy* vtkSMSelectionLink::GetLinkedProxy ( int  index)
virtual

Get a proxy involved in this link.

Implements vtkSMLink.

§ GetLinkedObjectDirection()

int vtkSMSelectionLink::GetLinkedObjectDirection ( int  index)
virtual

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

Implements vtkSMLink.

§ RemoveAllLinks()

virtual void vtkSMSelectionLink::RemoveAllLinks ( )
virtual

Remove all links.

Implements vtkSMLink.

§ LoadState()

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

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

Reimplemented from vtkSMLink.

§ LoadXMLState()

virtual int vtkSMSelectionLink::LoadXMLState ( vtkPVXMLElement linkElement,
vtkSMProxyLocator locator 
)
protectedvirtual

Load the link state.

Implements vtkSMLink.

§ SaveXMLState()

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

Save the state of the link.

Implements vtkSMLink.

§ UpdateVTKObjects()

virtual void vtkSMSelectionLink::UpdateVTKObjects ( vtkSMProxy vtkNotUsedcaller)
inlineprotectedvirtual

Not implemented.

Definition at line 100 of file vtkSMSelectionLink.h.

§ PropertyModified()

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

Not implemented.

Definition at line 105 of file vtkSMSelectionLink.h.

§ UpdateProperty()

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

Not implemented.

Definition at line 110 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()

virtual void vtkSMSelectionLink::UpdateState ( )
protectedvirtual

Update the internal protobuf state.

Implements vtkSMLink.

Friends And Related Function Documentation

§ vtkSMSelectionLinkInternals

friend class vtkSMSelectionLinkInternals
friend

Definition at line 84 of file vtkSMSelectionLink.h.

§ vtkSMSelectionLinkObserver

friend class vtkSMSelectionLinkObserver
friend

Definition at line 85 of file vtkSMSelectionLink.h.


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