vtkSMParaViewPipelineControllerWithRendering overrides vtkSMParaViewPipelineController to add support for initializing rendering proxies appropriately. More...

#include <vtkSMParaViewPipelineControllerWithRendering.h>

Inheritance diagram for vtkSMParaViewPipelineControllerWithRendering:

[legend]

Collaboration diagram for vtkSMParaViewPipelineControllerWithRendering:

[legend]

Public Types
typedef vtkSMParaViewPipelineController	Superclass

Public Types inherited from vtkSMParaViewPipelineController
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

virtual vtkSMProxy *	Show (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view)
	Show the output data in the view. More...

virtual vtkSMProxy *	Show (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view, const char *representationType)
	Show the output data in the view. More...

void	ShowAll (vtkSMViewProxy *view)
	Show all source output ports in provided view. More...

virtual vtkSMProxy *	Hide (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view)
	Opposite of Show(). More...

virtual void	Hide (vtkSMProxy repr, vtkSMViewProxy view)
	Same as above, except that when we already have the representation located. More...

virtual void	HideAll (vtkSMViewProxy *view)
	Hide all visible sources output ports in provided view. More...

vtkSMProxy *	SetVisibility (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view, bool visible)
	Alternative method to call Show and Hide using a visibility flag. More...

virtual bool	GetVisibility (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view)
	Returns whether the producer/port are shown in the given view. More...

virtual vtkSMViewProxy *	ShowInPreferredView (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view)
	Same as Show() except that if the `view` is nullptr or not the preferred view for the producer's output, this method will create a new view and show the data in that new view. More...

virtual const char *	GetPreferredViewType (vtkSMSourceProxy *producer, int outputPort)
	Returns the name for the preferred view type, if there is any. More...

virtual const char *	GetPipelineIcon (vtkSMSourceProxy *producer, int outputPort)
	Return the pipeline icon to use with the provided producer. More...

bool	RegisterRepresentationProxy (vtkSMProxy *proxy) override
	Overridden to create color and opacity transfer functions if applicable. More...

	PARAVIEW_DEPRECATED_IN_5_14_0 ("Use vtkPVGeneralSettings::SetScalarBarMode(AUTOMATICALLY_HIDE_SCALAR_BARS) instead") static void SetHideScalarBarOnHide(bool)
	Control how scalar bar visibility is updated by the Hide call. More...

bool	PostInitializeProxy (vtkSMProxy *proxy) override
	Overridden to handle default ColorArrayName for representations correctly. More...

virtual bool	RegisterLayoutProxy (vtkSMProxy proxy, const char proxyname=nullptr)
	Register layout proxy. More...

virtual void	AssignViewToLayout (vtkSMViewProxy view, vtkSMViewLayoutProxy layout=nullptr, int hint=0)
	Assigns the view to any cell in the layout. More...


	PARAVIEW_DEPRECATED_IN_5_14_0 ("Use vtkPVGeneralSettings::SetInheritRepresentationProperties() instead") static void SetInheritRepresentationProperties(bool)
	Control whether representations try to maintain properties from an input representation, if present. More...

	PARAVIEW_DEPRECATED_IN_5_14_0 ("Use vtkPVGeneralSettings::GetInheritRepresentationProperties() instead") static bool GetInheritRepresentationProperties()
	Control whether representations try to maintain properties from an input representation, if present. More...

Public Member Functions inherited from vtkSMParaViewPipelineController
virtual bool	InitializeSession (vtkSMSession *session)
	Call this method to setup a branch new session with state considered essential for ParaView session. More...

virtual vtkSMProxy *	FindTimeKeeper (vtkSMSession *session)
	Returns the TimeKeeper proxy associated with the session. More...

virtual vtkSMProxy *	FindMaterialLibrary (vtkSMSession *session)
	Returns the MaterialLibrary proxy associated with the session. More...

virtual bool	PreInitializeProxy (vtkSMProxy *proxy)
	Pre-initializes a proxy i.e. More...

bool	InitializeProxy (vtkSMProxy *proxy)
	Convenience method to call PreInitializeProxy and PostInitializeProxy. More...

virtual bool	FinalizeProxy (vtkSMProxy *proxy)
	Cleans up any helper proxies registered for the proxy in PreInitializeProxy/PostInitializeProxy. More...

virtual bool	RegisterPipelineProxy (vtkSMProxy proxy, const char proxyname)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a pipeline proxy with the proxy manager. More...

virtual bool	RegisterPipelineProxy (vtkSMProxy *proxy)

virtual bool	UnRegisterPipelineProxy (vtkSMProxy *proxy)
	Unregisters a pipeline proxy. More...

virtual bool	RegisterViewProxy (vtkSMProxy *proxy)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a view proxy with the proxy manager. More...

virtual bool	RegisterViewProxy (vtkSMProxy proxy, const char proxyname)

virtual bool	UnRegisterViewProxy (vtkSMProxy *proxy, bool unregister_representations=true)
	Inverse of RegisterViewProxy. More...

virtual bool	UnRegisterRepresentationProxy (vtkSMProxy *proxy)
	Unregisters a representation proxy. More...

virtual bool	RegisterColorTransferFunctionProxy (vtkSMProxy proxy, const char proxyname)
	Registration method for color transfer function proxies to be used after PreInitializeProxy() and PostInitializeProxy() calls. More...

virtual bool	RegisterColorTransferFunctionProxy (vtkSMProxy *proxy)

virtual bool	RegisterOpacityTransferFunction (vtkSMProxy proxy, const char proxyname)
	Registration method for opacity transfer function proxies. More...

virtual bool	RegisterOpacityTransferFunction (vtkSMProxy *proxy)

virtual bool	RegisterTransferFunction2D (vtkSMProxy proxy, const char proxyname)
	Registration method for 2D transfer function proxies. More...

virtual bool	RegisterTransferFunction2D (vtkSMProxy *proxy)

virtual bool	RegisterLightProxy (vtkSMProxy proxy, vtkSMProxy view, const char *proxyname)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a light proxy with the proxy manager. More...

virtual bool	RegisterLightProxy (vtkSMProxy proxy, vtkSMProxy view)

virtual bool	RegisterTextureProxy (vtkSMProxy proxy, const char filename)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a texture proxy with the proxy manager. More...

virtual bool	RegisterTextureProxy (vtkSMProxy proxy, const char trivialProducerKeyName, const char *proxyname)

virtual bool	RegisterExtractorProxy (vtkSMProxy proxy, const char proxyname)
	Registers an extractor. More...

virtual bool	RegisterExtractorProxy (vtkSMProxy *proxy)

virtual vtkSMProxy *	FindAnimationScene (vtkSMSession *session)
	Returns the animation scene, if any. More...

virtual vtkSMProxy *	GetAnimationScene (vtkSMSession *session)
	Returns the animation scene for the session. More...

virtual vtkSMProxy *	FindTimeAnimationTrack (vtkSMProxy *scene)
	Return the animation track for time, if any. More...

virtual vtkSMProxy *	GetTimeAnimationTrack (vtkSMProxy *scene)
	Return the animation track for time. More...

virtual bool	RegisterAnimationProxy (vtkSMProxy *proxy)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register an animation proxy with the proxy manager. More...

virtual bool	UnRegisterAnimationProxy (vtkSMProxy *proxy)
	Inverse of RegisterAnimationProxy. More...

virtual void	UpdateSettingsProxies (vtkSMSession *session)
	Initializes and registers proxies in the "settings" group that haven't been already. More...

virtual bool	UnRegisterProxy (vtkSMProxy *proxy)
	A catch-all method do cleanup and unregister any proxies that were registered using Register..Proxy() APIs on this class. More...

virtual bool	RegisterRepresentationProxy (vtkSMProxy proxy, const char proxyname)
	Registration method for representations to be used after PreInitializeProxy() and PostInitializeProxy(). 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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMParaViewPipelineControllerWithRendering *	New ()

static int	IsTypeOf (const char *type)

static vtkSMParaViewPipelineControllerWithRendering *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMParaViewPipelineController
static vtkSMParaViewPipelineController *	New ()

static int	IsTypeOf (const char *type)

static vtkSMParaViewPipelineController *	SafeDownCast (vtkObject *o)

static std::string	GetHelperProxyGroupName (vtkSMProxy *)
	For a given proxy returns the name of the group used for helper proxies. More...

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (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 vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMParaViewPipelineControllerWithRendering ()

	~vtkSMParaViewPipelineControllerWithRendering () override

virtual void	UpdatePipelineBeforeDisplay (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy view)

virtual bool	AlsoShowInCurrentView (vtkSMSourceProxy producer, int outputPort, vtkSMViewProxy currentView)
	Checks if the output from producer needs to be shown in the current view also. More...

Protected Member Functions inherited from vtkSMParaViewPipelineController
	vtkSMParaViewPipelineController ()

	~vtkSMParaViewPipelineController () override

vtkSMProxy *	FindProxy (vtkSMSessionProxyManager pxm, const char reggroup, const char xmlgroup, const char xmltype)
	Find proxy of the group type (xmlgroup, xmltype) registered under a particular group (reggroup). More...

virtual bool	SetupGlobalPropertiesLinks (vtkSMProxy *proxy)
	Setup global properties links based on hints for properties in the XML. More...

virtual bool	CreateAnimationHelpers (vtkSMProxy *proxy)
	To help animation representation properties such as visibility, opacity, we create animation helpers. More...

virtual bool	UnRegisterDependencies (vtkSMProxy *proxy)
	Unregisters know proxy dependencies that must be removed when the proxy is to be deleted e.g animation cues, representations, etc. More...

vtkMTimeType	GetInitializationTime (vtkSMProxy *)
	Returns the initialization timestamp for the proxy, if available. More...

void	ProcessInitializationHelperRegistration (vtkSMProxy *)
	If the proxy has initialization helpers, let those classes also handle registration tasks, if any. More...

virtual bool	CreateProxiesForProxyListDomains (vtkSMProxy *proxy)
	Creates new proxies for proxies referred in vtkSMProxyListDomain for any of the properties for the given proxy. More...

virtual void	RegisterProxiesForProxyListDomains (vtkSMProxy *proxy)
	Creates new proxies for proxies referred in vtkSMProxyListDomain for any of the properties for the given proxy. More...

void	ProcessInitializationHelper (vtkSMProxy *, vtkMTimeType initializationTimeStamp)
	Proxies can specify custom initialization using XML hints. More...

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 &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkSMParaViewPipelineControllerWithRendering overrides vtkSMParaViewPipelineController to add support for initializing rendering proxies appropriately.

vtkSMParaViewPipelineControllerWithRendering uses vtkObjectFactory mechanisms to override vtkSMParaViewPipelineController's creation. One should not need to create or use this class directly (excepting when needing to subclass). Simply create vtkSMParaViewPipelineController. If the application is linked with the rendering module, then this class will be instantiated instead of vtkSMParaViewPipelineController automatically.

vtkSMParaViewPipelineControllerWithRendering also adds new API to control representation visibility and manage creation of views. To use that API clients can instantiate vtkSMParaViewPipelineControllerWithRendering. Just like vtkSMParaViewPipelineController, this class also uses vtkObjectFactory mechanisms to enable overriding by clients at compile time.

Definition at line 33 of file vtkSMParaViewPipelineControllerWithRendering.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMParaViewPipelineController vtkSMParaViewPipelineControllerWithRendering::Superclass

Definition at line 38 of file vtkSMParaViewPipelineControllerWithRendering.h.

Constructor & Destructor Documentation

◆ vtkSMParaViewPipelineControllerWithRendering()

vtkSMParaViewPipelineControllerWithRendering::vtkSMParaViewPipelineControllerWithRendering ( )

protected

◆ ~vtkSMParaViewPipelineControllerWithRendering()

vtkSMParaViewPipelineControllerWithRendering::~vtkSMParaViewPipelineControllerWithRendering ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMParaViewPipelineControllerWithRendering* vtkSMParaViewPipelineControllerWithRendering::New ( )

static

◆ GetClassName()

virtual const char* vtkSMParaViewPipelineControllerWithRendering::GetClassName ( )

virtual

Reimplemented from vtkSMParaViewPipelineController.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMParaViewPipelineController.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMParaViewPipelineController.

◆ Show() [1/2]

virtual vtkSMProxy* vtkSMParaViewPipelineControllerWithRendering::Show	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view
	)

virtual

Show the output data in the view.

If data cannot be shown in the view, returns nullptr. If view is nullptr, this simply calls ShowInPreferredView().

◆ Show() [2/2]

virtual vtkSMProxy* vtkSMParaViewPipelineControllerWithRendering::Show	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view,
		const char *	representationType
	)

virtual

Show the output data in the view.

If data cannot be shown in the view, returns nullptr. If view is nullptr, this simply calls ShowInPreferredView(). representationName specifies which representation should be instantiated - if nullptr, a default representation will be created based on hints in the XML.

◆ ShowAll()

void vtkSMParaViewPipelineControllerWithRendering::ShowAll ( vtkSMViewProxy * view )

Show all source output ports in provided view.

◆ Hide() [1/2]

virtual vtkSMProxy* vtkSMParaViewPipelineControllerWithRendering::Hide	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view
	)

virtual

Opposite of Show().

Locates the representation for the producer and then hides it, if found. Returns that representation, if found.

◆ Hide() [2/2]

virtual void vtkSMParaViewPipelineControllerWithRendering::Hide	(	vtkSMProxy *	repr,
		vtkSMViewProxy *	view
	)

virtual

Same as above, except that when we already have the representation located.

◆ HideAll()

virtual void vtkSMParaViewPipelineControllerWithRendering::HideAll ( vtkSMViewProxy * view )

virtual

Hide all visible sources output ports in provided view.

◆ SetVisibility()

vtkSMProxy* vtkSMParaViewPipelineControllerWithRendering::SetVisibility	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view,
		bool	visible
	)

inline

Alternative method to call Show and Hide using a visibility flag.

Definition at line 80 of file vtkSMParaViewPipelineControllerWithRendering.h.

◆ GetVisibility()

virtual bool vtkSMParaViewPipelineControllerWithRendering::GetVisibility	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view
	)

virtual

Returns whether the producer/port are shown in the given view.

◆ ShowInPreferredView()

virtual vtkSMViewProxy* vtkSMParaViewPipelineControllerWithRendering::ShowInPreferredView	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view
	)

virtual

Same as Show() except that if the view is nullptr or not the preferred view for the producer's output, this method will create a new view and show the data in that new view.

There are several different strategies employed to determine the preferred view for the producer's output. See vtkSMParaViewPipelineControllerWithRendering::GetPreferredViewType() for details.

Note: if the source's hint indicates so, the data may also be shown in the view passed in, in addition to the preferred view. This is done by using the also_show_in_current_view attribute to the <View /> hint.

Returns: the view in which the data ends up being shown, if any. It may return nullptr if the view is not the preferred type or the preferred cannot be determined or created.

◆ GetPreferredViewType()

virtual const char* vtkSMParaViewPipelineControllerWithRendering::GetPreferredViewType	(	vtkSMSourceProxy *	producer,
		int	outputPort
	)

virtual

Returns the name for the preferred view type, if there is any.

There are several strategies employed by the default implementation to determine the preferred view type.

Using XML hints.
A producer proxy can provide XML hints to define the preferred view type of each (or all) of its output ports. This is done as follows:

<SourceProxy>
  <Hints>
    <View type="<view name>" port="<output port number" />
  </Hints>
</SourceProxy>

Attribute port is optional and only needed to explicitly specify different view types for different output ports.

Using data type.
If the data type for the generated data is vtkTable, then the preferred view (if none provided) is assumed to be SpreadSheetView.

Returns: XML name for the preferred view proxy. It is assumed to be defined in the "views" group.

◆ GetPipelineIcon()

virtual const char* vtkSMParaViewPipelineControllerWithRendering::GetPipelineIcon	(	vtkSMSourceProxy *	producer,
		int	outputPort
	)

virtual

Return the pipeline icon to use with the provided producer.

It can be either a view type name, an existing icon resource or nullptr. Here is the strategy to determine the pipeline icon.

Using XML hints.

A producer proxy can provide XML hints to define the pipeline icon to use of each (or all) of its output ports. This is done as follows:

<SourceProxy>
  <Hints>
    <PipelineIcon name="<view name or icon resource>" port="<output port number>" />
  </Hints>
</SourceProxy>

Attribute port is optional and only needed to explicitly specify different view types for different output ports.

Using GetPreferredViewType

If no PipelineIcon as been provided, we fall back to using GetPreferredViewType.

◆ RegisterRepresentationProxy()

bool vtkSMParaViewPipelineControllerWithRendering::RegisterRepresentationProxy ( vtkSMProxy * proxy )

overridevirtual

Overridden to create color and opacity transfer functions if applicable.

While it is tempting to add any default property setup logic in such overrides, we must keep such overrides to a minimal and opting for domains that set appropriate defaults where as much as possible.

Reimplemented from vtkSMParaViewPipelineController.

◆ PARAVIEW_DEPRECATED_IN_5_14_0() [1/3]

vtkSMParaViewPipelineControllerWithRendering::PARAVIEW_DEPRECATED_IN_5_14_0 ( "Use vtkPVGeneralSettings::SetScalarBarMode(AUTOMATICALLY_HIDE_SCALAR_BARS) instead" )

Control how scalar bar visibility is updated by the Hide call.

◆ PARAVIEW_DEPRECATED_IN_5_14_0() [2/3]

vtkSMParaViewPipelineControllerWithRendering::PARAVIEW_DEPRECATED_IN_5_14_0 ( "Use vtkPVGeneralSettings::SetInheritRepresentationProperties() instead" )

Control whether representations try to maintain properties from an input representation, if present.

e.g. if you "Transform" the representation for a source, then any filter that you connect to it should be transformed as well.

◆ PARAVIEW_DEPRECATED_IN_5_14_0() [3/3]

vtkSMParaViewPipelineControllerWithRendering::PARAVIEW_DEPRECATED_IN_5_14_0 ( "Use vtkPVGeneralSettings::GetInheritRepresentationProperties() instead" )

Control whether representations try to maintain properties from an input representation, if present.

e.g. if you "Transform" the representation for a source, then any filter that you connect to it should be transformed as well.

◆ PostInitializeProxy()

bool vtkSMParaViewPipelineControllerWithRendering::PostInitializeProxy ( vtkSMProxy * proxy )

overridevirtual

Overridden to handle default ColorArrayName for representations correctly.

Reimplemented from vtkSMParaViewPipelineController.

◆ RegisterLayoutProxy()

virtual bool vtkSMParaViewPipelineControllerWithRendering::RegisterLayoutProxy	(	vtkSMProxy *	proxy,
		const char *	proxyname = `nullptr`
	)

virtual

Register layout proxy.

If proxyname is nullptr, a new name will be assigned.

◆ AssignViewToLayout()

virtual void vtkSMParaViewPipelineControllerWithRendering::AssignViewToLayout	(	vtkSMViewProxy *	view,
		vtkSMViewLayoutProxy *	layout = `nullptr`,
		int	hint = `0`
	)

virtual

Assigns the view to any cell in the layout.

If the layout is nullptr, then this will locate a layout on the same session and use it. If no layout is present on the session, a new layout will be created (and registered) before assigning the view to it.

If the view is already assigned to a layout then this method is a no-op.

See also: vtkSMViewProxy::AssignViewToAnyCell

◆ UpdatePipelineBeforeDisplay()

virtual void vtkSMParaViewPipelineControllerWithRendering::UpdatePipelineBeforeDisplay	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	view
	)

protectedvirtual

◆ AlsoShowInCurrentView()

virtual bool vtkSMParaViewPipelineControllerWithRendering::AlsoShowInCurrentView	(	vtkSMSourceProxy *	producer,
		int	outputPort,
		vtkSMViewProxy *	currentView
	)

protectedvirtual

Checks if the output from producer needs to be shown in the current view also.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkSMParaViewPipelineControllerWithRendering.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMParaViewPipelineControllerWithRendering()

◆ ~vtkSMParaViewPipelineControllerWithRendering()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Show() [1/2]

◆ Show() [2/2]

◆ ShowAll()

◆ Hide() [1/2]

◆ Hide() [2/2]

◆ HideAll()

◆ SetVisibility()

◆ GetVisibility()

◆ ShowInPreferredView()

◆ GetPreferredViewType()

◆ GetPipelineIcon()

Using XML hints.

Using GetPreferredViewType

◆ RegisterRepresentationProxy()

◆ PARAVIEW_DEPRECATED_IN_5_14_0() [1/3]

◆ PARAVIEW_DEPRECATED_IN_5_14_0() [2/3]

◆ PARAVIEW_DEPRECATED_IN_5_14_0() [3/3]

◆ PostInitializeProxy()

◆ RegisterLayoutProxy()

◆ AssignViewToLayout()

◆ UpdatePipelineBeforeDisplay()

◆ AlsoShowInCurrentView()