Superclass for all view proxies. More...

#include <vtkSMViewProxy.h>

Inheritance diagram for vtkSMViewProxy:

[legend]

Collaboration diagram for vtkSMViewProxy:

[legend]

Public Types
enum	{ PrepareContextForRendering = vtkCommand::UserEvent + 1 }

typedef vtkSMProxy	Superclass

Public Types inherited from vtkSMProxy
enum	ResetPropertiesMode { DEFAULT = 0, ONLY_XML = 1, ONLY_DOMAIN = 2 }

enum	{ COPY_PROXY_PROPERTY_VALUES_BY_REFERENCE = 0, COPY_PROXY_PROPERTY_VALUES_BY_CLONING }
	Flags used for the proxyPropertyCopyFlag argument to the Copy method. More...

typedef vtkSMRemoteObject	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) override

virtual void	StillRender ()
	Renders the view using full resolution. More...

virtual void	InteractiveRender ()
	Renders the view using lower resolution is possible. More...

virtual void	Update ()
	Called vtkPVView::Update on the server-side. More...

virtual bool	CanDisplayData (vtkSMSourceProxy *producer, int outputPort)
	Returns true if the view can display the data produced by the producer's port. More...

virtual vtkSMRepresentationProxy *	CreateDefaultRepresentation (vtkSMProxy *, int)
	Create a default representation for the given source proxy. More...

virtual const char *	GetRepresentationType (vtkSMSourceProxy *producer, int outputPort)
	Returns the xml name of the representation proxy to create to show the data produced in this view, if any. More...

virtual vtkSMRepresentationProxy *	FindRepresentation (vtkSMSourceProxy *producer, int outputPort)
	Finds the representation proxy showing the data produced by the provided producer, if any. More...

vtkView *	GetClientSideView ()
	Returns the client-side vtkView, if any. More...

int	WriteImage (const char filename, const char writerName, int magnification=1)
	Saves a screenshot of the view to disk. More...

int	WriteImage (const char filename, const char writerName, int magnificationX, int magnificationY)

virtual bool	HasDirtyRepresentation ()
	Return true any internal representation is dirty. More...

virtual vtkRenderWindow *	GetRenderWindow ()
	Return the vtkRenderWindow used by this view, if any. More...

virtual vtkRenderWindowInteractor *	GetInteractor ()
	Returns the interactor. More...

virtual void	SetupInteractor (vtkRenderWindowInteractor *iren)
	A client process need to set the interactor to enable interactivity. More...

virtual bool	MakeRenderWindowInteractor (bool quiet=false)
	Creates a default render window interactor for the vtkRenderWindow and sets it up on the local process if the local process supports interaction. More...


virtual void	SetEnable (bool)
	Enable/Disable a view. More...

virtual bool	GetEnable ()
	Enable/Disable a view. More...

virtual void	EnableOn ()
	Enable/Disable a view. More...

virtual void	EnableOff ()
	Enable/Disable a view. More...


vtkImageData *	CaptureWindow (int magnification)
	Captures a image from this view. More...

vtkImageData *	CaptureWindow (int magnificationX, int magnificationY)
	Captures a image from this view. More...


virtual bool	GetNeedsUpdate ()
	Returns true if the subsequent call to Update() will result in an actual update. More...

Public Member Functions inherited from vtkSMProxy
void	SetAnnotation (const char key, const char value)

const char *	GetAnnotation (const char *key)
	Retrieve an annotation with a given key. More...

void	RemoveAnnotation (const char *key)
	Remove a given annotation based on its key to the proxy. More...

void	RemoveAllAnnotations ()
	Remove all proxy annotations. More...

bool	HasAnnotation (const char *key)
	Return true if a given annotation exists. More...

int	GetNumberOfAnnotations ()
	Return the number of available annotations. More...

const char *	GetAnnotationKeyAt (int index)
	Return the nth key of the available annotations. More...

void	SetLocation (vtkTypeUInt32) override
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkSMProperty *	GetProperty (const char *name)
	Return the property with the given name. More...

virtual vtkSMProperty *	GetProperty (const char *name, int selfOnly)
	Return a property of the given name from self or one of the sub-proxies. More...

const char *	GetPropertyName (vtkSMProperty *prop)
	Given a property pointer, returns the name that was used to add it to the proxy. More...

virtual void	UpdateVTKObjects ()
	Update the VTK object on the server by pushing the values of all modified properties (un-modified properties are ignored). More...

virtual void	RecreateVTKObjects ()
	Recreate the VTK object for this proxy. More...

void	InvokeCommand (const char *name)
	Convenience method equivalent to UpdateProperty(name, 1). More...

virtual vtkSMPropertyIterator *	NewPropertyIterator ()
	Returns a new (initialized) iterator of the properties. More...

unsigned int	GetNumberOfConsumers ()
	Returns the number of consumers. More...

vtkSMProxy *	GetConsumerProxy (unsigned int idx)
	Returns the consumer of given index. More...

vtkSMProperty *	GetConsumerProperty (unsigned int idx)
	Returns the corresponding property of the consumer of given index. More...

unsigned int	GetNumberOfProducers ()
	Returns the number of proxies this proxy depends on (uses or is connected to through the pipeline). More...

vtkSMProxy *	GetProducerProxy (unsigned int idx)
	Returns a proxy this proxy depends on, given index. More...

vtkSMProperty *	GetProducerProperty (unsigned int idx)
	Returns the property holding a producer proxy given an index. More...

virtual void	UpdatePropertyInformation ()
	Updates all property information by calling UpdateInformation() and populating the values. More...

virtual void	UpdatePropertyInformation (vtkSMProperty *prop)
	Similar to UpdatePropertyInformation() but updates only the given property. More...

virtual void	MarkAllPropertiesAsModified ()
	Marks all properties as modified. More...

virtual void	ResetPropertiesToXMLDefaults ()
	Use this method to set all properties on this proxy to their default values. More...

virtual void	ResetPropertiesToDomainDefaults ()
	Use this method to set all properties on this proxy to their default domains. More...

virtual void	ResetPropertiesToDefault (ResetPropertiesMode mode=DEFAULT)
	Use this method to set all properties on this proxy to their default domain or values. More...

virtual void	MarkModified (vtkSMProxy *modifiedProxy)
	Calls MarkDirty() and invokes ModifiedEvent. More...

void	InitializeAndCopyFromProxy (vtkSMProxy *source)
	Given a source proxy, makes this proxy point to the same server-side object (with a new id). More...

virtual void	MarkDirty (vtkSMProxy *modifiedProxy)
	Dirty means this algorithm will execute during next update. More...

vtkObjectBase *	GetClientSideObject ()
	Returns the client side object associated with the VTKObjectID (if any). More...

virtual vtkPVXMLElement *	SaveXMLState (vtkPVXMLElement *root)
	Saves the state of the proxy. More...

virtual vtkPVXMLElement *	SaveXMLState (vtkPVXMLElement root, vtkSMPropertyIterator iter)
	The iterator is use to filter the property available on the given proxy. More...

virtual int	LoadXMLState (vtkPVXMLElement element, vtkSMProxyLocator locator)
	Loads the proxy state from the XML element. More...

void	UpdateSelfAndAllInputs ()
	This method call UpdateVTKObjects on the current pipeline by starting at the sources. More...

bool	GetIsSubProxy ()
	A proxy instance can be a sub-proxy for some other proxy. More...

vtkSMProxy *	GetParentProxy ()
	If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...

vtkSMProxy *	GetTrueParentProxy ()
	Call GetParentProxy() recursively till a proxy that is not a subproxy of any other proxy is found. More...

void	EnableLocalPushOnly () override
	Allow to switch off any push of state change to the server for that particular object. More...

void	DisableLocalPushOnly () override
	Enable the given remote object to communicate its state normally to the server location. More...

const vtkSMMessage *	GetFullState () override
	This method return the full object state that can be used to create that object from scratch. More...

void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator) override
	This method is used to initialise 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 globalID set. More...

vtkSMPropertyGroup *	GetPropertyGroup (size_t index) const
	Returns the property group at `index` for the proxy. More...

size_t	GetNumberOfPropertyGroups () const
	Returns the number of property groups that the proxy contains. More...

const char *	GetLogNameOrDefault ()
	A helper that makes up an default name if none is provided. More...

bool	GetPropertiesModified ()

bool	UpdateProperty (const char *name)
	Update the value of one property (pushed to the server) if it is modified. More...

bool	UpdateProperty (const char *name, int force)
	Update the value of one property (pushed to the server) if it is modified. More...

virtual char *	GetVTKClassName ()
	Returns the type of object managed by the proxy. More...

virtual void	SetVTKClassName (const char *)
	the type of object created by the proxy. More...

virtual char *	GetXMLName ()
	Assigned by the XML parser. More...

virtual char *	GetXMLGroup ()
	Assigned by the XML parser. More...

virtual char *	GetXMLLabel ()
	Assigned by the XML parser. More...

void	Copy (vtkSMProxy *src)
	Copies values of all the properties and sub-proxies from src. More...

void	Copy (vtkSMProxy src, const char exceptionClass)
	Copies values of all the properties and sub-proxies from src. More...

virtual void	Copy (vtkSMProxy src, const char exceptionClass, int proxyPropertyCopyFlag)
	Copies values of all the properties and sub-proxies from src. More...

virtual vtkSMDocumentation *	GetDocumentation ()
	Returns the documentation for this proxy. More...

virtual vtkPVXMLElement *	GetHints ()
	The server manager configuration XML may define `<Hints/>` element for a proxy. More...

virtual int	GetObjectsCreated ()
	Returns if the VTK objects for this proxy have been created. More...

bool	GatherInformation (vtkPVInformation *information)
	Gathers information about this proxy. More...

bool	GatherInformation (vtkPVInformation *information, vtkTypeUInt32 location)
	Gathers information about this proxy. More...

void	PrototypeOn () override
	Allow user to set the remote object to be discard for Undo/Redo action. More...

void	PrototypeOff () override
	Allow user to set the remote object to be discard for Undo/Redo action. More...

void	SetPrototype (bool undo) override
	Allow user to set the remote object to be discard for Undo/Redo action. More...

void	SetLogName (const char *name)
	Log name is a name for this proxy that will be used when logging status messages. More...

virtual char *	GetLogName ()
	Log name is a name for this proxy that will be used when logging status messages. More...

Public Member Functions inherited from vtkSMRemoteObject
void	SetSession (vtkSMSession *) override
	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 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 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...

bool	IsPrototype ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. 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 vtkSMViewProxy *	New ()

static int	IsTypeOf (const char *type)

static vtkSMViewProxy *	SafeDownCast (vtkObject *o)

static vtkSMViewProxy *	FindView (vtkSMProxy repr, const char reggroup="views")
	Helper method to locate a view to which the representation has been added. More...


static void	SetTransparentBackground (bool val)
	Sets whether screenshots have a transparent background. More...

static bool	GetTransparentBackground ()
	Sets whether screenshots have a transparent background. More...

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

static int	IsTypeOf (const char *type)

static vtkSMProxy *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMRemoteObject
static int	IsTypeOf (const char *type)

static vtkSMRemoteObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

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
	vtkSMViewProxy ()

	~vtkSMViewProxy () override

virtual vtkImageData *	CaptureWindowInternal (int magnificationX, int magnificationY)
	Capture an image from the view's render window. More...

virtual void	RenderForImageCapture ()
	This method is called whenever the view wants to render to during image capture. More...

virtual vtkTypeUInt32	PreRender (bool vtkNotUsed(interactive))
	This method is called before executing code that could cause a render on the underlying vtkPVView. More...

virtual void	PostRender (bool vtkNotUsed(interactive))

virtual bool	IsContextReadyForRendering ()
	Subclasses should override this method and return false if the rendering context is not ready for rendering at this moment. More...

void	CreateVTKObjects () override
	Called at the end of CreateVTKObjects(). More...

int	ReadXMLAttributes (vtkSMSessionProxyManager pm, vtkPVXMLElement element) override
	Read attributes from an XML element. More...

bool	GetLocalProcessSupportsInteraction ()
	Convenience method to call vtkPVView::SafeDownCast(this->GetClientSideObject())->GetLocalProcessSupportsInteraction();. More...

virtual vtkSMDataDeliveryManagerProxy *	GetDeliveryManager ()
	Provides access to the delivery manager proxy, if any. More...

virtual void	SetDefaultRepresentationName (const char *)

Protected Member Functions inherited from vtkSMProxy
	vtkSMProxy ()

	~vtkSMProxy () override

void	ExecuteStream (const vtkClientServerStream &msg, bool ignore_errors=false, vtkTypeUInt32 location=0)
	Invoke that takes a vtkClientServerStream as the argument. More...

virtual void	UpdateAndPushAnnotationState ()

virtual void	AddProperty (const char name, vtkSMProperty prop)
	Add a property with the given key (name). More...

virtual void	MarkConsumersAsDirty (vtkSMProxy *modifiedProxy)
	Calls `MarkDirtyFromProducer` on all consumers. More...

virtual void	MarkDirtyFromProducer (vtkSMProxy modifiedProxy, vtkSMProxy producer, vtkSMProperty *property)
	`MarkConsumersAsDirty` calls this method on each consumer, instead of directly calling `MarkDirty` on the consumer. More...

void	MarkInputsAsDirty ()
	This method is called by vtkSMRepresentationProxy whenever the time request for the pipeline may have potentially changed. More...

void	RemoveAllObservers ()
	Cleanup code. More...

virtual void	SetPropertyModifiedFlag (const char *name, int flag)
	Note on property modified flags: The modified flag of each property associated with a proxy is stored in the proxy object instead of in the property itself. More...

void	AddSubProxy (const char name, vtkSMProxy proxy, int overrideOK=0)
	Add a sub-proxy. More...

void	RemoveSubProxy (const char *name)
	Remove a sub-proxy. More...

vtkSMProxy *	GetSubProxy (const char *name)
	Returns a sub-proxy. More...

vtkSMProxy *	GetSubProxy (unsigned int index)
	Returns a sub-proxy. More...

const char *	GetSubProxyName (unsigned int index)
	Returns the name used to store sub-proxy. More...

const char *	GetSubProxyName (vtkSMProxy *)
	Returns the name used to store sub-proxy. More...

unsigned int	GetNumberOfSubProxies ()
	Returns the number of sub-proxies. More...

virtual void	AddConsumer (vtkSMProperty property, vtkSMProxy proxy)
	Called by a proxy property, this adds the property,proxy pair to the list of consumers. More...

virtual void	RemoveConsumer (vtkSMProperty property, vtkSMProxy proxy)
	Remove the property,proxy pair from the list of consumers. More...

virtual void	RemoveAllConsumers ()
	Remove all consumers. More...

void	AddProducer (vtkSMProperty property, vtkSMProxy proxy)
	Called by an proxy/input property to add property, proxy pair to the list of producers. More...

void	RemoveProducer (vtkSMProperty property, vtkSMProxy proxy)
	Remove the property,proxy pair from the list of producers. More...

virtual void	PostUpdateData (bool using_cache)
	This method is called after the algorithm(s) (if any) associated with this proxy execute. More...

void	PostUpdateDataSelfOnly (bool using_cache)
	This is called by `PostUpdateData` to only update state for this proxy without iterative over producers. More...

bool	WarnIfDeprecated ()
	If a proxy is deprecated, prints a warning. More...

virtual void	UpdatePipelineInformation ()
	This method simply iterates over subproxies and calls UpdatePipelineInformation() on them. More...

void	LinkProperty (vtkSMProperty inputProperty, vtkSMProperty outputProperty)
	Links properties such that when inputProperty's checked or unchecked values are changed, the outputProperty's corresponding values are also changed. More...

vtkSMPropertyGroup *	NewPropertyGroup (vtkPVXMLElement *propElement)
	Parses the XML to create a new property group. More...

void	AppendPropertyGroup (vtkSMPropertyGroup *group)
	Adds a property groups. More...

void	ExposeSubProxyProperty (const char subproxy_name, const char property_name, const char *exposed_name, int overrideOK=0)
	Expose a subproxy property from the base proxy. More...

virtual void	ExecuteSubProxyEvent (vtkSMProxy o, unsigned long event, void data)
	Handle events fired by subproxies. More...

virtual int	CreateSubProxiesAndProperties (vtkSMSessionProxyManager pm, vtkPVXMLElement element)

virtual void	UpdatePropertyInformationInternal (vtkSMProperty *prop=nullptr)
	Called to update the property information on the property. More...

void	RebuildStateForProperties ()
	vtkSMProxy tracks state of properties on this proxy in an internal State object. More...

virtual void	SetLogNameInternal (const char *name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains)
	Internal method used by `SetLogName` More...

bool	ArePropertiesModified ()
	Indicates if any properties are modified. More...

void	SetHints (vtkPVXMLElement *hints)

void	SetDeprecated (vtkPVXMLElement *deprecated)

void	SetXMLElement (vtkPVXMLElement *element)

	vtkSMProxy (const vtkSMProxy &)=delete

void	operator= (const vtkSMProxy &)=delete

virtual const vtkClientServerStream &	GetLastResult ()
	Get the last result. More...

virtual const vtkClientServerStream &	GetLastResult (vtkTypeUInt32 location)
	Get the last result. More...

virtual void	SetXMLName (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLGroup (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLLabel (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLSubProxyName (const char *)
	Assigned by the XML parser. More...

vtkSMProperty *	NewProperty (const char *name)
	Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...

vtkSMProperty *	NewProperty (const char name, vtkPVXMLElement propElement)
	Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...

void	SetupExposedProperties (const char subproxy_name, vtkPVXMLElement element)
	Read attributes from an XML element. More...

void	SetupSharedProperties (vtkSMProxy subproxy, vtkPVXMLElement element)
	Read attributes from an XML element. More...

virtual void	SetSIClassName (const char *)
	SIClassName identifies the classname for the helper on the server side. More...

virtual char *	GetSIClassName ()
	SIClassName identifies the classname for the helper on the server side. More...

Protected Member Functions inherited from vtkSMRemoteObject
	vtkSMRemoteObject ()
	Default constructor. More...

	~vtkSMRemoteObject () override
	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 () override

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

Protected Attributes
char *	DefaultRepresentationName

bool	Enable

Protected Attributes inherited from vtkSMProxy
bool	NeedsUpdate

char *	VTKClassName

char *	XMLGroup

char *	XMLName

char *	XMLLabel

char *	XMLSubProxyName

int	ObjectsCreated

int	DoNotUpdateImmediately

int	DoNotModifyProperty

int	InUpdateVTKObjects
	Avoids calls to UpdateVTKObjects in UpdateVTKObjects. More...

bool	PropertiesModified
	Flag used to help speed up UpdateVTKObjects and ArePropertiesModified calls. More...

vtkPVXMLElement *	XMLElement

vtkSMDocumentation *	Documentation

vtkPVXMLElement *	Hints

vtkPVXMLElement *	Deprecated

vtkSMMessage *	State

int	InMarkModified

vtkWeakPointer< vtkSMProxy >	ParentProxy

vtkSMProxyInternals *	Internals

vtkSMProxyObserver *	SubProxyObserver

char *	SIClassName
	SIClassName identifies the classname for the helper on the server side. More...

Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32	GlobalID

vtkTypeUInt32	Location

bool	Prototype

bool	ClientOnlyLocationFlag

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSMViewProxyNS::WindowToImageFilter

class	vtkSMViewProxyNS::CaptureHelper

static bool	HideOtherRepresentationsIfNeeded (vtkSMViewProxy self, vtkSMProxy repr)
	Method used to hide other representations if the view has a `<ShowOneRepresentationAtATime/>` hint. More...

virtual bool	HideOtherRepresentationsIfNeeded (vtkSMProxy *repr)
	Method used to hide other representations if the view has a `<ShowOneRepresentationAtATime/>` hint. More...

static void	RepresentationVisibilityChanged (vtkSMViewProxy self, vtkSMProxy repr, bool new_visibility)
	Certain views maintain properties (or other state) that should be updated when visibility of representations is changed e.g. More...

virtual void	RepresentationVisibilityChanged (vtkSMProxy *repr, bool new_visibility)
	Certain views maintain properties (or other state) that should be updated when visibility of representations is changed e.g. More...

Detailed Description

Superclass for all view proxies.

vtkSMViewProxy is a superclass for all view proxies. A view proxy abstracts the logic to take one or more representation proxies and show then in some viewport such as vtkRenderWindow. This class may directly be used as the view proxy for views that do all the rendering work at the GUI level. The VTKObject corresponding to this class has to be a vtkView subclass.

Events:

vtkCommand::StartEvent(callData: int:0) – start of StillRender().
vtkCommand::EndEvent(callData: int:0) – end of StillRender().
vtkCommand::StartEvent(callData: int:1) – start of InteractiveRender().
vtkCommand::EndEvent(callData: int:1) – end of InteractiveRender().

Definition at line 42 of file vtkSMViewProxy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMProxy vtkSMViewProxy::Superclass

Definition at line 46 of file vtkSMViewProxy.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
PrepareContextForRendering	Fired in `IsContextReadyForRendering` if the context is not already ready for rendering.

Definition at line 240 of file vtkSMViewProxy.h.

Constructor & Destructor Documentation

◆ vtkSMViewProxy()

vtkSMViewProxy::vtkSMViewProxy ( )

protected

◆ ~vtkSMViewProxy()

vtkSMViewProxy::~vtkSMViewProxy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMViewProxy* vtkSMViewProxy::New ( )

static

◆ GetClassName()

virtual const char* vtkSMViewProxy::GetClassName ( )

virtual

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMRenderViewProxy, vtkSMContextViewProxy, vtkSMComparativeViewProxy, vtkSMPythonViewProxy, vtkSMSpreadSheetViewProxy, vtkSMMultiSliceViewProxy, vtkSMPlotMatrixViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMRenderViewProxy, vtkSMContextViewProxy, vtkSMComparativeViewProxy, vtkSMPythonViewProxy, vtkSMSpreadSheetViewProxy, vtkSMMultiSliceViewProxy, vtkSMPlotMatrixViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMPythonViewProxy.

◆ SetEnable()

virtual void vtkSMViewProxy::SetEnable ( bool )

virtual

Enable/Disable a view.

◆ GetEnable()

virtual bool vtkSMViewProxy::GetEnable ( )

virtual

Enable/Disable a view.

◆ EnableOn()

virtual void vtkSMViewProxy::EnableOn ( )

virtual

Enable/Disable a view.

◆ EnableOff()

virtual void vtkSMViewProxy::EnableOff ( )

virtual

Enable/Disable a view.

◆ StillRender()

virtual void vtkSMViewProxy::StillRender ( )

virtual

Renders the view using full resolution.

◆ InteractiveRender()

virtual void vtkSMViewProxy::InteractiveRender ( )

virtual

Renders the view using lower resolution is possible.

◆ Update()

virtual void vtkSMViewProxy::Update ( )

virtual

Called vtkPVView::Update on the server-side.

Reimplemented in vtkSMRenderViewProxy, and vtkSMComparativeViewProxy.

◆ CanDisplayData()

virtual bool vtkSMViewProxy::CanDisplayData	(	vtkSMSourceProxy *	producer,
		int	outputPort
	)

virtual

Returns true if the view can display the data produced by the producer's port.

Internally calls GetRepresentationType() and returns true only if the type is valid a representation proxy of that type can be created.

Reimplemented in vtkSMContextViewProxy.

◆ CreateDefaultRepresentation()

virtual vtkSMRepresentationProxy* vtkSMViewProxy::CreateDefaultRepresentation	(	vtkSMProxy *	,
		int
	)

virtual

Create a default representation for the given source proxy.

Returns a new proxy. In version 4.1 and earlier, subclasses overrode this method. Since 4.2, the preferred way is to simply override GetRepresentationType(). That ensures that CreateDefaultRepresentation() and CanDisplayData() both work as expected.

Reimplemented in vtkSMMultiSliceViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ GetRepresentationType()

virtual const char* vtkSMViewProxy::GetRepresentationType	(	vtkSMSourceProxy *	producer,
		int	outputPort
	)

virtual

Returns the xml name of the representation proxy to create to show the data produced in this view, if any.

Default implementation checks if the producer has any "Hints" that define the representation to create in this view and if so, returns that. Or if this->DefaultRepresentationName is set and its Input property can accept the data produced, returns this->DefaultRepresentationName. Subclasses should override this method.

Reimplemented in vtkSMRenderViewProxy, vtkSMContextViewProxy, vtkSMComparativeViewProxy, vtkSMMultiSliceViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ FindRepresentation()

virtual vtkSMRepresentationProxy* vtkSMViewProxy::FindRepresentation	(	vtkSMSourceProxy *	producer,
		int	outputPort
	)

virtual

Finds the representation proxy showing the data produced by the provided producer, if any.

Note the representation may not necessarily be visible.

◆ CaptureWindow() [1/2]

vtkImageData* vtkSMViewProxy::CaptureWindow ( int magnification )

inline

Captures a image from this view.

Default implementation returns nullptr. Subclasses should override CaptureWindowInternal() to do the actual image capture.

Definition at line 113 of file vtkSMViewProxy.h.

◆ CaptureWindow() [2/2]

vtkImageData* vtkSMViewProxy::CaptureWindow	(	int	magnificationX,
		int	magnificationY
	)

Captures a image from this view.

Default implementation returns nullptr. Subclasses should override CaptureWindowInternal() to do the actual image capture.

◆ GetClientSideView()

vtkView* vtkSMViewProxy::GetClientSideView ( )

Returns the client-side vtkView, if any.

◆ WriteImage() [1/2]

int vtkSMViewProxy::WriteImage	(	const char *	filename,
		const char *	writerName,
		int	magnification = `1`
	)

Saves a screenshot of the view to disk.

The writerName argument specifies the vtkImageWriter subclass to use.

◆ WriteImage() [2/2]

int vtkSMViewProxy::WriteImage	(	const char *	filename,
		const char *	writerName,
		int	magnificationX,
		int	magnificationY
	)

◆ HasDirtyRepresentation()

virtual bool vtkSMViewProxy::HasDirtyRepresentation ( )

inlinevirtual

Return true any internal representation is dirty.

This can be useful to know if the internal geometry has changed. DEPRECATED: Use GetNeedsUpdate() instead.

Definition at line 137 of file vtkSMViewProxy.h.

◆ GetNeedsUpdate()

virtual bool vtkSMViewProxy::GetNeedsUpdate ( )

virtual

Returns true if the subsequent call to Update() will result in an actual update.

If returned true, it means that the view thinks its rendering is obsolete and needs to be re-generated.

Reimplemented in vtkSMRenderViewProxy.

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkSMViewProxy::GetRenderWindow ( )

inlinevirtual

Return the vtkRenderWindow used by this view, if any.

Note, views like vtkSMComparativeViewProxy can have more than 1 render window in play, in which case, using this method alone may yield incorrect results. Also, certain views don't use a vtkRenderWindow at all (e.g. Spreadsheet View), in which case, this method will return nullptr. Default implementation returns nullptr.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, vtkSMContextViewProxy, and vtkSMPythonViewProxy.

Definition at line 156 of file vtkSMViewProxy.h.

◆ GetInteractor()

virtual vtkRenderWindowInteractor* vtkSMViewProxy::GetInteractor ( )

inlinevirtual

Returns the interactor.

Note, that views may not use vtkRenderWindow at all in which case they will not have any interactor and will return nullptr. Default implementation returns nullptr.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, vtkSMContextViewProxy, and vtkSMPythonViewProxy.

Definition at line 163 of file vtkSMViewProxy.h.

◆ SetupInteractor()

virtual void vtkSMViewProxy::SetupInteractor ( vtkRenderWindowInteractor * iren )

inlinevirtual

A client process need to set the interactor to enable interactivity.

Use this method to set the interactor and initialize it as needed by the RenderView. This include changing the interactor style as well as overriding VTK rendering to use the Proxy/ViewProxy API instead. Default implementation does nothing. Views that support interaction using vtkRenderWindowInteractor should override this method to set the interactor up.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, vtkSMPythonViewProxy, and vtkSMContextViewProxy.

Definition at line 174 of file vtkSMViewProxy.h.

◆ MakeRenderWindowInteractor()

virtual bool vtkSMViewProxy::MakeRenderWindowInteractor ( bool quiet = false )

virtual

Creates a default render window interactor for the vtkRenderWindow and sets it up on the local process if the local process supports interaction.

This should not be used when putting the render window in a QVTKWidget as that may cause issues. One should let the QVTKWidget create the interactor and then call SetupInteractor().

Reimplemented in vtkSMComparativeViewProxy.

◆ SetTransparentBackground()

static void vtkSMViewProxy::SetTransparentBackground ( bool val )

static

Sets whether screenshots have a transparent background.

◆ GetTransparentBackground()

static bool vtkSMViewProxy::GetTransparentBackground ( )

static

Sets whether screenshots have a transparent background.

◆ HideOtherRepresentationsIfNeeded() [1/2]

virtual bool vtkSMViewProxy::HideOtherRepresentationsIfNeeded ( vtkSMProxy * repr )

virtual

Method used to hide other representations if the view has a <ShowOneRepresentationAtATime/> hint.

This only affects other representations that have data inputs, not non-data representations.

Returns: true if any representations were hidden by this call, otherwise returns false.

◆ HideOtherRepresentationsIfNeeded() [2/2]

static bool vtkSMViewProxy::HideOtherRepresentationsIfNeeded	(	vtkSMViewProxy *	self,
		vtkSMProxy *	repr
	)

inlinestatic

Method used to hide other representations if the view has a <ShowOneRepresentationAtATime/> hint.

This only affects other representations that have data inputs, not non-data representations.

Returns: true if any representations were hidden by this call, otherwise returns false.

Definition at line 204 of file vtkSMViewProxy.h.

◆ RepresentationVisibilityChanged() [1/2]

virtual void vtkSMViewProxy::RepresentationVisibilityChanged	(	vtkSMProxy *	repr,
		bool	new_visibility
	)

virtual

Certain views maintain properties (or other state) that should be updated when visibility of representations is changed e.g.

SpreadSheetView needs to update the value of the "FieldAssociation" when a new data representation is being shown in the view. Subclasses can override this method to perform such updates to View properties. This is called explicitly by the vtkSMParaViewPipelineControllerWithRendering after changing representation visibility. Changes to representation visibility outside of vtkSMParaViewPipelineControllerWithRendering will require calling this method explicitly.

Default implementation does not do anything.

Reimplemented in vtkSMSpreadSheetViewProxy.

◆ RepresentationVisibilityChanged() [2/2]

static void vtkSMViewProxy::RepresentationVisibilityChanged	(	vtkSMViewProxy *	self,
		vtkSMProxy *	repr,
		bool	new_visibility
	)

inlinestatic

Certain views maintain properties (or other state) that should be updated when visibility of representations is changed e.g.

SpreadSheetView needs to update the value of the "FieldAssociation" when a new data representation is being shown in the view. Subclasses can override this method to perform such updates to View properties. This is called explicitly by the vtkSMParaViewPipelineControllerWithRendering after changing representation visibility. Changes to representation visibility outside of vtkSMParaViewPipelineControllerWithRendering will require calling this method explicitly.

Default implementation does not do anything.

Definition at line 225 of file vtkSMViewProxy.h.

◆ FindView()

static vtkSMViewProxy* vtkSMViewProxy::FindView	(	vtkSMProxy *	repr,
		const char *	reggroup = `"views"`
	)

static

Helper method to locate a view to which the representation has been added.

◆ CaptureWindowInternal()

virtual vtkImageData* vtkSMViewProxy::CaptureWindowInternal	(	int	magnificationX,
		int	magnificationY
	)

protectedvirtual

Capture an image from the view's render window.

Default implementation simply captures the image from the render window for the view. Subclasses may override this for cases where that's not sufficient.

Parameters

[in]	magnificationX	The X magnification factor to use for generating the image.
[in]	magnificationY	The Y magnification factor to use for generating the image.

Returns: A new vtkImageData instance or nullptr. Caller is responsible for calling vtkImageData::Delete() on the returned non-nullptr value.

Reimplemented in vtkSMComparativeViewProxy, and vtkSMPythonViewProxy.

◆ RenderForImageCapture()

virtual void vtkSMViewProxy::RenderForImageCapture ( )

inlineprotectedvirtual

This method is called whenever the view wants to render to during image capture.

The default implementation simply calls this->StillRender().

Reimplemented in vtkSMRenderViewProxy.

Definition at line 269 of file vtkSMViewProxy.h.

◆ PreRender()

virtual vtkTypeUInt32 vtkSMViewProxy::PreRender ( bool vtkNotUsedinteractive )

inlineprotectedvirtual

This method is called before executing code that could cause a render on the underlying vtkPVView.

This is the method where subclasses can ensure that the data for rendering is made available ranks that will be doing the rendering and then return the location where the rendering will happen.

Thus vtkSMViewProxy can send the render request to only those processes that will be doing rendering avoiding unnecessary communication to non-participating ranks.

Definition at line 281 of file vtkSMViewProxy.h.

◆ PostRender()

virtual void vtkSMViewProxy::PostRender ( bool vtkNotUsedinteractive )

inlineprotectedvirtual

Definition at line 283 of file vtkSMViewProxy.h.

◆ IsContextReadyForRendering()

virtual bool vtkSMViewProxy::IsContextReadyForRendering ( )

protectedvirtual

Subclasses should override this method and return false if the rendering context is not ready for rendering at this moment.

This method is called in StillRender() and InteractiveRender() calls before the actual render to ensure that we don't attempt to render when the rendering context is not ready. Default implementation uses this->GetRenderWindow() and checks if that window is drawable.

◆ CreateVTKObjects()

void vtkSMViewProxy::CreateVTKObjects ( )

overrideprotectedvirtual

Called at the end of CreateVTKObjects().

Reimplemented from vtkSMProxy.

◆ ReadXMLAttributes()

int vtkSMViewProxy::ReadXMLAttributes	(	vtkSMSessionProxyManager *	pm,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

Read attributes from an XML element.

Reimplemented from vtkSMProxy.

◆ GetLocalProcessSupportsInteraction()

bool vtkSMViewProxy::GetLocalProcessSupportsInteraction ( )

protected

Convenience method to call vtkPVView::SafeDownCast(this->GetClientSideObject())->GetLocalProcessSupportsInteraction();.

◆ GetDeliveryManager()

virtual vtkSMDataDeliveryManagerProxy* vtkSMViewProxy::GetDeliveryManager ( )

protectedvirtual

Provides access to the delivery manager proxy, if any.

◆ SetDefaultRepresentationName()

virtual void vtkSMViewProxy::SetDefaultRepresentationName ( const char * )

protectedvirtual

Friends And Related Function Documentation

◆ vtkSMViewProxyNS::WindowToImageFilter

friend class vtkSMViewProxyNS::WindowToImageFilter

friend

Definition at line 334 of file vtkSMViewProxy.h.

◆ vtkSMViewProxyNS::CaptureHelper

friend class vtkSMViewProxyNS::CaptureHelper

friend

Definition at line 335 of file vtkSMViewProxy.h.

Member Data Documentation

◆ DefaultRepresentationName

char* vtkSMViewProxy::DefaultRepresentationName

protected

Definition at line 317 of file vtkSMViewProxy.h.

◆ Enable

bool vtkSMViewProxy::Enable

protected

Definition at line 320 of file vtkSMViewProxy.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSMViewProxy()

◆ ~vtkSMViewProxy()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetEnable()

◆ GetEnable()

◆ EnableOn()

◆ EnableOff()

◆ StillRender()

◆ InteractiveRender()

◆ Update()

◆ CanDisplayData()

◆ CreateDefaultRepresentation()

◆ GetRepresentationType()

◆ FindRepresentation()

◆ CaptureWindow() [1/2]

◆ CaptureWindow() [2/2]

◆ GetClientSideView()

◆ WriteImage() [1/2]

◆ WriteImage() [2/2]

◆ HasDirtyRepresentation()

◆ GetNeedsUpdate()

◆ GetRenderWindow()

◆ GetInteractor()

◆ SetupInteractor()

◆ MakeRenderWindowInteractor()

◆ SetTransparentBackground()

◆ GetTransparentBackground()

◆ HideOtherRepresentationsIfNeeded() [1/2]

◆ HideOtherRepresentationsIfNeeded() [2/2]

◆ RepresentationVisibilityChanged() [1/2]

◆ RepresentationVisibilityChanged() [2/2]

◆ FindView()

◆ CaptureWindowInternal()

◆ RenderForImageCapture()

◆ PreRender()

◆ PostRender()

◆ IsContextReadyForRendering()

◆ CreateVTKObjects()

◆ ReadXMLAttributes()

◆ GetLocalProcessSupportsInteraction()

◆ GetDeliveryManager()

◆ SetDefaultRepresentationName()

Friends And Related Function Documentation

◆ vtkSMViewProxyNS::WindowToImageFilter

◆ vtkSMViewProxyNS::CaptureHelper

Member Data Documentation

◆ DefaultRepresentationName

◆ Enable