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

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

#include <vtkSMParaViewPipelineControllerWithRendering.h>

Inheritance diagram for vtkSMParaViewPipelineControllerWithRendering:
Inheritance graph
[legend]
Collaboration diagram for vtkSMParaViewPipelineControllerWithRendering:
Collaboration graph
[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)
 
virtual vtkSMProxyShow (vtkSMSourceProxy *producer, int outputPort, vtkSMViewProxy *view)
 Show the output data in the view. More...
 
virtual vtkSMProxyHide (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...
 
vtkSMProxySetVisibility (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 vtkSMViewProxyShowInPreferredView (vtkSMSourceProxy *producer, int outputPort, vtkSMViewProxy *view)
 Same as Show() except that if the view is NULL 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 bool RegisterRepresentationProxy (vtkSMProxy *proxy)
 Overridden to create color and opacity transfer functions if applicable. More...
 
virtual bool PostInitializeProxy (vtkSMProxy *proxy)
 Overridden to handle default ColorArrayName for representations correctly. More...
 
virtual bool RegisterLayoutProxy (vtkSMProxy *proxy, const char *proxyname=NULL)
 Register layout proxy. More...
 
virtual bool WriteImage (vtkSMViewProxy *view, const char *filename, int magnification, int quality)
 Methods to save/capture images from views. More...
 
virtual bool WriteImage (vtkSMViewLayoutProxy *layout, const char *filename, int magnification, int quality)
 Methods to save/capture images from views. More...
 
virtual bool RegisterViewProxy (vtkSMProxy *proxy, const char *proxyname)
 Overridden to place the view in a layout on creation. More...
 
- Public Member Functions inherited from vtkSMParaViewPipelineController
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual bool InitializeSession (vtkSMSession *session)
 Call this method to setup a branch new session with state considered essential for ParaView session. More...
 
virtual vtkSMProxyFindTimeKeeper (vtkSMSession *session)
 Returns the TimeKeeper 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 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 vtkSMProxyFindAnimationScene (vtkSMSession *session)
 Returns the animation scene, if any. More...
 
virtual vtkSMProxyGetAnimationScene (vtkSMSession *session)
 Returns the animation scene for the session. More...
 
virtual vtkSMProxyFindTimeAnimationTrack (vtkSMProxy *scene)
 Return the animation track for time, if any. More...
 
virtual vtkSMProxyGetTimeAnimationTrack (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...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMParaViewPipelineControllerWithRenderingNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMParaViewPipelineControllerWithRenderingSafeDownCast (vtkObject *o)
 
static void SetHideScalarBarOnHide (bool)
 Control how scalar bar visibility is updated by the Hide call. More...
 
static void SetInheritRepresentationProperties (bool)
 Control whether representations try to maintain properties from an input representation, if present. More...
 
static bool GetInheritRepresentationProperties ()
 Control whether representations try to maintain properties from an input representation, if present. More...
 
- Static Public Member Functions inherited from vtkSMParaViewPipelineController
static vtkSMParaViewPipelineControllerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMParaViewPipelineControllerSafeDownCast (vtkObject *o)
 
static vtkStdString 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 vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMParaViewPipelineControllerWithRendering ()
 
 ~vtkSMParaViewPipelineControllerWithRendering ()
 
virtual void UpdatePipelineBeforeDisplay (vtkSMSourceProxy *producer, int outputPort, vtkSMViewProxy *view)
 
- Protected Member Functions inherited from vtkSMParaViewPipelineController
 vtkSMParaViewPipelineController ()
 
 ~vtkSMParaViewPipelineController ()
 
vtkSMProxyFindProxy (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...
 
unsigned long GetInitializationTime (vtkSMProxy *)
 Returns the initialization timestamp for the proxy, if available. 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 *, unsigned long initializationTimeStamp)
 Proxies can specify custom initialization using XML hints. More...
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

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 44 of file vtkSMParaViewPipelineControllerWithRendering.h.

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ vtkSMParaViewPipelineControllerWithRendering()

vtkSMParaViewPipelineControllerWithRendering::vtkSMParaViewPipelineControllerWithRendering ( )
protected

§ ~vtkSMParaViewPipelineControllerWithRendering()

vtkSMParaViewPipelineControllerWithRendering::~vtkSMParaViewPipelineControllerWithRendering ( )
protected

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 
)

§ Show()

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 NULL. If view is NULL, this simply calls ShowInPreferredView().

§ 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 77 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 NULL 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.

Returns the view in which the data ends up being shown, if any. It may return NULL if the view is not the "preferred" view and "preferred" view could not 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.

§ RegisterRepresentationProxy()

virtual bool vtkSMParaViewPipelineControllerWithRendering::RegisterRepresentationProxy ( vtkSMProxy proxy)
virtual

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.

§ SetHideScalarBarOnHide()

static void vtkSMParaViewPipelineControllerWithRendering::SetHideScalarBarOnHide ( bool  )
static

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

§ SetInheritRepresentationProperties()

static void vtkSMParaViewPipelineControllerWithRendering::SetInheritRepresentationProperties ( bool  )
static

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.

§ GetInheritRepresentationProperties()

static bool vtkSMParaViewPipelineControllerWithRendering::GetInheritRepresentationProperties ( )
static

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.

§ WriteImage() [1/2]

virtual bool vtkSMParaViewPipelineControllerWithRendering::WriteImage ( vtkSMViewProxy view,
const char *  filename,
int  magnification,
int  quality 
)
virtual

Methods to save/capture images from views.

§ WriteImage() [2/2]

virtual bool vtkSMParaViewPipelineControllerWithRendering::WriteImage ( vtkSMViewLayoutProxy layout,
const char *  filename,
int  magnification,
int  quality 
)
virtual

Methods to save/capture images from views.

§ PostInitializeProxy()

virtual bool vtkSMParaViewPipelineControllerWithRendering::PostInitializeProxy ( vtkSMProxy proxy)
virtual

Overridden to handle default ColorArrayName for representations correctly.

Reimplemented from vtkSMParaViewPipelineController.

§ RegisterViewProxy()

virtual bool vtkSMParaViewPipelineControllerWithRendering::RegisterViewProxy ( vtkSMProxy proxy,
const char *  proxyname 
)
virtual

Overridden to place the view in a layout on creation.

Reimplemented from vtkSMParaViewPipelineController.

§ RegisterLayoutProxy()

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

Register layout proxy.

§ UpdatePipelineBeforeDisplay()

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

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