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

implementation for View that includes render window and renderers. More...

#include <vtkSMRenderViewProxy.h>

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

Public Types

typedef vtkSMViewProxy Superclass
 
- Public Types inherited from vtkSMViewProxy
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
 
vtkSMRepresentationProxyPick (int x, int y)
 Convenience method to pick a location. More...
 
vtkSMRepresentationProxyPickBlock (int x, int y, unsigned int &flatIndex)
 Convenience method to pick a block in a multi-block data set. More...
 
bool ConvertDisplayToPointOnSurface (const int display_position[2], double world_position[3], bool snapOnMeshPoint=false)
 Given a location is display coordinates (pixels), tries to compute and return the world location on a surface, if possible. More...
 
virtual bool IsSelectionAvailable ()
 Checks if color depth is sufficient to support selection. More...
 
virtual void ZoomTo (vtkSMProxy *representation)
 Convenience method for zooming to a representation. More...
 
void SetupInteractor (vtkRenderWindowInteractor *iren) override
 A client process need to set the interactor to enable interactivity. More...
 
vtkRenderWindowInteractorGetInteractor () override
 Returns the interactor. More...
 
vtkRendererGetRenderer ()
 Returns the client-side renderer (composited or 3D). More...
 
vtkCameraGetActiveCamera ()
 Returns the client-side camera object. More...
 
void SynchronizeCameraProperties ()
 This method calls UpdateInformation on the Camera Proxy and sets the Camera properties according to the info properties. More...
 
virtual bool LastRenderWasInteractive ()
 Returns true if the most recent render indeed employed low-res rendering. More...
 
void Update () override
 Called vtkPVView::Update on the server-side. More...
 
bool GetNeedsUpdate () override
 We override that method to handle LOD and non-LOD NeedsUpdate in transparent manner. More...
 
bool StreamingUpdate (bool render_if_needed)
 Called to render a streaming pass. More...
 
const char * GetRepresentationType (vtkSMSourceProxy *producer, int outputPort) override
 Overridden to check through the various representations that this view can create. More...
 
vtkRenderWindowGetRenderWindow () override
 Returns the render window used by this view. More...
 
vtkSMViewProxyInteractorHelperGetInteractorHelper ()
 Provides access to the vtkSMViewProxyInteractorHelper object that handles the interaction/view sync. More...
 
vtkFloatArrayCaptureDepthBuffer ()
 Access to the Z buffer. More...
 
vtkFloatArrayGetValuesFloat ()
 Access to value-rendered array. More...
 
bool SelectSurfaceCells (const int region[4], vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections=false, int modifier=0, bool select_blocks=false, const char *arrayName=nullptr)
 Makes a new selection source proxy. More...
 
bool SelectSurfacePoints (const int region[4], vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections=false, int modifier=0, bool select_blocks=false, const char *arrayName=nullptr)
 Makes a new selection source proxy. More...
 
bool SelectFrustumCells (const int region[4], vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections=false)
 Makes a new selection source proxy. More...
 
bool SelectFrustumPoints (const int region[4], vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections=false)
 Makes a new selection source proxy. More...
 
bool SelectPolygonPoints (vtkIntArray *polygon, vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections=false)
 Makes a new selection source proxy. More...
 
bool SelectPolygonCells (vtkIntArray *polygon, vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections=false)
 Makes a new selection source proxy. More...
 
bool ComputeVisibleScalarRange (const int region[4], int fieldAssociation, const char *scalarName, int component, double range[])
 Returns the range for visible elements in the current view. More...
 
bool ComputeVisibleScalarRange (int fieldAssociation, const char *scalarName, int component, double range[])
 Returns the range for visible elements in the current view. More...
 
void ResetCamera ()
 For backwards compatibility in Python scripts. More...
 
void ResetCamera (double bounds[6])
 For backwards compatibility in Python scripts. More...
 
void ResetCamera (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 For backwards compatibility in Python scripts. More...
 
virtual const char * IsSelectVisibleCellsAvailable ()
 Similar to IsSelectionAvailable(), however, on failure returns the error message otherwise 0. More...
 
virtual const char * IsSelectVisiblePointsAvailable ()
 Similar to IsSelectionAvailable(), however, on failure returns the error message otherwise 0. More...
 
void StartCaptureValues ()
 Value raster capture controls. More...
 
void StopCaptureValues ()
 Value raster capture controls. More...
 
int GetValueRenderingMode ()
 Access to the current vtkValuePass rendering mode. More...
 
void SetValueRenderingMode (int mode)
 Value raster capture controls. More...
 
- Public Member Functions inherited from vtkSMViewProxy
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 bool CanDisplayData (vtkSMSourceProxy *producer, int outputPort)
 Returns true if the view can display the data produced by the producer's port. More...
 
virtual vtkSMRepresentationProxyCreateDefaultRepresentation (vtkSMProxy *, int)
 Create a default representation for the given source proxy. More...
 
virtual vtkSMRepresentationProxyFindRepresentation (vtkSMSourceProxy *producer, int outputPort)
 Finds the representation proxy showing the data produced by the provided producer, if any. More...
 
vtkViewGetClientSideView ()
 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 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...
 
vtkImageDataCaptureWindow (int magnification)
 Captures a image from this view. More...
 
vtkImageDataCaptureWindow (int magnificationX, int magnificationY)
 Captures a image from this view. More...
 
virtual bool HideOtherRepresentationsIfNeeded (vtkSMProxy *repr)
 Method used to hide other representations if the view has a <ShowOneRepresentationAtATime/> hint. 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...
 
- 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...
 
vtkObjectBaseGetClientSideObject ()
 Returns the client side object associated with the VTKObjectID (if any). More...
 
virtual vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root)
 Saves the state of the proxy. More...
 
virtual vtkPVXMLElementSaveXMLState (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...
 
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...
 
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...
 
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 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 vtkSMRenderViewProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMRenderViewProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMViewProxy
static vtkSMViewProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMViewProxySafeDownCast (vtkObject *o)
 
static vtkSMViewProxyFindView (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 bool HideOtherRepresentationsIfNeeded (vtkSMViewProxy *self, 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...
 
- 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

 vtkSMRenderViewProxy ()
 
 ~vtkSMRenderViewProxy () override
 
void RenderForImageCapture () override
 Overridden to call this->InteractiveRender() if "UseInteractiveRenderingForScreenshots" is true. More...
 
void UpdateLOD ()
 Calls UpdateLOD() on the vtkPVRenderView. More...
 
void MarkDirty (vtkSMProxy *modifiedProxy) override
 Overridden to ensure that we clean up the selection cache on the server side. More...
 
bool SelectFrustumInternal (const int region[4], vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections, int fieldAssociation)
 
bool SelectPolygonInternal (vtkIntArray *polygon, vtkCollection *selectedRepresentations, vtkCollection *selectionSources, bool multiple_selections, int fieldAssociation)
 
vtkTypeUInt32 PreRender (bool interactive) override
 
void PostRender (bool interactive) override
 
bool FetchLastSelection (bool multiple_selections, vtkCollection *selectedRepresentations, vtkCollection *selectionSources, int modifier, bool selectBlocks)
 Fetches the LastSelection from the data-server and then converts it to a selection source proxy and returns that. More...
 
void CreateVTKObjects () override
 Called at the end of CreateVTKObjects(). More...
 
bool IsInSelectionMode ()
 Returns true if the proxy is in interaction mode that corresponds to making a selection i.e. More...
 
void ClearSelectionCache (bool force=false)
 
void NewMasterCallback (vtkObject *src, unsigned long event, void *data)
 
- Protected Member Functions inherited from vtkSMViewProxy
 vtkSMViewProxy ()
 
 ~vtkSMViewProxy () override
 
virtual vtkImageDataCaptureWindowInternal (int magnificationX, int magnificationY)
 Capture an image from the view's render window. 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 vtkSMDataDeliveryManagerProxyGetDeliveryManager ()
 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...
 
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...
 
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=NULL)
 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...
 
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

bool IsSelectionCached
 
unsigned long NewMasterObserverId
 
bool NeedsUpdateLOD
 
- Protected Attributes inherited from vtkSMViewProxy
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...
 
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

implementation for View that includes render window and renderers.

vtkSMRenderViewProxy is a 3D view consisting for a render window and two renderers: 1 for 3D geometry and 1 for overlaid 2D geometry.

Definition at line 39 of file vtkSMRenderViewProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkSMRenderViewProxy.h.

Constructor & Destructor Documentation

◆ vtkSMRenderViewProxy()

vtkSMRenderViewProxy::vtkSMRenderViewProxy ( )
protected

◆ ~vtkSMRenderViewProxy()

vtkSMRenderViewProxy::~vtkSMRenderViewProxy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMRenderViewProxy* vtkSMRenderViewProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMRenderViewProxy::GetClassName ( )
virtual

Reimplemented from vtkSMViewProxy.

Reimplemented in vtkSMMultiSliceViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMViewProxy.

Reimplemented in vtkSMMultiSliceViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkSMProxy.

◆ SelectSurfaceCells()

bool vtkSMRenderViewProxy::SelectSurfaceCells ( const int  region[4],
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections = false,
int  modifier = 0,
bool  select_blocks = false,
const char *  arrayName = nullptr 
)

Makes a new selection source proxy.

◆ SelectSurfacePoints()

bool vtkSMRenderViewProxy::SelectSurfacePoints ( const int  region[4],
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections = false,
int  modifier = 0,
bool  select_blocks = false,
const char *  arrayName = nullptr 
)

Makes a new selection source proxy.

◆ SelectFrustumCells()

bool vtkSMRenderViewProxy::SelectFrustumCells ( const int  region[4],
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections = false 
)

Makes a new selection source proxy.

◆ SelectFrustumPoints()

bool vtkSMRenderViewProxy::SelectFrustumPoints ( const int  region[4],
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections = false 
)

Makes a new selection source proxy.

◆ SelectPolygonPoints()

bool vtkSMRenderViewProxy::SelectPolygonPoints ( vtkIntArray polygon,
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections = false 
)

Makes a new selection source proxy.

◆ SelectPolygonCells()

bool vtkSMRenderViewProxy::SelectPolygonCells ( vtkIntArray polygon,
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections = false 
)

Makes a new selection source proxy.

◆ ComputeVisibleScalarRange() [1/2]

bool vtkSMRenderViewProxy::ComputeVisibleScalarRange ( const int  region[4],
int  fieldAssociation,
const char *  scalarName,
int  component,
double  range[] 
)

Returns the range for visible elements in the current view.

◆ ComputeVisibleScalarRange() [2/2]

bool vtkSMRenderViewProxy::ComputeVisibleScalarRange ( int  fieldAssociation,
const char *  scalarName,
int  component,
double  range[] 
)

Returns the range for visible elements in the current view.

◆ Pick()

vtkSMRepresentationProxy* vtkSMRenderViewProxy::Pick ( int  x,
int  y 
)

Convenience method to pick a location.

Internally uses SelectSurfaceCells to locate the picked object. In future, we can make this faster.

◆ PickBlock()

vtkSMRepresentationProxy* vtkSMRenderViewProxy::PickBlock ( int  x,
int  y,
unsigned int flatIndex 
)

Convenience method to pick a block in a multi-block data set.

Will return the selected representation. Furthermore, if it is a multi-block data set the flat index of the selected block will be returned in flatIndex.

◆ ConvertDisplayToPointOnSurface()

bool vtkSMRenderViewProxy::ConvertDisplayToPointOnSurface ( const int  display_position[2],
double  world_position[3],
bool  snapOnMeshPoint = false 
)

Given a location is display coordinates (pixels), tries to compute and return the world location on a surface, if possible.

Returns true if the conversion was successful, else returns false. If Snap on mesh point is true, it will return a point from the mesh only

◆ IsSelectionAvailable()

virtual bool vtkSMRenderViewProxy::IsSelectionAvailable ( )
virtual

Checks if color depth is sufficient to support selection.

If not, will return 0 and any calls to SelectVisibleCells will quietly return an empty selection.

◆ ResetCamera() [1/3]

void vtkSMRenderViewProxy::ResetCamera ( )

For backwards compatibility in Python scripts.

◆ ResetCamera() [2/3]

void vtkSMRenderViewProxy::ResetCamera ( double  bounds[6])

For backwards compatibility in Python scripts.

◆ ResetCamera() [3/3]

void vtkSMRenderViewProxy::ResetCamera ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

For backwards compatibility in Python scripts.

◆ ZoomTo()

virtual void vtkSMRenderViewProxy::ZoomTo ( vtkSMProxy representation)
virtual

Convenience method for zooming to a representation.

◆ IsSelectVisibleCellsAvailable()

virtual const char* vtkSMRenderViewProxy::IsSelectVisibleCellsAvailable ( )
virtual

Similar to IsSelectionAvailable(), however, on failure returns the error message otherwise 0.

◆ IsSelectVisiblePointsAvailable()

virtual const char* vtkSMRenderViewProxy::IsSelectVisiblePointsAvailable ( )
virtual

Similar to IsSelectionAvailable(), however, on failure returns the error message otherwise 0.

Reimplemented in vtkSMMultiSliceViewProxy.

◆ SetupInteractor()

void vtkSMRenderViewProxy::SetupInteractor ( vtkRenderWindowInteractor iren)
overridevirtual

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.

Reimplemented from vtkSMViewProxy.

◆ GetInteractor()

vtkRenderWindowInteractor* vtkSMRenderViewProxy::GetInteractor ( )
overridevirtual

Returns the interactor.

Reimplemented from vtkSMViewProxy.

◆ GetRenderer()

vtkRenderer* vtkSMRenderViewProxy::GetRenderer ( )

Returns the client-side renderer (composited or 3D).

◆ GetActiveCamera()

vtkCamera* vtkSMRenderViewProxy::GetActiveCamera ( )

Returns the client-side camera object.

◆ SynchronizeCameraProperties()

void vtkSMRenderViewProxy::SynchronizeCameraProperties ( )

This method calls UpdateInformation on the Camera Proxy and sets the Camera properties according to the info properties.

This approach is a bit lame. We need to ensure that camera properties are always/automatically synchronized. Camera properties cannot be treated same way as other properties.

◆ LastRenderWasInteractive()

virtual bool vtkSMRenderViewProxy::LastRenderWasInteractive ( )
virtual

Returns true if the most recent render indeed employed low-res rendering.

◆ Update()

void vtkSMRenderViewProxy::Update ( )
overridevirtual

Called vtkPVView::Update on the server-side.

Overridden to update the state of NeedsUpdateLOD flag.

Reimplemented from vtkSMViewProxy.

◆ GetNeedsUpdate()

bool vtkSMRenderViewProxy::GetNeedsUpdate ( )
overridevirtual

We override that method to handle LOD and non-LOD NeedsUpdate in transparent manner.

Reimplemented from vtkSMViewProxy.

◆ StreamingUpdate()

bool vtkSMRenderViewProxy::StreamingUpdate ( bool  render_if_needed)

Called to render a streaming pass.

Returns true if the view "streamed" some geometry.

◆ GetRepresentationType()

const char* vtkSMRenderViewProxy::GetRepresentationType ( vtkSMSourceProxy producer,
int  outputPort 
)
overridevirtual

Overridden to check through the various representations that this view can create.

Reimplemented from vtkSMViewProxy.

◆ GetRenderWindow()

vtkRenderWindow* vtkSMRenderViewProxy::GetRenderWindow ( )
overridevirtual

Returns the render window used by this view.

Reimplemented from vtkSMViewProxy.

◆ GetInteractorHelper()

vtkSMViewProxyInteractorHelper* vtkSMRenderViewProxy::GetInteractorHelper ( )

Provides access to the vtkSMViewProxyInteractorHelper object that handles the interaction/view sync.

We provide access to it for applications to monitor timer events etc.

◆ CaptureDepthBuffer()

vtkFloatArray* vtkSMRenderViewProxy::CaptureDepthBuffer ( )

Access to the Z buffer.

◆ GetValuesFloat()

vtkFloatArray* vtkSMRenderViewProxy::GetValuesFloat ( )

Access to value-rendered array.

Used for deferred color mapping during in-situ visualization (Cinema).

◆ StartCaptureValues()

void vtkSMRenderViewProxy::StartCaptureValues ( )

Value raster capture controls.

◆ StopCaptureValues()

void vtkSMRenderViewProxy::StopCaptureValues ( )

Value raster capture controls.

◆ GetValueRenderingMode()

int vtkSMRenderViewProxy::GetValueRenderingMode ( )

Access to the current vtkValuePass rendering mode.

◆ SetValueRenderingMode()

void vtkSMRenderViewProxy::SetValueRenderingMode ( int  mode)

Value raster capture controls.

◆ RenderForImageCapture()

void vtkSMRenderViewProxy::RenderForImageCapture ( )
overrideprotectedvirtual

Overridden to call this->InteractiveRender() if "UseInteractiveRenderingForScreenshots" is true.

Reimplemented from vtkSMViewProxy.

◆ UpdateLOD()

void vtkSMRenderViewProxy::UpdateLOD ( )
protected

◆ MarkDirty()

void vtkSMRenderViewProxy::MarkDirty ( vtkSMProxy modifiedProxy)
overrideprotectedvirtual

Overridden to ensure that we clean up the selection cache on the server side.

Reimplemented from vtkSMProxy.

◆ SelectFrustumInternal()

bool vtkSMRenderViewProxy::SelectFrustumInternal ( const int  region[4],
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections,
int  fieldAssociation 
)
protected

◆ SelectPolygonInternal()

bool vtkSMRenderViewProxy::SelectPolygonInternal ( vtkIntArray polygon,
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
bool  multiple_selections,
int  fieldAssociation 
)
protected

◆ PreRender()

vtkTypeUInt32 vtkSMRenderViewProxy::PreRender ( bool  interactive)
overrideprotected

◆ PostRender()

void vtkSMRenderViewProxy::PostRender ( bool  interactive)
overrideprotected

◆ FetchLastSelection()

bool vtkSMRenderViewProxy::FetchLastSelection ( bool  multiple_selections,
vtkCollection selectedRepresentations,
vtkCollection selectionSources,
int  modifier,
bool  selectBlocks 
)
protected

Fetches the LastSelection from the data-server and then converts it to a selection source proxy and returns that.

◆ CreateVTKObjects()

void vtkSMRenderViewProxy::CreateVTKObjects ( )
overrideprotectedvirtual

Called at the end of CreateVTKObjects().

Reimplemented from vtkSMProxy.

◆ IsInSelectionMode()

bool vtkSMRenderViewProxy::IsInSelectionMode ( )
protected

Returns true if the proxy is in interaction mode that corresponds to making a selection i.e.

vtkPVRenderView::INTERACTION_MODE_POLYGON or vtkPVRenderView::INTERACTION_MODE_SELECTION.

◆ ClearSelectionCache()

void vtkSMRenderViewProxy::ClearSelectionCache ( bool  force = false)
protected

◆ NewMasterCallback()

void vtkSMRenderViewProxy::NewMasterCallback ( vtkObject src,
unsigned long  event,
void *  data 
)
protected

Member Data Documentation

◆ IsSelectionCached

bool vtkSMRenderViewProxy::IsSelectionCached
protected

Definition at line 275 of file vtkSMRenderViewProxy.h.

◆ NewMasterObserverId

unsigned long vtkSMRenderViewProxy::NewMasterObserverId
protected

Definition at line 280 of file vtkSMRenderViewProxy.h.

◆ NeedsUpdateLOD

bool vtkSMRenderViewProxy::NeedsUpdateLOD
protected

Definition at line 283 of file vtkSMRenderViewProxy.h.


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