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

Creates a link between two properties. More...

#include <vtkSMPropertyLink.h>

Inheritance diagram for vtkSMPropertyLink:
Inheritance graph
[legend]
Collaboration diagram for vtkSMPropertyLink:
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)
 
vtkSMPropertyGetLinkedProperty (int index)
 Get a property involved in this link. More...
 
vtkSMProxyGetLinkedProxy (int index)
 Get a proxy involved in this link. More...
 
const char * GetLinkedPropertyName (int index)
 Get a property involved in this link. 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 state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalIDs set. More...
 
void AddLinkedProperty (vtkSMProxy *proxy, const char *propertyname, int updateDir)
 Add a property to the link. More...
 
void RemoveLinkedProperty (vtkSMProxy *proxy, const char *propertyname)
 Add a property to the link. More...
 
unsigned int GetNumberOfLinkedObjects ()
 Get the number of properties that are involved in this link. More...
 
unsigned int GetNumberOfLinkedProperties ()
 Get the number of properties that are involved in this link. More...
 
int GetLinkedObjectDirection (int index)
 Get the direction of a property involved in this link (see vtkSMLink::UpdateDirections) More...
 
int GetLinkedPropertyDirection (int index)
 Get the direction of a property involved in this link (see vtkSMLink::UpdateDirections) 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 vtkSMPropertyLinkNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPropertyLinkSafeDownCast (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

 vtkSMPropertyLink ()
 
 ~vtkSMPropertyLink ()
 
void Synchronize ()
 Synchronize the value of all output properties with the input property. More...
 
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 *caller)
 Called when an input proxy is updated (UpdateVTKObjects). More...
 
virtual void PropertyModified (vtkSMProxy *caller, const char *pname)
 Called when a property of an input proxy is modified. More...
 
virtual void PropertyModified (vtkSMProperty *property)
 
virtual void UpdateProperty (vtkSMProxy *caller, const char *pname)
 Called when a property is pushed. 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 vtkSMPropertyLinkInternals
 
class vtkSMPropertyLinkObserver
 

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 property is synchornized with the first input property.

Definition at line 33 of file vtkSMPropertyLink.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkSMPropertyLink.h.

Constructor & Destructor Documentation

◆ vtkSMPropertyLink()

vtkSMPropertyLink::vtkSMPropertyLink ( )
protected

◆ ~vtkSMPropertyLink()

vtkSMPropertyLink::~vtkSMPropertyLink ( )
protected

Member Function Documentation

◆ New()

static vtkSMPropertyLink* vtkSMPropertyLink::New ( )
static

◆ GetClassName()

virtual const char* vtkSMPropertyLink::GetClassName ( )
virtual

Reimplemented from vtkSMLink.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMLink.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMPropertyLink::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ AddLinkedProperty()

void vtkSMPropertyLink::AddLinkedProperty ( vtkSMProxy proxy,
const char *  propertyname,
int  updateDir 
)

Add a property to the link.

updateDir determines whether a property of the proxy is read or written. When a property of an input proxy changes, it's value is pushed to all other output proxies in the link. A property 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 property values are synchronized with that of the input.

◆ RemoveLinkedProperty()

void vtkSMPropertyLink::RemoveLinkedProperty ( vtkSMProxy proxy,
const char *  propertyname 
)

Add a property to the link.

updateDir determines whether a property of the proxy is read or written. When a property of an input proxy changes, it's value is pushed to all other output proxies in the link. A property 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 property values are synchronized with that of the input.

◆ GetNumberOfLinkedObjects()

unsigned int vtkSMPropertyLink::GetNumberOfLinkedObjects ( )
virtual

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

Implements vtkSMLink.

◆ GetNumberOfLinkedProperties()

unsigned int vtkSMPropertyLink::GetNumberOfLinkedProperties ( )

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

◆ GetLinkedProperty()

vtkSMProperty* vtkSMPropertyLink::GetLinkedProperty ( int  index)

Get a property involved in this link.

◆ GetLinkedProxy()

vtkSMProxy* vtkSMPropertyLink::GetLinkedProxy ( int  index)
virtual

Get a proxy involved in this link.

Implements vtkSMLink.

◆ GetLinkedPropertyName()

const char* vtkSMPropertyLink::GetLinkedPropertyName ( int  index)

Get a property involved in this link.

◆ GetLinkedObjectDirection()

int vtkSMPropertyLink::GetLinkedObjectDirection ( int  index)
virtual

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

Implements vtkSMLink.

◆ GetLinkedPropertyDirection()

int vtkSMPropertyLink::GetLinkedPropertyDirection ( int  index)

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

◆ RemoveAllLinks()

virtual void vtkSMPropertyLink::RemoveAllLinks ( )
virtual

Remove all links.

Implements vtkSMLink.

◆ LoadState()

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

This method is used to initialize the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalIDs set.

This enables splitting the load process in 2 step to prevent invalid state when a property refers to a sub-proxy that does not exist yet.

Reimplemented from vtkSMLink.

◆ Synchronize()

void vtkSMPropertyLink::Synchronize ( )
protected

Synchronize the value of all output properties with the input property.

◆ LoadXMLState()

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

Load the link state.

Implements vtkSMLink.

◆ SaveXMLState()

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

Save the state of the link.

Implements vtkSMLink.

◆ UpdateVTKObjects()

virtual void vtkSMPropertyLink::UpdateVTKObjects ( vtkSMProxy proxy)
protectedvirtual

Called when an input proxy is updated (UpdateVTKObjects).

Argument is the input proxy.

Implements vtkSMLink.

◆ PropertyModified() [1/2]

virtual void vtkSMPropertyLink::PropertyModified ( vtkSMProxy proxy,
const char *  pname 
)
protectedvirtual

Called when a property of an input proxy is modified.

caller:- the input proxy. pname:- name of the property being modified.

Implements vtkSMLink.

◆ PropertyModified() [2/2]

virtual void vtkSMPropertyLink::PropertyModified ( vtkSMProperty property)
protectedvirtual

◆ UpdateProperty()

virtual void vtkSMPropertyLink::UpdateProperty ( vtkSMProxy caller,
const char *  pname 
)
protectedvirtual

Called when a property is pushed.

caller :- the input proxy. pname :- name of property that was pushed.

Implements vtkSMLink.

◆ UpdateState()

virtual void vtkSMPropertyLink::UpdateState ( )
protectedvirtual

Update the internal protobuf state.

Implements vtkSMLink.

Friends And Related Function Documentation

◆ vtkSMPropertyLinkInternals

friend class vtkSMPropertyLinkInternals
friend

Definition at line 109 of file vtkSMPropertyLink.h.

◆ vtkSMPropertyLinkObserver

friend class vtkSMPropertyLinkObserver
friend

Definition at line 110 of file vtkSMPropertyLink.h.


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