Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMViewLayoutProxy Class Reference

vtkSMViewLayoutProxy is used by ParaView to layout multiple views in a 2D KD-Tree layout. More...

#include <vtkSMViewLayoutProxy.h>

Inheritance diagram for vtkSMViewLayoutProxy:
Inheritance graph
[legend]
Collaboration diagram for vtkSMViewLayoutProxy:
Collaboration graph
[legend]

Public Types

enum  Direction { NONE, VERTICAL, HORIZONTAL }
 
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
 
int Split (int location, int direction, double fraction)
 Split a frame at the given location. More...
 
int SplitVertical (int location, double fraction)
 
int SplitHorizontal (int location, double fraction)
 
bool AssignView (int location, vtkSMViewProxy *view)
 Assign a view at a particular location. More...
 
int AssignViewToAnyCell (vtkSMViewProxy *view, int location_hint)
 Similar to AssignView() except that is location specified is not available, then this method treats the location merely as a hint and tries to find a suitable place. More...
 
bool Collapse (int location)
 Collapses a cell. More...
 
bool SwapCells (int location1, int location2)
 Swaps the cells at the two locations. More...
 
bool SetSplitFraction (int location, double fraction)
 Update the split fraction for a split cell. More...
 
bool MaximizeCell (int location)
 One can maximize a particular (non-split) cell. More...
 
void RestoreMaximizedState ()
 Restores the maximized state. More...
 
bool IsSplitCell (int location)
 Returns true if the cell identified by the location is a split cell. More...
 
Direction GetSplitDirection (int location)
 Returns the split direction for a split cell at the given location. More...
 
double GetSplitFraction (int location)
 Returns the split-fraction for a split cell at the given location. More...
 
vtkSMViewProxyGetView (int location)
 Returns the view, if any, assigned to the given cell location. More...
 
int GetViewLocation (vtkSMViewProxy *)
 Returns the location for the view, of any. More...
 
void UpdateViewPositions ()
 Updates positions for all views using the layout and current sizes. More...
 
void ShowViewsOnTileDisplay ()
 When in tile-display configuration, only 1 view-layout is shown on the tile-display (for obvious reasons). More...
 
vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root) override
 Overridden to save custom XML state. More...
 
vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root, vtkSMPropertyIterator *iter) override
 The iterator is use to filter the property available on the given proxy. More...
 
int LoadXMLState (vtkPVXMLElement *element, vtkSMProxyLocator *locator) override
 Overridden to load custom XML state. More...
 
void Reset ()
 Resets the layout. More...
 
void GetLayoutExtent (int extent[4])
 Returns the extents for all views in the layout. More...
 
vtkVector2i GetSize ()
 Returns the current size. More...
 
std::vector< vtkSMViewProxy * > GetViews ()
 Returns a vector of the view proxies added to his layout. More...
 
int RemoveView (vtkSMViewProxy *view)
 Removes a view. More...
 
bool RemoveView (int index)
 Removes a view. More...
 
virtual int GetMaximizedCell ()
 Returns the maximized cell, if any. More...
 
bool ContainsView (vtkSMViewProxy *view)
 Returns if a view is contained in this layout. More...
 
bool ContainsView (vtkSMProxy *view)
 Returns if a view is contained in this layout. More...
 
vtkImageDataCaptureWindow (int magnification)
 Captures an image from the layout (including all the views in the layout. More...
 
vtkImageDataCaptureWindow (int magnificationX, int magnificationY)
 Captures an image from the layout (including all the views in the layout. More...
 
void SetSize (const int size[2])
 Update the size for all the views in the layout assuming the new size provided for the whole layout. More...
 
void SetSize (int width, int height)
 Update the size for all the views in the layout assuming the new size provided for the whole layout. More...
 
void SaveAsPNG (int rank, const char *fname)
 This is only meant for testing and debugging purposes. 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 vtkSMPropertyGetProperty (const char *name)
 Return the property with the given name. More...
 
virtual vtkSMPropertyGetProperty (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 vtkSMPropertyIteratorNewPropertyIterator ()
 Returns a new (initialized) iterator of the properties. More...
 
unsigned int GetNumberOfConsumers ()
 Returns the number of consumers. More...
 
vtkSMProxyGetConsumerProxy (unsigned int idx)
 Returns the consumer of given index. More...
 
vtkSMPropertyGetConsumerProperty (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...
 
vtkSMProxyGetProducerProxy (unsigned int idx)
 Returns a proxy this proxy depends on, given index. More...
 
vtkSMPropertyGetProducerProperty (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...
 
vtkObjectBaseGetClientSideObject ()
 Returns the client side object associated with the VTKObjectID (if any). 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...
 
vtkSMProxyGetParentProxy ()
 If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...
 
vtkSMProxyGetTrueParentProxy ()
 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 vtkSMMessageGetFullState () override
 This method return the full object state that can be used to create that object from scratch. More...
 
vtkSMPropertyGroupGetPropertyGroup (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 vtkSMDocumentationGetDocumentation ()
 Returns the documentation for this proxy. More...
 
virtual vtkPVXMLElementGetHints ()
 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 vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMViewLayoutProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMViewLayoutProxySafeDownCast (vtkObject *o)
 
static int GetFirstChild (int location)
 Returns the index for the first child of the given location. More...
 
static int GetSecondChild (int location)
 Returns the index for the second child of the given location. More...
 
static int GetParent (int location)
 Returns the parent index. More...
 
static vtkSMViewLayoutProxyFindLayout (vtkSMViewProxy *, const char *reggroup="layouts")
 Helper method to locate a layout, if any that contains the specified view proxy. More...
 
- Static Public Member Functions inherited from vtkSMProxy
static vtkSMProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMViewLayoutProxy ()
 
 ~vtkSMViewLayoutProxy () override
 
void LoadState (const vtkSMMessage *message, vtkSMProxyLocator *locator) override
 Called to load state from protobuf message. More...
 
virtual void UpdateState ()
 Although this class is a proxy, it's not really a proxy in the traditional sense. More...
 
int GetEmptyCell (int root)
 Starting with the cell-index, tries to find an empty cell in the sub-tree. More...
 
int GetSplittableCell (int root, Direction &suggested_direction)
 Starting with the root, finds a splittable cell. More...
 
- 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...
 
virtual void CreateVTKObjects ()
 Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs), this methods instantiates the objects on the server(s) 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...
 
vtkSMProxyGetSubProxy (const char *name)
 Returns a sub-proxy. More...
 
vtkSMProxyGetSubProxy (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...
 
vtkSMPropertyGroupNewPropertyGroup (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 vtkClientServerStreamGetLastResult ()
 Get the last result. More...
 
virtual const vtkClientServerStreamGetLastResult (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...
 
vtkSMPropertyNewProperty (const char *name)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
vtkSMPropertyNewProperty (const char *name, vtkPVXMLElement *propElement)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
virtual int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element)
 Read attributes from an 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

int MaximizedCell
 
- 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...
 
vtkPVXMLElementXMLElement
 
vtkSMDocumentationDocumentation
 
vtkPVXMLElementHints
 
vtkPVXMLElementDeprecated
 
vtkSMMessageState
 
int InMarkModified
 
vtkWeakPointer< vtkSMProxyParentProxy
 
vtkSMProxyInternalsInternals
 
vtkSMProxyObserverSubProxyObserver
 
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< vtkSMSessionSession
 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
 

Detailed Description

vtkSMViewLayoutProxy is used by ParaView to layout multiple views in a 2D KD-Tree layout.

vtkSMViewLayoutProxy is used by ParaView to layout multiple views in a 2D KD-Tree layout. This is proxy, hence can be registered with the proxy manager just like other regular proxies; participates in xml state saving/restoring, undo-redo, etc. Users can affects the GUI layout using this proxy instance from Python as well.

Every time the vtkSMViewLayoutProxy changes so that it would affect the UI, this class fires vtkCommand::ConfigureEvent.

View proxies that are to laid out in an layout should be "assigned" to a particular cell in a vtkSMViewLayoutProxy instance. vtkSMViewLayoutProxy takes over the responsibility of updating the view's Position property correctly.

Although, currently, there are no safe guards against assigning a view to more than one layout, this is strictly prohibited and can cause unexpected problems at run-time.

Definition at line 51 of file vtkSMViewLayoutProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 of file vtkSMViewLayoutProxy.h.

Member Enumeration Documentation

◆ Direction

Enumerator
NONE 
VERTICAL 
HORIZONTAL 

Definition at line 58 of file vtkSMViewLayoutProxy.h.

Constructor & Destructor Documentation

◆ vtkSMViewLayoutProxy()

vtkSMViewLayoutProxy::vtkSMViewLayoutProxy ( )
protected

◆ ~vtkSMViewLayoutProxy()

vtkSMViewLayoutProxy::~vtkSMViewLayoutProxy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMViewLayoutProxy* vtkSMViewLayoutProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMViewLayoutProxy::GetClassName ( )
virtual

Reimplemented from vtkSMProxy.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMProxy.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMViewLayoutProxy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMProxy.

◆ Split()

int vtkSMViewLayoutProxy::Split ( int  location,
int  direction,
double  fraction 
)

Split a frame at the given location.

Location must point to an existing cell that's not split. If the location does not exist or is already split, then returns -1, to indicate failure. Otherwise returns the index of the left (or top) child node. The index for the sibling can be computed as (ret_val + 1). fraction indicates a value in the range [0.0, 1.0] at which the cell is split. If a View is set at the given location, it will be moved to the left (or top) child after the split.

◆ SplitVertical()

int vtkSMViewLayoutProxy::SplitVertical ( int  location,
double  fraction 
)
inline

Definition at line 75 of file vtkSMViewLayoutProxy.h.

◆ SplitHorizontal()

int vtkSMViewLayoutProxy::SplitHorizontal ( int  location,
double  fraction 
)
inline

Definition at line 79 of file vtkSMViewLayoutProxy.h.

◆ AssignView()

bool vtkSMViewLayoutProxy::AssignView ( int  location,
vtkSMViewProxy view 
)

Assign a view at a particular location.

Note that the view's position may be changed by Split() calls. Returns true on success.

◆ AssignViewToAnyCell()

int vtkSMViewLayoutProxy::AssignViewToAnyCell ( vtkSMViewProxy view,
int  location_hint 
)

Similar to AssignView() except that is location specified is not available, then this method treats the location merely as a hint and tries to find a suitable place.

First, if any empty cell is available, then that is used. Second, if no empty cell is available and location is a valid cell, then we either split the cell or traverse down the sub-tree from the cell and split a cell to make room for the view. Thus, this method will always assign the view to a frame. Returns the assigned location.

◆ RemoveView() [1/2]

int vtkSMViewLayoutProxy::RemoveView ( vtkSMViewProxy view)

Removes a view.

Returns the location of the cell emptied by the view, if any, otherwise -1.

◆ RemoveView() [2/2]

bool vtkSMViewLayoutProxy::RemoveView ( int  index)

Removes a view.

Returns the location of the cell emptied by the view, if any, otherwise -1.

◆ Collapse()

bool vtkSMViewLayoutProxy::Collapse ( int  location)

Collapses a cell.

Only leaf cells without any assigned views can be collapsed. If the cell has a sibling, then that sibling is assigned to the parent node and the sibling cell is destroyed as well. Returns true on success, else false.

◆ SwapCells()

bool vtkSMViewLayoutProxy::SwapCells ( int  location1,
int  location2 
)

Swaps the cells at the two locations.

Both locations must be leaf locations i.e. cannot be split-cells.

◆ SetSplitFraction()

bool vtkSMViewLayoutProxy::SetSplitFraction ( int  location,
double  fraction 
)

Update the split fraction for a split cell.

If IsSplitCell(location) returns false, this method does not update the fraction.

◆ MaximizeCell()

bool vtkSMViewLayoutProxy::MaximizeCell ( int  location)

One can maximize a particular (non-split) cell.

Note the maximized state is restored as soon as the layout is changed or when RestoreMaximizedState() is called. Returns false if the cell at the location cannot be maximized since it's a split cell or invalid cell, true otherwise.

◆ RestoreMaximizedState()

void vtkSMViewLayoutProxy::RestoreMaximizedState ( )

Restores the maximized state.

◆ GetMaximizedCell()

virtual int vtkSMViewLayoutProxy::GetMaximizedCell ( )
virtual

Returns the maximized cell, if any.

Returns -1 if no cell is currently maximized.

◆ IsSplitCell()

bool vtkSMViewLayoutProxy::IsSplitCell ( int  location)

Returns true if the cell identified by the location is a split cell.

◆ GetSplitDirection()

Direction vtkSMViewLayoutProxy::GetSplitDirection ( int  location)

Returns the split direction for a split cell at the given location.

◆ GetSplitFraction()

double vtkSMViewLayoutProxy::GetSplitFraction ( int  location)

Returns the split-fraction for a split cell at the given location.

◆ GetFirstChild()

static int vtkSMViewLayoutProxy::GetFirstChild ( int  location)
inlinestatic

Returns the index for the first child of the given location.

This does not do any validity checks for the location, nor that of the child.

Definition at line 170 of file vtkSMViewLayoutProxy.h.

◆ GetSecondChild()

static int vtkSMViewLayoutProxy::GetSecondChild ( int  location)
inlinestatic

Returns the index for the second child of the given location.

This does not do any validity checks for the location, nor that of the child.

Definition at line 176 of file vtkSMViewLayoutProxy.h.

◆ GetParent()

static int vtkSMViewLayoutProxy::GetParent ( int  location)
inlinestatic

Returns the parent index.

Definition at line 181 of file vtkSMViewLayoutProxy.h.

◆ GetView()

vtkSMViewProxy* vtkSMViewLayoutProxy::GetView ( int  location)

Returns the view, if any, assigned to the given cell location.

◆ GetViewLocation()

int vtkSMViewLayoutProxy::GetViewLocation ( vtkSMViewProxy )

Returns the location for the view, of any.

Returns -1 if the view is not found.

◆ ContainsView() [1/2]

bool vtkSMViewLayoutProxy::ContainsView ( vtkSMViewProxy view)
inline

Returns if a view is contained in this layout.

Definition at line 198 of file vtkSMViewLayoutProxy.h.

◆ ContainsView() [2/2]

bool vtkSMViewLayoutProxy::ContainsView ( vtkSMProxy view)

Returns if a view is contained in this layout.

◆ UpdateViewPositions()

void vtkSMViewLayoutProxy::UpdateViewPositions ( )

Updates positions for all views using the layout and current sizes.

This method is called automatically when the layout changes or the "ViewSize" property on the assigned views changes.

◆ ShowViewsOnTileDisplay()

void vtkSMViewLayoutProxy::ShowViewsOnTileDisplay ( )

When in tile-display configuration, only 1 view-layout is shown on the tile-display (for obvious reasons).

To show any particular layout on the tile display, simply call this method.

◆ CaptureWindow() [1/2]

vtkImageData* vtkSMViewLayoutProxy::CaptureWindow ( int  magnification)
inline

Captures an image from the layout (including all the views in the layout.

Definition at line 220 of file vtkSMViewLayoutProxy.h.

◆ CaptureWindow() [2/2]

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

Captures an image from the layout (including all the views in the layout.

◆ SaveXMLState() [1/2]

vtkPVXMLElement* vtkSMViewLayoutProxy::SaveXMLState ( vtkPVXMLElement root)
inlineoverridevirtual

Overridden to save custom XML state.

Reimplemented from vtkSMProxy.

Definition at line 230 of file vtkSMViewLayoutProxy.h.

◆ SaveXMLState() [2/2]

vtkPVXMLElement* vtkSMViewLayoutProxy::SaveXMLState ( vtkPVXMLElement root,
vtkSMPropertyIterator iter 
)
overridevirtual

The iterator is use to filter the property available on the given proxy.

Reimplemented from vtkSMProxy.

◆ LoadXMLState()

int vtkSMViewLayoutProxy::LoadXMLState ( vtkPVXMLElement element,
vtkSMProxyLocator locator 
)
overridevirtual

Overridden to load custom XML state.

Reimplemented from vtkSMProxy.

◆ Reset()

void vtkSMViewLayoutProxy::Reset ( )

Resets the layout.

◆ GetLayoutExtent()

void vtkSMViewLayoutProxy::GetLayoutExtent ( int  extent[4])

Returns the extents for all views in the layout.

◆ SetSize() [1/2]

void vtkSMViewLayoutProxy::SetSize ( const int  size[2])

Update the size for all the views in the layout assuming the new size provided for the whole layout.

This resizes and repositions each view based the recursive split ratios for all the cells in the layout.

◆ SetSize() [2/2]

void vtkSMViewLayoutProxy::SetSize ( int  width,
int  height 
)
inline

Update the size for all the views in the layout assuming the new size provided for the whole layout.

This resizes and repositions each view based the recursive split ratios for all the cells in the layout.

Definition at line 258 of file vtkSMViewLayoutProxy.h.

◆ GetSize()

vtkVector2i vtkSMViewLayoutProxy::GetSize ( )
inline

Returns the current size.

Definition at line 268 of file vtkSMViewLayoutProxy.h.

◆ FindLayout()

static vtkSMViewLayoutProxy* vtkSMViewLayoutProxy::FindLayout ( vtkSMViewProxy ,
const char *  reggroup = "layouts" 
)
static

Helper method to locate a layout, if any that contains the specified view proxy.

◆ GetViews()

std::vector<vtkSMViewProxy*> vtkSMViewLayoutProxy::GetViews ( )

Returns a vector of the view proxies added to his layout.

◆ SaveAsPNG()

void vtkSMViewLayoutProxy::SaveAsPNG ( int  rank,
const char *  fname 
)

This is only meant for testing and debugging purposes.

This allows the application to save the image rendered on the server side in certain configurations (tile display and cave) to a png file for regression testing.

◆ LoadState()

void vtkSMViewLayoutProxy::LoadState ( const vtkSMMessage message,
vtkSMProxyLocator locator 
)
overrideprotectedvirtual

Called to load state from protobuf message.

Reimplemented from vtkSMProxy.

◆ UpdateState()

virtual void vtkSMViewLayoutProxy::UpdateState ( )
protectedvirtual

Although this class is a proxy, it's not really a proxy in the traditional sense.

So instead of using UpdateVTKObjects() to push state changes to the server (or undo-redo stack), this new method is provided.

◆ GetEmptyCell()

int vtkSMViewLayoutProxy::GetEmptyCell ( int  root)
protected

Starting with the cell-index, tries to find an empty cell in the sub-tree.

Returns -1 if none found. May return root, if root is indeed an empty cell. Note this assumes that root is valid.

◆ GetSplittableCell()

int vtkSMViewLayoutProxy::GetSplittableCell ( int  root,
Direction suggested_direction 
)
protected

Starting with the root, finds a splittable cell.

Assumes root is valid.

Member Data Documentation

◆ MaximizedCell

int vtkSMViewLayoutProxy::MaximizedCell
protected

Definition at line 324 of file vtkSMViewLayoutProxy.h.


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