proxy representing inputs to a filter More...

#include <vtkSMInputProperty.h>

Inheritance diagram for vtkSMInputProperty:

Collaboration diagram for vtkSMInputProperty:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetProxies (unsigned int numElements, vtkSMProxy *proxies[])
virtual void	Copy (vtkSMProperty *src)

virtual void	SetMultipleInput (int)
virtual int	GetMultipleInput ()

int	AddInputConnection (vtkSMProxy *proxy, unsigned int outputPort, int modify)
int	AddInputConnection (vtkSMProxy *proxy, unsigned int outputPort)
int	SetInputConnection (unsigned int idx, vtkSMProxy *proxy, unsigned int inputPort)
void	AddUncheckedInputConnection (vtkSMProxy *proxy, unsigned int outputPort)
void	SetUncheckedInputConnection (unsigned int idx, vtkSMProxy *proxy, unsigned int inputPort)

virtual void	RemoveProxy (vtkSMProxy *proxy)
virtual unsigned int	RemoveProxy (vtkSMProxy *proxy, int modify)
virtual unsigned int	RemoveUncheckedProxy (vtkSMProxy *proxy)
virtual void	RemoveAllUncheckedProxies ()
virtual void	ClearUncheckedProxies ()
virtual void	RemoveAllProxies ()

virtual void	SetNumberOfProxies (unsigned int num)
virtual void	SetNumberOfUncheckedProxies (unsigned int num)

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

unsigned int	GetOutputPortForConnection (unsigned int idx)
unsigned int	GetUncheckedOutputPortForConnection (unsigned int idx)

virtual void	SetPortIndex (int)
virtual int	GetPortIndex ()

virtual void	DeepCopy (vtkSMProperty src, const char exceptionClass, int proxyPropertyCopyFlag)
Static Public Member Functions
static vtkSMInputProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkSMInputProperty *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMInputProperty ()
	~vtkSMInputProperty ()
virtual void	WriteTo (vtkSMMessage *msg)
virtual void	RemoveAllProxies (int modify)
virtual int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element)
virtual int	LoadState (vtkPVXMLElement element, vtkSMProxyLocator loader)

virtual void	ReadFrom (const vtkSMMessage msg, int message_offset, vtkSMProxyLocator )

virtual vtkPVXMLElement *	AddProxyElementState (vtkPVXMLElement *propertyElement, unsigned int idx)
Protected Attributes
int	MultipleInput
int	PortIndex
vtkSMInputPropertyInternals *	IPInternals

Detailed Description

proxy representing inputs to a filter

vtkSMInputProperty is a concrete sub-class of vtkSMProperty representing inputs to a filter (through vtkSMProxy). It is a special property that always calls AddInput on a vtkSMSourceProxy. The xml configuration for input proxy supports the following attributes: multiple_input: For an input port that connects multiple connections such as the input of an append filter. port_index: The input port to be used.

See also:: vtkSMInputProperty vtkSMSourceProxy

Definition at line 40 of file vtkSMInputProperty.h.

Constructor & Destructor Documentation

vtkSMInputProperty::vtkSMInputProperty ( ) [protected]

vtkSMInputProperty::~vtkSMInputProperty ( ) [protected]

Member Function Documentation

static vtkSMInputProperty* vtkSMInputProperty::New ( ) [static]

Reimplemented from vtkSMProxyProperty.

virtual const char* vtkSMInputProperty::GetClassName ( ) [virtual]

Reimplemented from vtkSMProxyProperty.

static int vtkSMInputProperty::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMProxyProperty.

virtual int vtkSMInputProperty::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMProxyProperty.

static vtkSMInputProperty* vtkSMInputProperty::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMProxyProperty.

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

Reimplemented from vtkSMProxyProperty.

virtual void vtkSMInputProperty::SetMultipleInput ( int ) [virtual]

Should be set to true if the "input port" this property represents can accept multiple inputs (for example, an append filter)

virtual int vtkSMInputProperty::GetMultipleInput ( ) [virtual]

Should be set to true if the "input port" this property represents can accept multiple inputs (for example, an append filter)

int vtkSMInputProperty::AddInputConnection	(	vtkSMProxy *	proxy,
		unsigned int	outputPort,
		int	modify
	)

Add a proxy to the list of input proxies. The outputPort controls which outputPort will be used in connecting the pipeline. The proxy is added with corresponding Add and Set methods and can be removed with RemoveXXX() methods as usual.

int vtkSMInputProperty::AddInputConnection	(	vtkSMProxy *	proxy,
		unsigned int	outputPort
	)		`[inline]`

Add a proxy to the list of input proxies. The outputPort controls which outputPort will be used in connecting the pipeline. The proxy is added with corresponding Add and Set methods and can be removed with RemoveXXX() methods as usual.

Definition at line 62 of file vtkSMInputProperty.h.

int vtkSMInputProperty::SetInputConnection	(	unsigned int	idx,
		vtkSMProxy *	proxy,
		unsigned int	inputPort
	)

Add a proxy to the list of input proxies. The outputPort controls which outputPort will be used in connecting the pipeline. The proxy is added with corresponding Add and Set methods and can be removed with RemoveXXX() methods as usual.

void vtkSMInputProperty::AddUncheckedInputConnection	(	vtkSMProxy *	proxy,
		unsigned int	outputPort
	)

Add a proxy to the list of input proxies. The outputPort controls which outputPort will be used in connecting the pipeline. The proxy is added with corresponding Add and Set methods and can be removed with RemoveXXX() methods as usual.

void vtkSMInputProperty::SetUncheckedInputConnection	(	unsigned int	idx,
		vtkSMProxy *	proxy,
		unsigned int	inputPort
	)

Add a proxy to the list of input proxies. The outputPort controls which outputPort will be used in connecting the pipeline. The proxy is added with corresponding Add and Set methods and can be removed with RemoveXXX() methods as usual.

virtual void vtkSMInputProperty::RemoveProxy ( vtkSMProxy * proxy ) [inline, virtual]