vtkSMProxyProperty Class Reference

property representing pointer(s) to vtkObject(s) More...

#include <vtkSMProxyProperty.h>

Inheritance diagram for vtkSMProxyProperty:

Collaboration diagram for vtkSMProxyProperty:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
bool	IsProxyAdded (vtkSMProxy *proxy)
virtual int	AddProxy (vtkSMProxy *proxy, int modify)
virtual unsigned int	RemoveProxy (vtkSMProxy *proxy, int modify)
virtual void	RemoveAllUncheckedProxies ()
virtual void	ClearUncheckedProxies ()
virtual void	SetNumberOfProxies (unsigned int num)
unsigned int	GetNumberOfProxies ()
virtual void	SetNumberOfUncheckedProxies (unsigned int num)
unsigned int	GetNumberOfUncheckedProxies ()
vtkSMProxy *	GetProxy (unsigned int idx)
vtkSMProxy *	GetUncheckedProxy (unsigned int idx)
virtual void	Copy (vtkSMProperty *src)
virtual int	AddProxy (vtkSMProxy *proxy)
virtual void	RemoveProxy (vtkSMProxy *proxy)
virtual int	SetProxy (unsigned int idx, vtkSMProxy *proxy)
virtual void	SetProxies (unsigned int numElements, vtkSMProxy *proxies[])
virtual void	AddUncheckedProxy (vtkSMProxy *proxy)
virtual unsigned int	RemoveUncheckedProxy (vtkSMProxy *proxy)
virtual void	SetUncheckedProxy (unsigned int idx, vtkSMProxy *proxy)
virtual void	RemoveAllProxies ()
virtual void	DeepCopy (vtkSMProperty *src, const char *exceptionClass, int proxyPropertyCopyFlag)
virtual bool	GetSkipDependency ()
Static Public Member Functions
static vtkSMProxyProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSMProxyProperty *	SafeDownCast (vtkObject *o)
static void	EnableProxyCreation ()
static void	DisableProxyCreation ()
static bool	CanCreateProxy ()
Protected Member Functions
	vtkSMProxyProperty ()
	~vtkSMProxyProperty ()
virtual void	WriteTo (vtkSMMessage *msg)
virtual void	ReadFrom (const vtkSMMessage *msg, int msg_offset, vtkSMProxyLocator *)
virtual void	RemoveAllProxies (int modify)
virtual void	SaveStateValues (vtkPVXMLElement *propertyElement)
virtual int	LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader)
virtual int	ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)
virtual vtkPVXMLElement *	AddProxyElementState (vtkPVXMLElement *prop, unsigned int idx)
Protected Attributes
vtkSMProxyPropertyInternals *	PPInternals
bool	SkipDependency
Static Protected Attributes
static bool	CreateProxyAllowed
Friends
class	vtkSMProxy
struct	vtkSMProxyPropertyInternals
class	vtkSMProxyProperty::vtkProxyPointer

---

Detailed Description

property representing pointer(s) to vtkObject(s)

vtkSMProxyProperty is a concrete sub-class of vtkSMProperty representing pointer(s) to vtkObject(s) (through vtkSMProxy).

Besides the standard set of attributes, the following XML attributes are supported:

• command : identifies the method to call on the VTK object e.g. AddRepresentation.
• clean_command : if present, called once before invoking the method specified by command every time the property value is pushed e.g. RemoveAllRepresentations. If property can take multiple values then the command is called for for each of the values after the clean command for every push.
• remove_command : an alternative to clean_command where instead of resetting and adding all the values for every push, this simply calls the specified method to remove the vtk-objects no longer referred to e.g. RemoveRepresentation.
• argument_type : identifies the type for value passed to the method on the VTK object. Accepted values are "VTK", "SMProxy" or "SIProxy". Default is VTK.
• null_on_empty : if set to 1, whenever the property's value changes to empty i.e. it contains no proxies, the command is called on the VTK object with NULL argument useful when there's no clean_command that can be called on the VTK object to unset the property e.g. SetLookupTable(NULL). li skip_dependency : if set to 1, this property does not result in adding a dependency between the proxies set as values of this property and the proxy to which the property belongs (which is the default behaviour). Use this with care as it would mean that ParaView would no realize any updates are needed to the pipeline if any proxy set on the property changes. This is necessary in some cases, e.g. if LUT proxy on a representation changes, we don't want to representation to treat it same as if the input pipeline changed!

  See also:

  vtkSMProperty

Definition at line 63 of file vtkSMProxyProperty.h.

---

Constructor & Destructor Documentation

vtkSMProxyProperty::vtkSMProxyProperty

(

)

[protected]

vtkSMProxyProperty::~vtkSMProxyProperty

(

)

[protected]

---

Member Function Documentation

static void vtkSMProxyProperty::EnableProxyCreation

(

)

[static]

When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy. Although when the goal is to load a state on any standard proxy, we do not want that proxy property be able to create new proxy based on some previous state.

static void vtkSMProxyProperty::DisableProxyCreation

(

)

[static]

When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy. Although when the goal is to load a state on any standard proxy, we do not want that proxy property be able to create new proxy based on some previous state.

static bool vtkSMProxyProperty::CanCreateProxy

(

)

[static]

When we load ProxyManager state we want Proxy/InputProperty to be able to create the corresponding missing proxy. Although when the goal is to load a state on any standard proxy, we do not want that proxy property be able to create new proxy based on some previous state.

static vtkSMProxyProperty* vtkSMProxyProperty::New

(

)

[static]

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

virtual const char* vtkSMProxyProperty::GetClassName

(

)

[virtual]

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

static int vtkSMProxyProperty::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

virtual int vtkSMProxyProperty::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

static vtkSMProxyProperty* vtkSMProxyProperty::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

void vtkSMProxyProperty::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

virtual int vtkSMProxyProperty::AddProxy

(

vtkSMProxy *

proxy

)

[virtual]

Add a proxy to the list of proxies.

virtual void vtkSMProxyProperty::RemoveProxy

(

vtkSMProxy *

proxy

)

[virtual]

Add a proxy to the list of proxies.

Reimplemented in vtkSMInputProperty.

virtual int vtkSMProxyProperty::SetProxy	(	unsigned int	idx,
		vtkSMProxy *	proxy
	)		[virtual]

Add a proxy to the list of proxies.

virtual void vtkSMProxyProperty::SetProxies	(	unsigned int	numElements,
		vtkSMProxy *	proxies[]
	)		[virtual]

Sets the value of the property to the list of proxies specified.

Reimplemented in vtkSMInputProperty.

bool vtkSMProxyProperty::IsProxyAdded

(

vtkSMProxy *

proxy

)

Returns if the given proxy is already added to the property.

virtual int vtkSMProxyProperty::AddProxy	(	vtkSMProxy *	proxy,
		int	modify
	)		[virtual]

Add a proxy to the list of proxies without calling Modified (if modify is false). This is commonly used when ImmediateUpdate is true but it is more efficient to avoid calling Update until the last proxy is added. To do this, add all proxies with modify=false and call Modified after the last. This will perform domain checking. If the domain check fails, the proxy will not be added and 0 will be returned. Returns 1 on success. If the domain check fails or the property is read only, returns 0. All proxies added with AddProxy() will become "consumers" of the proxy passed to AppendCommandToStream().

virtual unsigned int vtkSMProxyProperty::RemoveProxy	(	vtkSMProxy *	proxy,
		int	modify
	)		[virtual]

Removes a proxy from the vector of added Proxies (added by AddProxy). Returns the index of proxy removed. If the proxy was not found, returns NumberOfProxies.

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::AddUncheckedProxy

(

vtkSMProxy *

proxy

)

[virtual]

Add an unchecked proxy. Does not modify the property. Unchecked proxies are used by domains when verifying whether a value is acceptable. To check if a value is in the domains, you can do the following:

- RemoveAllUncheckedProxies() -
      AddUncheckedProxy(proxy) - IsInDomains() 

virtual unsigned int vtkSMProxyProperty::RemoveUncheckedProxy

(

vtkSMProxy *

proxy

)

[virtual]

Add an unchecked proxy. Does not modify the property. Unchecked proxies are used by domains when verifying whether a value is acceptable. To check if a value is in the domains, you can do the following:

- RemoveAllUncheckedProxies() -
      AddUncheckedProxy(proxy) - IsInDomains() 

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::SetUncheckedProxy	(	unsigned int	idx,
		vtkSMProxy *	proxy
	)		[virtual]

Add an unchecked proxy. Does not modify the property. Unchecked proxies are used by domains when verifying whether a value is acceptable. To check if a value is in the domains, you can do the following:

- RemoveAllUncheckedProxies() -
      AddUncheckedProxy(proxy) - IsInDomains() 

virtual void vtkSMProxyProperty::RemoveAllUncheckedProxies

(

)

[virtual]

Removes all unchecked proxies.

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::ClearUncheckedProxies

(

)

[virtual]

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::RemoveAllProxies

(

)

[inline, virtual]

Remove all proxies from the list.

Reimplemented in vtkSMInputProperty.

Definition at line 132 of file vtkSMProxyProperty.h.

virtual void vtkSMProxyProperty::SetNumberOfProxies

(

unsigned int

num

)

[virtual]

Sets the number of proxies. If the new number is greater than the current number of proxies, then NULL will be inserted.

Reimplemented in vtkSMInputProperty.

unsigned int vtkSMProxyProperty::GetNumberOfProxies

(

)

Returns the number of proxies.

virtual void vtkSMProxyProperty::SetNumberOfUncheckedProxies

(

unsigned int

num

)

[virtual]

Sets the number of unchecked proxies. If the new number is greater than the current number of proxies, then NULL will be inserted.

Reimplemented in vtkSMInputProperty.

unsigned int vtkSMProxyProperty::GetNumberOfUncheckedProxies

(

)

Returns the number of unchecked proxies.

vtkSMProxy* vtkSMProxyProperty::GetProxy

(

unsigned int

idx

)

Return a proxy. No bounds check is performed.

vtkSMProxy* vtkSMProxyProperty::GetUncheckedProxy

(

unsigned int

idx

)

Return a proxy. No bounds check is performed.

virtual void vtkSMProxyProperty::Copy

(

vtkSMProperty *

src

)

[virtual]

Copy all property values.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::DeepCopy	(	vtkSMProperty *	src,
		const char *	exceptionClass,
		int	proxyPropertyCopyFlag
	)		[virtual]

Copy all proxies added to the src over to this by creating new instances for the proxies and inturn calling Copy to copy the proxies. exceptionClass and proxyPropertyCopyFlag are used while copying over the values from the two proxy properties.

Reimplemented in vtkSMInputProperty.

virtual bool vtkSMProxyProperty::GetSkipDependency

(

)

[virtual]

Returns whether the "skip_dependency" attribute is set.

virtual void vtkSMProxyProperty::WriteTo

(

vtkSMMessage *

msg

)

[protected, virtual]

Let the property write its content into the stream

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::ReadFrom	(	const vtkSMMessage *	msg,
		int	msg_offset,
		vtkSMProxyLocator *
	)		[protected, virtual]

Let the property read and set its content from the stream

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::RemoveAllProxies

(

int

modify

)

[protected, virtual]

Reimplemented in vtkSMInputProperty.

virtual int vtkSMProxyProperty::ReadXMLAttributes	(	vtkSMProxy *	parent,
		vtkPVXMLElement *	element
	)		[protected, virtual]

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

virtual void vtkSMProxyProperty::SaveStateValues

(

vtkPVXMLElement *

propertyElement

)

[protected, virtual]

Generic method used to generate XML state

Reimplemented from vtkSMProperty.

virtual vtkPVXMLElement* vtkSMProxyProperty::AddProxyElementState	(	vtkPVXMLElement *	prop,
		unsigned int	idx
	)		[protected, virtual]

Fill state property/proxy XML element with proxy info. Return the created proxy XML element that has been added as a child in the property definition. If prop == NULL, you must Delete yourself the result otherwise prop is olding a reference to the proxy element

Reimplemented in vtkSMInputProperty.

virtual int vtkSMProxyProperty::LoadState	(	vtkPVXMLElement *	element,
		vtkSMProxyLocator *	loader
	)		[protected, virtual]

Updates state from an XML element. Returns 0 on failure.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMInputProperty.

---

Friends And Related Function Documentation

friend class vtkSMProxy [friend]

Reimplemented from vtkSMProperty.

Definition at line 188 of file vtkSMProxyProperty.h.

friend struct vtkSMProxyPropertyInternals [friend]

Definition at line 189 of file vtkSMProxyProperty.h.

friend class vtkSMProxyProperty::vtkProxyPointer [friend]

Definition at line 225 of file vtkSMProxyProperty.h.

---

Member Data Documentation

vtkSMProxyPropertyInternals* vtkSMProxyProperty::PPInternals [protected]

Definition at line 191 of file vtkSMProxyProperty.h.

bool vtkSMProxyProperty::CreateProxyAllowed [static, protected]

Definition at line 217 of file vtkSMProxyProperty.h.

bool vtkSMProxyProperty::SkipDependency [protected]

Definition at line 219 of file vtkSMProxyProperty.h.

---

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

• dox/ParaViewCore/ServerManager/vtkSMProxyProperty.h