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

Render View for ParaView. More...

#include <vtkPVRenderView.h>

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

Public Types

enum  InteractionModes {
  INTERACTION_MODE_UNINTIALIZED = -1, INTERACTION_MODE_3D = 0, INTERACTION_MODE_2D, INTERACTION_MODE_SELECTION,
  INTERACTION_MODE_ZOOM, INTERACTION_MODE_POLYGON
}
 
enum  { DEFAULT_RENDERER = 0, NON_COMPOSITED_RENDERER = 1 }
 Defines various renderer types. More...
 
typedef vtkPVView Superclass
 
- Public Types inherited from vtkPVView
typedef vtkView Superclass
 
- Public Types inherited from vtkView
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual vtkRendererGetRenderer (int rendererType=DEFAULT_RENDERER)
 Returns the renderer given an int identifying its type. More...
 
vtkRenderWindowInteractorGetInteractor ()
 Returns the interactor. More...
 
virtual void SetupInteractor (vtkRenderWindowInteractor *)
 Set the interactor. More...
 
void StillRender () override
 Triggers a high-resolution render. More...
 
void InteractiveRender () override
 Triggers a interactive render. More...
 
void ConfigureCompressor (const char *configuration)
 Passes the compressor configuration to the client-server synchronizer, if any. More...
 
virtual void ResetCameraClippingRange ()
 Resets the clipping range. More...
 
void InvalidateCachedSelection ()
 Invalidates cached selection. More...
 
void SetMaxClipBounds (double bds[6])
 Used by Cinema to enforce a consistent depth scaling. More...
 
virtual void SetGridAxes3DActor (vtkPVGridAxes3DActor *)
 Set the vtkPVGridAxes3DActor to use for the view. More...
 
virtual void SetOrientationAxesInteractivity (bool)
 
virtual void SetOrientationAxesVisibility (bool)
 
void SetOrientationAxesLabelColor (double r, double g, double b)
 
void SetOrientationAxesOutlineColor (double r, double g, double b)
 
virtual void SetCenterAxesVisibility (bool)
 
virtual void SetCenterOfRotation (double x, double y, double z)
 
virtual void SetRotationFactor (double factor)
 
void SetKeyLightWarmth (double val)
 
void SetKeyLightIntensity (double val)
 
void SetKeyLightElevation (double val)
 
void SetKeyLightAzimuth (double val)
 
void SetFillLightWarmth (double val)
 
void SetKeyToFillRatio (double val)
 
void SetFillLightElevation (double val)
 
void SetFillLightAzimuth (double val)
 
void SetBackLightWarmth (double val)
 
void SetKeyToBackRatio (double val)
 
void SetBackLightElevation (double val)
 
void SetBackLightAzimuth (double val)
 
void SetHeadLightWarmth (double val)
 
void SetKeyToHeadRatio (double val)
 
void SetMaintainLuminance (int val)
 
virtual void SetUseHiddenLineRemoval (bool)
 
virtual void SetUseDepthPeeling (int val)
 
virtual void SetUseDepthPeelingForVolumes (bool val)
 
virtual void SetMaximumNumberOfPeels (int val)
 
virtual void SetBackground (double r, double g, double b)
 
virtual void SetBackground2 (double r, double g, double b)
 
virtual void SetBackgroundTexture (vtkTexture *val)
 
virtual void SetGradientBackground (int val)
 
virtual void SetTexturedBackground (int val)
 
virtual void SetSkyboxBackground (int val)
 
virtual void SetUseEnvironmentLighting (bool val)
 
virtual void SetEnvironmentalBG (double r, double g, double b)
 
virtual void SetEnvironmentalBG2 (double r, double g, double b)
 
virtual void SetEnvironmentalBGTexture (vtkTexture *val)
 
virtual void SetGradientEnvironmentalBG (int val)
 
virtual void SetTexturedEnvironmentalBG (int val)
 
virtual void SetBackgroundMode (int val)
 
void AddLight (vtkLight *)
 
void RemoveLight (vtkLight *)
 
void SetStereoCapableWindow (int val)
 
void SetStereoRender (int val)
 
virtual void SetStereoType (int)
 
virtual void SetServerStereoType (int)
 
void SetMultiSamples (int val)
 
void SetAlphaBitPlanes (int val)
 
void SetStencilCapable (int val)
 
void SetParallelProjection (int mode)
 
virtual void SetCamera2DManipulators (const int manipulators[9])
 
virtual void SetCamera3DManipulators (const int manipulators[9])
 
void SetCameraManipulators (vtkPVInteractorStyle *style, const int manipulators[9])
 
virtual void SetCamera2DMouseWheelMotionFactor (double factor)
 
virtual void SetCamera3DMouseWheelMotionFactor (double factor)
 
void Update () override
 Overridden to synchronize information among processes whenever data changes. More...
 
virtual void UpdateLOD ()
 Asks representations to update their LOD geometries. More...
 
int GetDataDistributionMode (bool low_res)
 Returns the data distribution mode to use. More...
 
void Deliver (int use_lod, unsigned int size, unsigned int *representation_ids) override
 Called on all processes to request data-delivery for the list of representations. More...
 
bool GetUseOrderedCompositing ()
 Returns true when ordered compositing is needed on the current group of processes. More...
 
bool GetRenderEmptyImages ()
 Returns true when the compositor should not use the empty images optimization. More...
 
void CopyViewUpdateOptions (vtkPVRenderView *otherView)
 Copy internal fields that are used for rendering decision such as remote/local rendering, composite and so on. More...
 
bool GetOSPRayContinueStreaming ()
 Has OSPRay reached the max frames? More...
 
void SetOSPRayRendererType (std::string)
 Set the OSPRay renderer to use. More...
 
virtual void SetMaterialLibrary (vtkPVMaterialLibrary *)
 For OSPRay, set the library of materials. More...
 
void SetViewTime (double value) override
 Get/Set the time this view is showing. More...
 
virtual vtkRenderViewBaseGetRenderView ()
 
void ScaleRendererViewports (const double viewport[4]) override
 Overridden to scale the OrientationWidget appropriately. More...
 
void SynchronizeMaximumIds (vtkIdType *maxPointId, vtkIdType *maxCellId)
 This is used by vtkPVHardwareSelector to synchronize element ids between all ranks involved in selection. More...
 
virtual void SetInteractionMode (int mode)
 Get/Set the interaction mode. More...
 
virtual int GetInteractionMode ()
 Get/Set the interaction mode. More...
 
void SetSize (int, int) override
 Overridden to call InvalidateCachedSelection() whenever the render window parameters change. More...
 
void SetPosition (int, int) override
 Overridden to call InvalidateCachedSelection() whenever the render window parameters change. More...
 
virtual vtkRendererGetNonCompositedRenderer ()
 Gets the non-composited renderer for this view. More...
 
vtkCameraGetActiveCamera ()
 Get/Set the active camera. More...
 
virtual void SetActiveCamera (vtkCamera *)
 Get/Set the active camera. More...
 
virtual vtkPVInteractorStyleGetInteractorStyle ()
 Returns the interactor style. More...
 
void ResetCamera ()
 Resets the active camera using collective prop-bounds. More...
 
void ResetCamera (double bounds[6])
 Resets the active camera using collective prop-bounds. More...
 
virtual void SetSuppressRendering (bool)
 SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender. More...
 
virtual bool GetSuppressRendering ()
 SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender. More...
 
virtual void SuppressRenderingOn ()
 SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender. More...
 
virtual void SuppressRenderingOff ()
 SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender. More...
 
virtual void SetStillRenderImageReductionFactor (int)
 Get/Set the reduction-factor to use when for StillRender(). More...
 
virtual int GetStillRenderImageReductionFactor ()
 Get/Set the reduction-factor to use when for StillRender(). More...
 
virtual void SetInteractiveRenderImageReductionFactor (int)
 Get/Set the reduction-factor to use when for InteractiveRender(). More...
 
virtual int GetInteractiveRenderImageReductionFactor ()
 Get/Set the reduction-factor to use when for InteractiveRender(). More...
 
virtual void SetRemoteRenderingThreshold (double)
 Get/Set the data-size in megabytes above which remote-rendering should be used, if possible. More...
 
virtual double GetRemoteRenderingThreshold ()
 Get/Set the data-size in megabytes above which remote-rendering should be used, if possible. More...
 
virtual void SetLODRenderingThreshold (double)
 Get/Set the data-size in megabytes above which LOD rendering should be used, if possible. More...
 
virtual double GetLODRenderingThreshold ()
 Get/Set the data-size in megabytes above which LOD rendering should be used, if possible. More...
 
virtual void SetLODResolution (double)
 Get/Set the LOD resolution. More...
 
virtual double GetLODResolution ()
 Get/Set the LOD resolution. More...
 
virtual void SetUseOutlineForLODRendering (bool)
 When set to true, instead of using simplified geometry for LOD rendering, uses outline, if possible. More...
 
virtual bool GetUseOutlineForLODRendering ()
 When set to true, instead of using simplified geometry for LOD rendering, uses outline, if possible. More...
 
void SetUseLightKit (bool enable)
 Enable/Disable light kit. More...
 
virtual bool GetUseLightKit ()
 Enable/Disable light kit. More...
 
virtual void UseLightKitOn ()
 Enable/Disable light kit. More...
 
virtual void UseLightKitOff ()
 Enable/Disable light kit. More...
 
void StreamingUpdate (const double view_planes[24])
 
void DeliverStreamedPieces (unsigned int size, unsigned int *representation_ids)
 
void SelectCells (int region[4], const char *array=nullptr)
 Make a selection. More...
 
void SelectCells (int region0, int region1, int region2, int region3, const char *array=nullptr)
 Make a selection. More...
 
void SelectPoints (int region[4], const char *array=nullptr)
 Make a selection. More...
 
void SelectPoints (int region0, int region1, int region2, int region3, const char *array=nullptr)
 Make a selection. More...
 
void Select (int field_association, int region[4], const char *array=nullptr)
 Make a selection. More...
 
void SelectPolygonPoints (int *polygon2DArray, vtkIdType arrayLen)
 Make a selection with a polygon. More...
 
void SelectPolygonCells (int *polygon2DArray, vtkIdType arrayLen)
 Make a selection with a polygon. More...
 
void SelectPolygon (int field_association, int *polygon2DArray, vtkIdType arrayLen)
 Make a selection with a polygon. More...
 
virtual vtkSelectionGetLastSelection ()
 Provides access to the last selection. More...
 
virtual void SetUseInteractiveRenderingForScreenshots (bool)
 Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots. More...
 
virtual void UseInteractiveRenderingForScreenshotsOn ()
 Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots. More...
 
virtual void UseInteractiveRenderingForScreenshotsOff ()
 Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots. More...
 
virtual bool GetUseInteractiveRenderingForScreenshots ()
 Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots. More...
 
virtual bool GetRemoteRenderingAvailable ()
 Returns if remote-rendering is possible on the current group of processes. More...
 
void RemoteRenderingAvailableOff ()
 Returns if remote-rendering is possible on the current group of processes. More...
 
void NVPipeAvailableOn ()
 Determine if NVPipe is an available compressor option. More...
 
void NVPipeAvailableOff ()
 Determine if NVPipe is an available compressor option. More...
 
virtual bool GetUsedLODForLastRender ()
 Returns true if the most recent render used LOD. More...
 
void SetLockBounds (bool nv)
 Used by Cinema to enforce a consistent viewpoint and depth scaling. More...
 
virtual bool GetLockBounds ()
 Used by Cinema to enforce a consistent viewpoint and depth scaling. More...
 
int RegisterPropForHardwareSelection (vtkPVDataRepresentation *repr, vtkProp *prop)
 Representations that support hardware (render-buffer based) selection, should register the prop that they use for selection rendering. More...
 
void UnRegisterPropForHardwareSelection (vtkPVDataRepresentation *repr, vtkProp *prop)
 Representations that support hardware (render-buffer based) selection, should register the prop that they use for selection rendering. More...
 
void SetShowAnnotation (bool val)
 Enable/disable showing of annotation for developers. More...
 
virtual void SetUpdateAnnotation (bool)
 Enable/disable showing of annotation for developers. More...
 
void SetAnnotationColor (double r, double g, double b)
 Set color of annotation text for developers. More...
 
virtual bool GetUseLODForInteractiveRender ()
 Returns whether the view will use LOD rendering for the next InteractiveRender() call based on the geometry sizes determined by the most recent call to Update(). More...
 
virtual bool GetUseDistributedRenderingForRender ()
 Returns whether the view will use distributed rendering for the next full-resolution render. More...
 
virtual bool GetUseDistributedRenderingForLODRender ()
 Returns whether the view will use distributed rendering for the next low-resolution render. More...
 
virtual vtkTypeUInt32 GetStillRenderProcesses ()
 Returns the processes (vtkPVSession::ServerFlags) that are to be involved in the next StillRender() call based on the decisions made during the most recent Update(). More...
 
virtual vtkTypeUInt32 GetInteractiveRenderProcesses ()
 Returns the processes (vtkPVSession::ServerFlags) that are to be involved in the next InteractiveRender() call based on the decisions made during the most recent Update() and UpdateLOD(). More...
 
virtual void SetUseFXAA (bool)
 Enable/disable FXAA antialiasing. More...
 
virtual bool GetUseFXAA ()
 Enable/disable FXAA antialiasing. More...
 
void SetFXAARelativeContrastThreshold (double val)
 FXAA tunable parameters. More...
 
void SetFXAAHardContrastThreshold (double val)
 FXAA tunable parameters. More...
 
void SetFXAASubpixelBlendLimit (double val)
 FXAA tunable parameters. More...
 
void SetFXAASubpixelContrastThreshold (double val)
 FXAA tunable parameters. More...
 
void SetFXAAUseHighQualityEndpoints (bool val)
 FXAA tunable parameters. More...
 
void SetFXAAEndpointSearchIterations (int val)
 FXAA tunable parameters. More...
 
void AddPropToRenderer (vtkProp *prop)
 Add props directly to the view. More...
 
void RemovePropFromRenderer (vtkProp *prop)
 Add props directly to the view. More...
 
void SetDrawCells (bool choice)
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void SetArrayNameToDraw (const char *name)
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void SetArrayNumberToDraw (int fieldAttributeType)
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void SetArrayComponentToDraw (int comp)
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void SetScalarRange (double min, double max)
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void BeginValueCapture ()
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void EndValueCapture ()
 Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values. More...
 
void SetValueRenderingModeCommand (int mode)
 Current rendering mode of vtkValuePass (float or invertible RGB). More...
 
int GetValueRenderingModeCommand ()
 Current rendering mode of vtkValuePass (float or invertible RGB). More...
 
void CaptureValuesFloat ()
 Access to vtkValuePass::FLOATING_POINT mode rendered image. More...
 
vtkFloatArrayGetCapturedValuesFloat ()
 Access to vtkValuePass::FLOATING_POINT mode rendered image. More...
 
void StartCaptureLuminance ()
 Tells views that it should draw the lighting contributions to the framebuffer. More...
 
void StopCaptureLuminance ()
 Tells views that it should draw the lighting contributions to the framebuffer. More...
 
void CaptureZBuffer ()
 Access to the Z buffer. More...
 
vtkFloatArrayGetCapturedZBuffer ()
 Access to the Z buffer. More...
 
void SetEnableOSPRay (bool)
 Switches between rasterization and ray tracing. More...
 
bool GetEnableOSPRay ()
 Switches between rasterization and ray tracing. More...
 
void SetShadows (bool)
 Controls whether OSPRay sends casts shadow rays or not. More...
 
bool GetShadows ()
 Controls whether OSPRay sends casts shadow rays or not. More...
 
void SetAmbientOcclusionSamples (int)
 Sets the number of occlusion query rays that OSPRay sends at each intersection. More...
 
int GetAmbientOcclusionSamples ()
 Sets the number of occlusion query rays that OSPRay sends at each intersection. More...
 
void SetSamplesPerPixel (int)
 Set the number of primary rays that OSPRay shoots per pixel. More...
 
int GetSamplesPerPixel ()
 Set the number of primary rays that OSPRay shoots per pixel. More...
 
void SetMaxFrames (int)
 Set the number of render passes OSPRay takes to accumulate subsampled color results. More...
 
int GetMaxFrames ()
 Set the number of render passes OSPRay takes to accumulate subsampled color results. More...
 
void SetDenoise (bool)
 Controls whether to use image denoising to improve appearance. More...
 
bool GetDenoise ()
 Controls whether to use image denoising to improve appearance. More...
 
void SetLightScale (double)
 Dimish or Amplify all lights in the scene. More...
 
double GetLightScale ()
 Dimish or Amplify all lights in the scene. More...
 
void SetBackgroundNorth (double x, double y, double z)
 Control of background orientation for OSPRay. More...
 
void SetBackgroundEast (double x, double y, double z)
 Control of background orientation for OSPRay. More...
 
void SetTimeCacheSize (int)
 Set the size of OSPRay's temporal cache. More...
 
int GetTimeCacheSize ()
 Set the size of OSPRay's temporal cache. More...
 
- Public Member Functions inherited from vtkPVView
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetPPI (int)
 Description: Set the screen PPI. More...
 
virtual int GetPPI ()
 
void Update () override
 Overridden to not call Update() directly on the input representations, instead use ProcessViewRequest() for all vtkPVDataRepresentations. More...
 
bool InTileDisplayMode ()
 Returns true if the application is currently in tile display mode. More...
 
bool InCaveDisplayMode ()
 Returns true if the application is currently in cave/immersive display mode. More...
 
bool GetLocalProcessSupportsInteraction ()
 Returns true if the local process can support interaction. More...
 
vtkRenderWindowGetRenderWindow ()
 If this view needs a render window (not all views may use one), this method can be used to get the render window associated with this view on the current process. More...
 
vtkMTimeType GetUpdateTimeStamp ()
 Provides access to the time when Update() was last called. More...
 
virtual bool IsCached (vtkPVDataRepresentation *)
 Called in vtkPVDataRepresentation::ProcessViewRequest to check if the representation already has cached data. More...
 
virtual void ClearCache (vtkPVDataRepresentation *)
 Called by vtkPVDataRepresentation whenever vtkPVDataRepresentation::MarkModified is called. More...
 
virtual intGetPosition ()
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int &, int &)
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int [2])
 Set the position on this view in the multiview configuration. More...
 
virtual intGetSize ()
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int &, int &)
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int [2])
 Set the size of this view in the multiview configuration. More...
 
virtual double GetViewTime ()
 Get/Set the time this view is showing. More...
 
virtual void SetCacheKey (double)
 Get/Set the cache key. More...
 
virtual double GetCacheKey ()
 Get/Set the cache key. More...
 
virtual void SetUseCache (bool)
 Get/Set whether caching is enabled. More...
 
virtual bool GetUseCache ()
 Get/Set whether caching is enabled. More...
 
virtual void PrepareForScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 
virtual void CleanupAfterScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 
void SetTileScale (int x, int y)
 When saving screenshots with tiling, these methods get called. More...
 
void SetTileViewport (double x0, double y0, double x1, double y1)
 When saving screenshots with tiling, these methods get called. More...
 
virtual void SetLogName (const std::string &name)
 This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
 
const std::stringGetLogName () const
 This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
 
void SetDeliveryManager (vtkPVDataDeliveryManager *)
 Provides access to data delivery & cache manager for this view. More...
 
virtual vtkPVDataDeliveryManagerGetDeliveryManager ()
 Provides access to data delivery & cache manager for this view. More...
 
- Public Member Functions inherited from vtkView
vtkViewNewInstance () const
 
void AddRepresentation (vtkDataRepresentation *rep)
 
void SetRepresentation (vtkDataRepresentation *rep)
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
 
void RemoveRepresentation (vtkDataRepresentation *rep)
 
void RemoveRepresentation (vtkAlgorithmOutput *rep)
 
void RemoveAllRepresentations ()
 
int GetNumberOfRepresentations ()
 
vtkDataRepresentationGetRepresentation (int index=0)
 
bool IsRepresentationPresent (vtkDataRepresentation *rep)
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 
vtkCommandGetObserver ()
 
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
 
void UnRegisterProgress (vtkObject *algorithm)
 
- 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 vtkPVRenderViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVRenderViewSafeDownCast (vtkObject *o)
 
static vtkInformationIntegerKeyUSE_LOD ()
 USE_LOD indicates if LOD is being used for the current render/update. More...
 
static vtkInformationDoubleKeyLOD_RESOLUTION ()
 Indicates the LOD resolution in REQUEST_UPDATE_LOD() pass. More...
 
static vtkInformationIntegerKeyUSE_OUTLINE_FOR_LOD ()
 Indicates the LOD must use outline if possible in REQUEST_UPDATE_LOD() pass. More...
 
static vtkInformationIntegerKeyRENDER_EMPTY_IMAGES ()
 Representation can publish this key in their REQUEST_INFORMATION() pass to indicate that the representation needs to disable IceT's empty image optimization. More...
 
static vtkInformationIntegerKeyNEED_ORDERED_COMPOSITING ()
 Representation can publish this key in their REQUEST_INFORMATION() pass to indicate that the representation needs ordered compositing. More...
 
static vtkInformationDoubleVectorKeyVIEW_PLANES ()
 Key used to pass meta-data about the view frustum in REQUEST_STREAMING_UPDATE() pass. More...
 
static vtkInformationRequestKeyREQUEST_STREAMING_UPDATE ()
 Streaming pass request. More...
 
static vtkInformationRequestKeyREQUEST_PROCESS_STREAMED_PIECE ()
 Pass to relay the streamed "piece" to the representations. More...
 
static void SetDeliverToAllProcesses (vtkInformation *info, vtkPVDataRepresentation *repr, bool clone)
 Requests the view to deliver the pieces produced by the repr to all processes after a gather to the root node to merge the datasets generated by each process. More...
 
static void SetDeliverToClientAndRenderingProcesses (vtkInformation *info, vtkPVDataRepresentation *repr, bool deliver_to_client, bool gather_before_delivery, int port=0)
 Requests the view to deliver the data to the client always. More...
 
static vtkAlgorithmOutputGetPieceProducer (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static vtkAlgorithmOutputGetPieceProducerLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static void SetRedistributionMode (vtkInformation *info, vtkPVDataRepresentation *repr, int mode, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static void SetRedistributionModeToSplitBoundaryCells (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static void SetRedistributionModeToDuplicateBoundaryCells (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static void SetRedistributionModeToUniquelyAssignBoundaryCells (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static void SetGeometryBounds (vtkInformation *info, vtkPVDataRepresentation *repr, const double bounds[6], vtkMatrix4x4 *transform=nullptr, int port=0)
 Convenience methods used by representations to pass represented data. More...
 
static void SetStreamable (vtkInformation *info, vtkPVDataRepresentation *repr, bool streamable)
 Convenience methods used by representations to pass represented data. More...
 
static void SetNextStreamedPiece (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *piece)
 Convenience methods used by representations to pass represented data. More...
 
static vtkDataObjectGetCurrentStreamedPiece (vtkInformation *info, vtkPVDataRepresentation *repr)
 Convenience methods used by representations to pass represented data. More...
 
static void MarkAsRedistributable (vtkInformation *info, vtkPVDataRepresentation *repr, bool value=true, int port=0)
 As of ParaView 5.9, these methods are replaced by SetOrderedCompositingConfiguration which provides a new mechanisms for indicating to the view how this representation participates in data-redistribution needed when ordered-compositing is being used. More...
 
static void SetOrderedCompositingInformation (vtkInformation *info, vtkPVDataRepresentation *repr, vtkExtentTranslator *translator, const int whole_extents[6], const double origin[3], const double spacing[3])
 As of ParaView 5.9, these methods are replaced by SetOrderedCompositingConfiguration which provides a new mechanisms for indicating to the view how this representation participates in data-redistribution needed when ordered-compositing is being used. More...
 
static void SetOrderedCompositingInformation (vtkInformation *info, const double bounds[6])
 As of ParaView 5.9, these methods are replaced by SetOrderedCompositingConfiguration which provides a new mechanisms for indicating to the view how this representation participates in data-redistribution needed when ordered-compositing is being used. More...
 
static void SetRequiresDistributedRendering (vtkInformation *info, vtkPVDataRepresentation *repr, bool value, bool for_lod=false)
 Some representation only work when remote rendering or local rendering. More...
 
static void SetRequiresDistributedRenderingLOD (vtkInformation *info, vtkPVDataRepresentation *repr, bool value)
 Some representation only work when remote rendering or local rendering. More...
 
static vtkPVCameraCollectionGetDiscreteCameras (vtkInformation *info, vtkPVDataRepresentation *repr)
 DiscreteCameras are a collection of cameras when specified, forces the view to only interact to a camera in the collection. More...
 
static void SetDiscreteCameras (vtkInformation *info, vtkPVDataRepresentation *repr, vtkPVCameraCollection *style)
 DiscreteCameras are a collection of cameras when specified, forces the view to only interact to a camera in the collection. More...
 
- Static Public Member Functions inherited from vtkPVView
static int IsTypeOf (const char *type)
 
static vtkPVViewSafeDownCast (vtkObject *o)
 
static void SetEnableStreaming (bool)
 
static bool GetEnableStreaming ()
 
static vtkInformationObjectBaseKeyVIEW ()
 Key used to pass the vtkPVView pointer to the representation during any of the view passes such as REQUEST_UPDATE(), REQUEST_UPDATE_LOD(), REQUEST_RENDER(), etc. More...
 
static vtkInformationRequestKeyREQUEST_UPDATE ()
 This is a Update-Data pass. More...
 
static vtkInformationRequestKeyREQUEST_UPDATE_LOD ()
 This is a Update-LOD-Data pass. More...
 
static vtkInformationRequestKeyREQUEST_RENDER ()
 This is a render pass. More...
 
static void SetPiece (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *data, unsigned long trueSize=0, int port=0)
 
static vtkDataObjectGetPiece (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static vtkDataObjectGetDeliveredPiece (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static void SetPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, vtkDataObject *data, unsigned long trueSize=0, int port=0)
 
static vtkDataObjectGetPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static vtkDataObjectGetDeliveredPieceLOD (vtkInformation *info, vtkPVDataRepresentation *repr, int port=0)
 
static void SetUseGenericOpenGLRenderWindow (bool val)
 Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window. More...
 
static bool GetUseGenericOpenGLRenderWindow ()
 Use this to indicate that the process should use vtkGenericOpenGLRenderWindow rather than vtkRenderWindow when creating an new render window. More...
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkViewSafeDownCast (vtkObjectBase *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

 vtkPVRenderView ()
 
 ~vtkPVRenderView () override
 
virtual void Render (bool interactive, bool skip_rendering)
 Actual render method. More...
 
virtual void AboutToRenderOnLocalProcess (bool interactive)
 Called just before the local process renders. More...
 
bool ShouldUseDistributedRendering (double geometry_size, bool using_lod)
 Returns true if distributed rendering should be used based on the geometry size. More...
 
bool ShouldUseLODRendering (double geometry)
 Returns true if LOD rendering should be used based on the geometry size. More...
 
bool IsProcessRenderingGeometriesForCompositing (bool using_distributed_rendering)
 Returns true if the local process is invovled in rendering composited geometry i.e. More...
 
void SynchronizeGeometryBounds ()
 Synchronizes bounds information on all nodes. More...
 
void SetLastSelection (vtkSelection *)
 Set the last selection object. More...
 
virtual void UpdateCenterAxes ()
 UpdateCenterAxes(). More...
 
bool GetLocalProcessDoesRendering (bool using_distributed_rendering)
 Returns true if the local process is doing to do actual render or displaying an image in a viewport. More...
 
bool TestCollaborationCounter ()
 In multi-clients mode, ensures that all processes are in the same "state" as far as the view is concerned. More...
 
void SynchronizeForCollaboration ()
 Synchronizes remote-rendering related parameters for collaborative rendering in multi-clients mode. More...
 
virtual void BuildAnnotationText (ostream &str)
 Method to build annotation text to annotate the view with runtime information. More...
 
bool PrepareSelect (int fieldAssociation, const char *array=nullptr)
 Prepare for selection. More...
 
void PostSelect (vtkSelection *sel, const char *array=nullptr)
 Post process after selection. More...
 
void UpdateSkybox ()
 Update skybox actor. More...
 
virtual unsigned int GetSynchronizationCounter ()
 SynchronizationCounter is used in multi-clients mode to ensure that the views on two different clients are in the same state as the server side. More...
 
virtual bool GetMakingSelection ()
 Returns true is currently generating a selection. More...
 
- Protected Member Functions inherited from vtkPVView
 vtkPVView (bool create_render_window=true)
 
 ~vtkPVView () override
 
vtkRenderWindowNewRenderWindow ()
 Subclasses should use this method to create new render windows instead of directly creating a new one. More...
 
void SetRenderWindow (vtkRenderWindow *)
 Subclasses can use this method to set the render window created for this view. More...
 
void AllReduce (const vtkBoundingBox &source, vtkBoundingBox &dest)
 Reduce bounding box between all participating processes. More...
 
void AllReduce (const vtkTypeUInt64 source, vtkTypeUInt64 &dest, int operation, bool skip_data_server=false)
 Reduce between all participating processes using the operation (vtkCommunicator::StandardOperations) specified. More...
 
vtkPVSessionGetSession ()
 
virtual bool GetInCaptureScreenshot ()
 Flag set to true between calls to PrepareForScreenshot and CleanupAfterScreenshot. More...
 
void AddRepresentationInternal (vtkDataRepresentation *rep) override
 Overridden to assign IDs to each representation. More...
 
void RemoveRepresentationInternal (vtkDataRepresentation *rep) override
 Overridden to assign IDs to each representation. More...
 
int CallProcessViewRequest (vtkInformationRequestKey *passType, vtkInformation *request, vtkInformationVector *reply)
 Subclasses can use this method to trigger a pass on all representations. More...
 
- Protected Member Functions inherited from vtkView
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkView ()
 
 ~vtkView ()
 
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 
virtual void SetReuseSingleRepresentation (bool)
 
virtual bool GetReuseSingleRepresentation ()
 
virtual void ReuseSingleRepresentationOn ()
 
virtual void ReuseSingleRepresentationOff ()
 
- 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

vtkLightKitLightKit
 
vtkRenderViewBaseRenderView
 
vtkRendererNonCompositedRenderer
 
vtkPVSynchronizedRendererSynchronizedRenderers
 
vtkSmartPointer< vtkRenderWindowInteractorInteractor
 
vtkInteractorStyleRubberBand3DRubberBandStyle
 
vtkInteractorStyleRubberBandZoomRubberBandZoom
 
vtkInteractorStyleDrawPolygonPolygonStyle
 
vtkPVCenterAxesActorCenterAxes
 
vtkPVAxesWidgetOrientationWidget
 
vtkPVHardwareSelectorSelector
 
vtkSelectionLastSelection
 
vtkSmartPointer< vtkPVGridAxes3DActorGridAxes3DActor
 
vtkNew< vtkSkybox > Skybox
 
bool NeedSkybox = false
 
int StillRenderImageReductionFactor
 
int InteractiveRenderImageReductionFactor
 
int InteractionMode
 
bool ShowAnnotation
 
bool UpdateAnnotation
 
bool SuppressRendering
 
vtkPVInteractorStyleTwoDInteractorStyle
 
vtkPVInteractorStyleThreeDInteractorStyle
 
vtkPVInteractorStyleInteractorStyle
 
vtkWeakPointer< vtkPVCameraCollectionDiscreteCameras
 
unsigned int SynchronizationCounter
 
double RemoteRenderingThreshold
 
double LODRenderingThreshold
 
vtkBoundingBox GeometryBounds
 
bool UseInteractiveRenderingForScreenshots
 
bool NeedsOrderedCompositing
 
bool RenderEmptyImages
 
bool UseFXAA
 
vtkNew< vtkFXAAOptions > FXAAOptions
 
double LODResolution
 
bool UseLightKit
 
bool UsedLODForLastRender
 
bool UseLODForInteractiveRender
 
bool UseOutlineForLODRendering
 
bool UseDistributedRenderingForRender
 
bool UseDistributedRenderingForLODRender
 
vtkTypeUInt32 StillRenderProcesses
 
vtkTypeUInt32 InteractiveRenderProcesses
 
vtkTimeStamp PriorityQueueBuildTimeStamp
 Keeps track of the time when the priority-queue for streaming was generated. More...
 
bool LockBounds
 
- Protected Attributes inherited from vtkPVView
double ViewTime
 
double CacheKey
 
bool UseCache
 
int Size [2]
 
int Position [2]
 
int PPI
 
vtkTimeStamp UpdateTimeStamp
 Keeps track of the time when vtkPVRenderView::Update() was called. More...
 
vtkInformationRequestInformation
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
vtkInformationVectorReplyInformationVector
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
- Protected Attributes inherited from vtkView
bool ReuseSingleRepresentation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
enum  { USE_BOUNDS_FOR_REDISTRIBUTION = 0x01, DATA_IS_REDISTRIBUTABLE = 0x02, USE_DATA_FOR_LOAD_BALANCING = 0x40 }
 OrderedCompositingConfiguration lets representations indicate to the view how the representation participates in data-redistribution necessary when ordered-compositing is being used. More...
 
static void SetOrderedCompositingConfiguration (vtkInformation *info, vtkPVDataRepresentation *repr, int config, const double *bounds=nullptr, int port=0)
 OrderedCompositingConfiguration lets representations indicate to the view how the representation participates in data-redistribution necessary when ordered-compositing is being used. More...
 
static void SetForceDataDistributionMode (vtkInformation *info, int flag)
 This is an temporary/experimental option and may be removed without notice. More...
 
bool IsForceDataDistributionModeSet () const
 This is an temporary/experimental option and may be removed without notice. More...
 
int GetForceDataDistributionMode () const
 This is an temporary/experimental option and may be removed without notice. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkPVView
static vtkPVDataDeliveryManagerGetDeliveryManager (vtkInformation *info)
 

Detailed Description

Render View for ParaView.

vtkRenderView equivalent that is specialized for ParaView. vtkRenderView handles polygonal rendering for ParaView in all the different modes of operation. vtkPVRenderView instance must be created on all involved processes. vtkPVRenderView uses the information about what process it has been created on to decide what part of the "rendering" happens on the process.

Definition at line 73 of file vtkPVRenderView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 78 of file vtkPVRenderView.h.

Member Enumeration Documentation

◆ InteractionModes

Enumerator
INTERACTION_MODE_UNINTIALIZED 
INTERACTION_MODE_3D 
INTERACTION_MODE_2D 
INTERACTION_MODE_SELECTION 
INTERACTION_MODE_ZOOM 
INTERACTION_MODE_POLYGON 

Definition at line 81 of file vtkPVRenderView.h.

◆ anonymous enum

anonymous enum

Defines various renderer types.

Enumerator
DEFAULT_RENDERER 
NON_COMPOSITED_RENDERER 

Definition at line 128 of file vtkPVRenderView.h.

◆ anonymous enum

anonymous enum

OrderedCompositingConfiguration lets representations indicate to the view how the representation participates in data-redistribution necessary when ordered-compositing is being used.

These flags are meant to be combined together using bit-wise-OR.

If not specified, default is 0 i.e. the representation data will be left untouched. Except for trivial representations or representations that have their full rendering geometry available on all rendering ranks, this is not recommended.

DATA_IS_REDISTRIBUTABLE indicates that the view may redistribute the rendering data from this representation as needed. This is typical for representation rendering poly-data or unstructured grids.

USE_DATA_FOR_LOAD_BALANCING indicates that when building a sortable distribution for the data, it should use this representation data. If not set, the representation will not contribute to the algorithm that builds the kd-tree used to split data across rendering ranks.

USE_BOUNDS_FOR_REDISTRIBUTION may be used when the data is too heavy to move (i.e DATA_IS_REDISTRIBUTABLE is not true) and is already split across ranks in a sortable fashion. In that case, this indicates the view must use the spatial partitioning of this representation's data and move other data accordingly. This flag cannot be combined with DATA_IS_REDISTRIBUTABLE or USE_BOUNDS_FOR_REDISTRIBUTION.

Enumerator
USE_BOUNDS_FOR_REDISTRIBUTION 
DATA_IS_REDISTRIBUTABLE 
USE_DATA_FOR_LOAD_BALANCING 

Definition at line 510 of file vtkPVRenderView.h.

Constructor & Destructor Documentation

◆ vtkPVRenderView()

vtkPVRenderView::vtkPVRenderView ( )
protected

◆ ~vtkPVRenderView()

vtkPVRenderView::~vtkPVRenderView ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVRenderView* vtkPVRenderView::New ( )
static

◆ GetClassName()

virtual const char* vtkPVRenderView::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkView.

Reimplemented in vtkPVRenderViewWithEDL.

◆ SetInteractionMode()

virtual void vtkPVRenderView::SetInteractionMode ( int  mode)
virtual

Get/Set the interaction mode.

Default is INTERACTION_MODE_3D. If INTERACTION_MODE_SELECTION is selected, then whenever the user drags and creates a selection region, this class will fire a vtkCommand::SelectionChangedEvent event with the selection region as the argument.

Note
CallOnAllProcesses
this must be called on all processes, however it will have any effect only the driver processes i.e. the process with the interactor.

Reimplemented in vtkPVOrthographicSliceView.

◆ GetInteractionMode()

virtual int vtkPVRenderView::GetInteractionMode ( )
virtual

Get/Set the interaction mode.

Default is INTERACTION_MODE_3D. If INTERACTION_MODE_SELECTION is selected, then whenever the user drags and creates a selection region, this class will fire a vtkCommand::SelectionChangedEvent event with the selection region as the argument.

Note
CallOnAllProcesses
this must be called on all processes, however it will have any effect only the driver processes i.e. the process with the interactor.

◆ SetSize()

void vtkPVRenderView::SetSize ( int  ,
int   
)
overridevirtual

Overridden to call InvalidateCachedSelection() whenever the render window parameters change.

Reimplemented from vtkPVView.

◆ SetPosition()

void vtkPVRenderView::SetPosition ( int  ,
int   
)
overridevirtual

Overridden to call InvalidateCachedSelection() whenever the render window parameters change.

Reimplemented from vtkPVView.

◆ GetNonCompositedRenderer()

virtual vtkRenderer* vtkPVRenderView::GetNonCompositedRenderer ( )
virtual

Gets the non-composited renderer for this view.

This is typically used for labels, 2D annotations etc.

Note
CallOnAllProcesses

◆ GetRenderer()

virtual vtkRenderer* vtkPVRenderView::GetRenderer ( int  rendererType = DEFAULT_RENDERER)
virtual

Returns the renderer given an int identifying its type.

  • DEFAULT_RENDERER: returns the 3D renderer.
  • NON_COMPOSITED_RENDERER: returns the NonCompositedRenderer.

Reimplemented in vtkPVOrthographicSliceView.

◆ GetActiveCamera()

vtkCamera* vtkPVRenderView::GetActiveCamera ( )

Get/Set the active camera.

The active camera is set on both the composited and non-composited renderer.

◆ SetActiveCamera()

virtual void vtkPVRenderView::SetActiveCamera ( vtkCamera )
virtual

Get/Set the active camera.

The active camera is set on both the composited and non-composited renderer.

◆ GetInteractor()

vtkRenderWindowInteractor* vtkPVRenderView::GetInteractor ( )

Returns the interactor.

◆ SetupInteractor()

virtual void vtkPVRenderView::SetupInteractor ( vtkRenderWindowInteractor )
virtual

Set the interactor.

Client applications must set the interactor to enable interactivity. Note this method will also change the interactor styles set on the interactor.

Reimplemented in vtkPVOrthographicSliceView.

◆ GetInteractorStyle()

virtual vtkPVInteractorStyle* vtkPVRenderView::GetInteractorStyle ( )
virtual

Returns the interactor style.

◆ ResetCamera() [1/2]

void vtkPVRenderView::ResetCamera ( )

Resets the active camera using collective prop-bounds.

Note
CallOnAllProcesses

◆ ResetCamera() [2/2]

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

Resets the active camera using collective prop-bounds.

Note
CallOnAllProcesses

◆ StillRender()

void vtkPVRenderView::StillRender ( )
overridevirtual

Triggers a high-resolution render.

Note
Can be called on processes involved in rendering i.e those returned by this->GetStillRenderProcesses().

Implements vtkPVView.

◆ InteractiveRender()

void vtkPVRenderView::InteractiveRender ( )
overridevirtual

Triggers a interactive render.

Based on the settings on the view, this may result in a low-resolution rendering or a simplified geometry rendering.

Note
Can be called on processes involved in rendering i.e those returned by this->GetInteractiveRenderProcesses().

Implements vtkPVView.

◆ SetSuppressRendering()

virtual void vtkPVRenderView::SetSuppressRendering ( bool  )
virtual

SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender.

This is useful in cases where you want the representations mappers to be setup for rendering and have their data ready but not actually do the render. For example if you want to export the scene but not render it you must turn on SuppressRendering and then call StillRender

◆ GetSuppressRendering()

virtual bool vtkPVRenderView::GetSuppressRendering ( )
virtual

SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender.

This is useful in cases where you want the representations mappers to be setup for rendering and have their data ready but not actually do the render. For example if you want to export the scene but not render it you must turn on SuppressRendering and then call StillRender

◆ SuppressRenderingOn()

virtual void vtkPVRenderView::SuppressRenderingOn ( )
virtual

SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender.

This is useful in cases where you want the representations mappers to be setup for rendering and have their data ready but not actually do the render. For example if you want to export the scene but not render it you must turn on SuppressRendering and then call StillRender

◆ SuppressRenderingOff()

virtual void vtkPVRenderView::SuppressRenderingOff ( )
virtual

SuppressRendering can be used to suppress the render within a StillRender or InteractiveRender.

This is useful in cases where you want the representations mappers to be setup for rendering and have their data ready but not actually do the render. For example if you want to export the scene but not render it you must turn on SuppressRendering and then call StillRender

◆ SetStillRenderImageReductionFactor()

virtual void vtkPVRenderView::SetStillRenderImageReductionFactor ( int  )
virtual

Get/Set the reduction-factor to use when for StillRender().

This is typically set to 1, but in some cases with terrible connectivity or really large displays, one may want to use a sub-sampled image even for StillRender(). This is set it number of pixels to be sub-sampled by. Note that image reduction factors have no effect when in built-in mode.

Note
CallOnAllProcesses

◆ GetStillRenderImageReductionFactor()

virtual int vtkPVRenderView::GetStillRenderImageReductionFactor ( )
virtual

Get/Set the reduction-factor to use when for StillRender().

This is typically set to 1, but in some cases with terrible connectivity or really large displays, one may want to use a sub-sampled image even for StillRender(). This is set it number of pixels to be sub-sampled by. Note that image reduction factors have no effect when in built-in mode.

Note
CallOnAllProcesses

◆ SetInteractiveRenderImageReductionFactor()

virtual void vtkPVRenderView::SetInteractiveRenderImageReductionFactor ( int  )
virtual

Get/Set the reduction-factor to use when for InteractiveRender().

This is set it number of pixels to be sub-sampled by. Note that image reduction factors have no effect when in built-in mode.

Note
CallOnAllProcesses

◆ GetInteractiveRenderImageReductionFactor()

virtual int vtkPVRenderView::GetInteractiveRenderImageReductionFactor ( )
virtual

Get/Set the reduction-factor to use when for InteractiveRender().

This is set it number of pixels to be sub-sampled by. Note that image reduction factors have no effect when in built-in mode.

Note
CallOnAllProcesses

◆ SetRemoteRenderingThreshold()

virtual void vtkPVRenderView::SetRemoteRenderingThreshold ( double  )
virtual

Get/Set the data-size in megabytes above which remote-rendering should be used, if possible.

Note
CallOnAllProcesses

◆ GetRemoteRenderingThreshold()

virtual double vtkPVRenderView::GetRemoteRenderingThreshold ( )
virtual

Get/Set the data-size in megabytes above which remote-rendering should be used, if possible.

Note
CallOnAllProcesses

◆ SetLODRenderingThreshold()

virtual void vtkPVRenderView::SetLODRenderingThreshold ( double  )
virtual

Get/Set the data-size in megabytes above which LOD rendering should be used, if possible.

Note
CallOnAllProcesses

◆ GetLODRenderingThreshold()

virtual double vtkPVRenderView::GetLODRenderingThreshold ( )
virtual

Get/Set the data-size in megabytes above which LOD rendering should be used, if possible.

Note
CallOnAllProcesses

◆ SetLODResolution()

virtual void vtkPVRenderView::SetLODResolution ( double  )
virtual

Get/Set the LOD resolution.

This affects the size of the grid used for quadric clustering, for example. 1.0 implies maximum resolution while 0 implies minimum resolution.

Note
CallOnAllProcesses

◆ GetLODResolution()

virtual double vtkPVRenderView::GetLODResolution ( )
virtual

Get/Set the LOD resolution.

This affects the size of the grid used for quadric clustering, for example. 1.0 implies maximum resolution while 0 implies minimum resolution.

Note
CallOnAllProcesses

◆ SetUseOutlineForLODRendering()

virtual void vtkPVRenderView::SetUseOutlineForLODRendering ( bool  )
virtual

When set to true, instead of using simplified geometry for LOD rendering, uses outline, if possible.

Note that not all representations support this mode and hence one may still see non-outline data being rendering when this flag is ON and LOD is being used.

◆ GetUseOutlineForLODRendering()

virtual bool vtkPVRenderView::GetUseOutlineForLODRendering ( )
virtual

When set to true, instead of using simplified geometry for LOD rendering, uses outline, if possible.

Note that not all representations support this mode and hence one may still see non-outline data being rendering when this flag is ON and LOD is being used.

◆ ConfigureCompressor()

void vtkPVRenderView::ConfigureCompressor ( const char *  configuration)

Passes the compressor configuration to the client-server synchronizer, if any.

This affects the image compression used to relay images back to the client. See vtkPVClientServerSynchronizedRenderers::ConfigureCompressor() for details.

Note
CallOnAllProcesses

◆ ResetCameraClippingRange()

virtual void vtkPVRenderView::ResetCameraClippingRange ( )
virtual

Resets the clipping range.

One does not need to call this directly ever. It is called periodically by the vtkRenderer to reset the camera range.

◆ SetUseLightKit()

void vtkPVRenderView::SetUseLightKit ( bool  enable)

Enable/Disable light kit.

Note
CallOnAllProcesses

◆ GetUseLightKit()

virtual bool vtkPVRenderView::GetUseLightKit ( )
virtual

Enable/Disable light kit.

Note
CallOnAllProcesses

◆ UseLightKitOn()

virtual void vtkPVRenderView::UseLightKitOn ( )
virtual

Enable/Disable light kit.

Note
CallOnAllProcesses

◆ UseLightKitOff()

virtual void vtkPVRenderView::UseLightKitOff ( )
virtual

Enable/Disable light kit.

Note
CallOnAllProcesses

◆ StreamingUpdate()

void vtkPVRenderView::StreamingUpdate ( const double  view_planes[24])

◆ DeliverStreamedPieces()

void vtkPVRenderView::DeliverStreamedPieces ( unsigned int  size,
unsigned int representation_ids 
)

◆ USE_LOD()

static vtkInformationIntegerKey* vtkPVRenderView::USE_LOD ( )
static

USE_LOD indicates if LOD is being used for the current render/update.

◆ LOD_RESOLUTION()

static vtkInformationDoubleKey* vtkPVRenderView::LOD_RESOLUTION ( )
static

Indicates the LOD resolution in REQUEST_UPDATE_LOD() pass.

◆ USE_OUTLINE_FOR_LOD()

static vtkInformationIntegerKey* vtkPVRenderView::USE_OUTLINE_FOR_LOD ( )
static

Indicates the LOD must use outline if possible in REQUEST_UPDATE_LOD() pass.

◆ RENDER_EMPTY_IMAGES()

static vtkInformationIntegerKey* vtkPVRenderView::RENDER_EMPTY_IMAGES ( )
static

Representation can publish this key in their REQUEST_INFORMATION() pass to indicate that the representation needs to disable IceT's empty image optimization.

This is typically only needed if a painter will make use of MPI global collective communications.

◆ NEED_ORDERED_COMPOSITING()

static vtkInformationIntegerKey* vtkPVRenderView::NEED_ORDERED_COMPOSITING ( )
static

Representation can publish this key in their REQUEST_INFORMATION() pass to indicate that the representation needs ordered compositing.

◆ VIEW_PLANES()

static vtkInformationDoubleVectorKey* vtkPVRenderView::VIEW_PLANES ( )
static

Key used to pass meta-data about the view frustum in REQUEST_STREAMING_UPDATE() pass.

The value is a double vector with exactly 24 values.

◆ REQUEST_STREAMING_UPDATE()

static vtkInformationRequestKey* vtkPVRenderView::REQUEST_STREAMING_UPDATE ( )
static

Streaming pass request.

◆ REQUEST_PROCESS_STREAMED_PIECE()

static vtkInformationRequestKey* vtkPVRenderView::REQUEST_PROCESS_STREAMED_PIECE ( )
static

Pass to relay the streamed "piece" to the representations.

◆ SelectCells() [1/2]

void vtkPVRenderView::SelectCells ( int  region[4],
const char *  array = nullptr 
)

Make a selection.

This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

◆ SelectCells() [2/2]

void vtkPVRenderView::SelectCells ( int  region0,
int  region1,
int  region2,
int  region3,
const char *  array = nullptr 
)
inline

Make a selection.

This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

Definition at line 359 of file vtkPVRenderView.h.

◆ SelectPoints() [1/2]

void vtkPVRenderView::SelectPoints ( int  region[4],
const char *  array = nullptr 
)

Make a selection.

This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

◆ SelectPoints() [2/2]

void vtkPVRenderView::SelectPoints ( int  region0,
int  region1,
int  region2,
int  region3,
const char *  array = nullptr 
)
inline

Make a selection.

This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

Definition at line 365 of file vtkPVRenderView.h.

◆ Select()

void vtkPVRenderView::Select ( int  field_association,
int  region[4],
const char *  array = nullptr 
)

Make a selection.

This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

◆ SelectPolygonPoints()

void vtkPVRenderView::SelectPolygonPoints ( int polygon2DArray,
vtkIdType  arrayLen 
)

Make a selection with a polygon.

The polygon2DArray should contain the polygon points in display units of (x, y) tuples, and arrayLen is the total length of polygon2DArray. This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

◆ SelectPolygonCells()

void vtkPVRenderView::SelectPolygonCells ( int polygon2DArray,
vtkIdType  arrayLen 
)

Make a selection with a polygon.

The polygon2DArray should contain the polygon points in display units of (x, y) tuples, and arrayLen is the total length of polygon2DArray. This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

◆ SelectPolygon()

void vtkPVRenderView::SelectPolygon ( int  field_association,
int polygon2DArray,
vtkIdType  arrayLen 
)

Make a selection with a polygon.

The polygon2DArray should contain the polygon points in display units of (x, y) tuples, and arrayLen is the total length of polygon2DArray. This will result in setting up of this->LastSelection which can be accessed using GetLastSelection().

Note
This method is called on call rendering processes and client (or driver). Thus, if doing client only rendering, this shouldn't be called on server nodes.

◆ GetLastSelection()

virtual vtkSelection* vtkPVRenderView::GetLastSelection ( )
virtual

Provides access to the last selection.

This is valid only on the client or driver node displaying the composited result.

◆ SetUseInteractiveRenderingForScreenshots()

virtual void vtkPVRenderView::SetUseInteractiveRenderingForScreenshots ( bool  )
virtual

Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots.

◆ UseInteractiveRenderingForScreenshotsOn()

virtual void vtkPVRenderView::UseInteractiveRenderingForScreenshotsOn ( )
virtual

Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots.

◆ UseInteractiveRenderingForScreenshotsOff()

virtual void vtkPVRenderView::UseInteractiveRenderingForScreenshotsOff ( )
virtual

Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots.

◆ GetUseInteractiveRenderingForScreenshots()

virtual bool vtkPVRenderView::GetUseInteractiveRenderingForScreenshots ( )
virtual

Set or get whether capture should be done as StillRender or InteractiveRender when capturing screenshots.

◆ GetRemoteRenderingAvailable()

virtual bool vtkPVRenderView::GetRemoteRenderingAvailable ( )
virtual

Returns if remote-rendering is possible on the current group of processes.

◆ RemoteRenderingAvailableOff()

void vtkPVRenderView::RemoteRenderingAvailableOff ( )
inline

Returns if remote-rendering is possible on the current group of processes.

Definition at line 412 of file vtkPVRenderView.h.

◆ NVPipeAvailableOn()

void vtkPVRenderView::NVPipeAvailableOn ( )

Determine if NVPipe is an available compressor option.

◆ NVPipeAvailableOff()

void vtkPVRenderView::NVPipeAvailableOff ( )

Determine if NVPipe is an available compressor option.

◆ GetUsedLODForLastRender()

virtual bool vtkPVRenderView::GetUsedLODForLastRender ( )
virtual

Returns true if the most recent render used LOD.

◆ InvalidateCachedSelection()

void vtkPVRenderView::InvalidateCachedSelection ( )

Invalidates cached selection.

Called explicitly when view proxy thinks the cache may have become obsolete.

Note
CallOnAllProcesses

◆ GetPieceProducer()

static vtkAlgorithmOutput* vtkPVRenderView::GetPieceProducer ( vtkInformation info,
vtkPVDataRepresentation repr,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ GetPieceProducerLOD()

static vtkAlgorithmOutput* vtkPVRenderView::GetPieceProducerLOD ( vtkInformation info,
vtkPVDataRepresentation repr,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetRedistributionMode()

static void vtkPVRenderView::SetRedistributionMode ( vtkInformation info,
vtkPVDataRepresentation repr,
int  mode,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetRedistributionModeToSplitBoundaryCells()

static void vtkPVRenderView::SetRedistributionModeToSplitBoundaryCells ( vtkInformation info,
vtkPVDataRepresentation repr,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetRedistributionModeToDuplicateBoundaryCells()

static void vtkPVRenderView::SetRedistributionModeToDuplicateBoundaryCells ( vtkInformation info,
vtkPVDataRepresentation repr,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetRedistributionModeToUniquelyAssignBoundaryCells()

static void vtkPVRenderView::SetRedistributionModeToUniquelyAssignBoundaryCells ( vtkInformation info,
vtkPVDataRepresentation repr,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetGeometryBounds()

static void vtkPVRenderView::SetGeometryBounds ( vtkInformation info,
vtkPVDataRepresentation repr,
const double  bounds[6],
vtkMatrix4x4 transform = nullptr,
int  port = 0 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetStreamable()

static void vtkPVRenderView::SetStreamable ( vtkInformation info,
vtkPVDataRepresentation repr,
bool  streamable 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ SetNextStreamedPiece()

static void vtkPVRenderView::SetNextStreamedPiece ( vtkInformation info,
vtkPVDataRepresentation repr,
vtkDataObject piece 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ GetCurrentStreamedPiece()

static vtkDataObject* vtkPVRenderView::GetCurrentStreamedPiece ( vtkInformation info,
vtkPVDataRepresentation repr 
)
static

Convenience methods used by representations to pass represented data.

If trueSize is non-zero, then that's the size used in making decisions about LOD/remote rendering etc and not the actual size of the dataset.

◆ MarkAsRedistributable()

static void vtkPVRenderView::MarkAsRedistributable ( vtkInformation info,
vtkPVDataRepresentation repr,
bool  value = true,
int  port = 0 
)
static

As of ParaView 5.9, these methods are replaced by SetOrderedCompositingConfiguration which provides a new mechanisms for indicating to the view how this representation participates in data-redistribution needed when ordered-compositing is being used.

Deprecated:
ParaView 5.9.

◆ SetOrderedCompositingInformation() [1/2]

static void vtkPVRenderView::SetOrderedCompositingInformation ( vtkInformation info,
vtkPVDataRepresentation repr,
vtkExtentTranslator translator,
const int  whole_extents[6],
const double  origin[3],
const double  spacing[3] 
)
static

As of ParaView 5.9, these methods are replaced by SetOrderedCompositingConfiguration which provides a new mechanisms for indicating to the view how this representation participates in data-redistribution needed when ordered-compositing is being used.

Deprecated:
ParaView 5.9.

◆ SetOrderedCompositingInformation() [2/2]

static void vtkPVRenderView::SetOrderedCompositingInformation ( vtkInformation info,
const double  bounds[6] 
)
static

As of ParaView 5.9, these methods are replaced by SetOrderedCompositingConfiguration which provides a new mechanisms for indicating to the view how this representation participates in data-redistribution needed when ordered-compositing is being used.

Deprecated:
ParaView 5.9.

◆ SetOrderedCompositingConfiguration()

static void vtkPVRenderView::SetOrderedCompositingConfiguration ( vtkInformation info,
vtkPVDataRepresentation repr,
int  config,
const double bounds = nullptr,
int  port = 0 
)
static

OrderedCompositingConfiguration lets representations indicate to the view how the representation participates in data-redistribution necessary when ordered-compositing is being used.

These flags are meant to be combined together using bit-wise-OR.

If not specified, default is 0 i.e. the representation data will be left untouched. Except for trivial representations or representations that have their full rendering geometry available on all rendering ranks, this is not recommended.

DATA_IS_REDISTRIBUTABLE indicates that the view may redistribute the rendering data from this representation as needed. This is typical for representation rendering poly-data or unstructured grids.

USE_DATA_FOR_LOAD_BALANCING indicates that when building a sortable distribution for the data, it should use this representation data. If not set, the representation will not contribute to the algorithm that builds the kd-tree used to split data across rendering ranks.

USE_BOUNDS_FOR_REDISTRIBUTION may be used when the data is too heavy to move (i.e DATA_IS_REDISTRIBUTABLE is not true) and is already split across ranks in a sortable fashion. In that case, this indicates the view must use the spatial partitioning of this representation's data and move other data accordingly. This flag cannot be combined with DATA_IS_REDISTRIBUTABLE or USE_BOUNDS_FOR_REDISTRIBUTION.

◆ SetMaxClipBounds()

void vtkPVRenderView::SetMaxClipBounds ( double  bds[6])

Used by Cinema to enforce a consistent depth scaling.

Called with the global (visible and invisible) bounds at start of export.

◆ SetLockBounds()

void vtkPVRenderView::SetLockBounds ( bool  nv)

Used by Cinema to enforce a consistent viewpoint and depth scaling.

Prevents ParaView from changing depth scaling over course of an export.

◆ GetLockBounds()

virtual bool vtkPVRenderView::GetLockBounds ( )
virtual

Used by Cinema to enforce a consistent viewpoint and depth scaling.

Prevents ParaView from changing depth scaling over course of an export.

◆ SetDeliverToAllProcesses()

static void vtkPVRenderView::SetDeliverToAllProcesses ( vtkInformation info,
vtkPVDataRepresentation repr,
bool  clone 
)
static

Requests the view to deliver the pieces produced by the repr to all processes after a gather to the root node to merge the datasets generated by each process.

◆ SetDeliverToClientAndRenderingProcesses()

static void vtkPVRenderView::SetDeliverToClientAndRenderingProcesses ( vtkInformation info,
vtkPVDataRepresentation repr,
bool  deliver_to_client,
bool  gather_before_delivery,
int  port = 0 
)
static

Requests the view to deliver the data to the client always.

This is essential for representation that render in the non-composited views e.g. the text-source representation. If SetDeliverToAllProcesses() is true, this is redundant. gather_before_delivery can be used to indicate if the data on the server-nodes must be gathered to the root node before shipping to the client. If gather_before_delivery is false, only the data from the root node will be sent to the client without any parallel communication.

◆ SetRequiresDistributedRendering()

static void vtkPVRenderView::SetRequiresDistributedRendering ( vtkInformation info,
vtkPVDataRepresentation repr,
bool  value,
bool  for_lod = false 
)
static

Some representation only work when remote rendering or local rendering.

Use this method in REQUEST_UPDATE() pass to tell the view if the representation requires a particular mode. Note, only use this to "require" a remote or local render. value == true indicates that the representation requires distributed rendering, value == false indicates the representation can only render property on the client or root node.

◆ SetRequiresDistributedRenderingLOD()

static void vtkPVRenderView::SetRequiresDistributedRenderingLOD ( vtkInformation info,
vtkPVDataRepresentation repr,
bool  value 
)
inlinestatic

Some representation only work when remote rendering or local rendering.

Use this method in REQUEST_UPDATE() pass to tell the view if the representation requires a particular mode. Note, only use this to "require" a remote or local render. value == true indicates that the representation requires distributed rendering, value == false indicates the representation can only render property on the client or root node.

Definition at line 567 of file vtkPVRenderView.h.

◆ SetForceDataDistributionMode()

static void vtkPVRenderView::SetForceDataDistributionMode ( vtkInformation info,
int  flag 
)
static

This is an temporary/experimental option and may be removed without notice.

This is intended to be used within some experimental representations that require that all data being moved around uses a specific mode rather than the one automatically determined based on the process type. Set flag to -1 to clear. The flag is cleared in every vtkPVRenderView::Update() call, hence a representation must set it in vtkPVView::REQUEST_UPDATE() pass if needed each time. Also note, if the value it set to non-negative and is not equal to vtkMPIMoveData::PASS_THROUGH, ordered compositing will also be disabled.

◆ IsForceDataDistributionModeSet()

bool vtkPVRenderView::IsForceDataDistributionModeSet ( ) const
inline

This is an temporary/experimental option and may be removed without notice.

This is intended to be used within some experimental representations that require that all data being moved around uses a specific mode rather than the one automatically determined based on the process type. Set flag to -1 to clear. The flag is cleared in every vtkPVRenderView::Update() call, hence a representation must set it in vtkPVView::REQUEST_UPDATE() pass if needed each time. Also note, if the value it set to non-negative and is not equal to vtkMPIMoveData::PASS_THROUGH, ordered compositing will also be disabled.

Definition at line 588 of file vtkPVRenderView.h.

◆ GetForceDataDistributionMode()

int vtkPVRenderView::GetForceDataDistributionMode ( ) const
inline

This is an temporary/experimental option and may be removed without notice.

This is intended to be used within some experimental representations that require that all data being moved around uses a specific mode rather than the one automatically determined based on the process type. Set flag to -1 to clear. The flag is cleared in every vtkPVRenderView::Update() call, hence a representation must set it in vtkPVView::REQUEST_UPDATE() pass if needed each time. Also note, if the value it set to non-negative and is not equal to vtkMPIMoveData::PASS_THROUGH, ordered compositing will also be disabled.

Definition at line 589 of file vtkPVRenderView.h.

◆ RegisterPropForHardwareSelection()

int vtkPVRenderView::RegisterPropForHardwareSelection ( vtkPVDataRepresentation repr,
vtkProp prop 
)

Representations that support hardware (render-buffer based) selection, should register the prop that they use for selection rendering.

They can do that in the vtkPVDataRepresentation::AddToView() implementation.

◆ UnRegisterPropForHardwareSelection()

void vtkPVRenderView::UnRegisterPropForHardwareSelection ( vtkPVDataRepresentation repr,
vtkProp prop 
)

Representations that support hardware (render-buffer based) selection, should register the prop that they use for selection rendering.

They can do that in the vtkPVDataRepresentation::AddToView() implementation.

◆ SetShowAnnotation()

void vtkPVRenderView::SetShowAnnotation ( bool  val)

Enable/disable showing of annotation for developers.

◆ SetUpdateAnnotation()

virtual void vtkPVRenderView::SetUpdateAnnotation ( bool  )
virtual

Enable/disable showing of annotation for developers.

◆ SetAnnotationColor()

void vtkPVRenderView::SetAnnotationColor ( double  r,
double  g,
double  b 
)

Set color of annotation text for developers.

◆ SetGridAxes3DActor()

virtual void vtkPVRenderView::SetGridAxes3DActor ( vtkPVGridAxes3DActor )
virtual

Set the vtkPVGridAxes3DActor to use for the view.

Reimplemented in vtkPVOrthographicSliceView.

◆ SetOrientationAxesInteractivity()

virtual void vtkPVRenderView::SetOrientationAxesInteractivity ( bool  )
virtual

◆ SetOrientationAxesVisibility()

virtual void vtkPVRenderView::SetOrientationAxesVisibility ( bool  )
virtual

◆ SetOrientationAxesLabelColor()

void vtkPVRenderView::SetOrientationAxesLabelColor ( double  r,
double  g,
double  b 
)

◆ SetOrientationAxesOutlineColor()

void vtkPVRenderView::SetOrientationAxesOutlineColor ( double  r,
double  g,
double  b 
)

◆ SetCenterAxesVisibility()

virtual void vtkPVRenderView::SetCenterAxesVisibility ( bool  )
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetCenterOfRotation()

virtual void vtkPVRenderView::SetCenterOfRotation ( double  x,
double  y,
double  z 
)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetRotationFactor()

virtual void vtkPVRenderView::SetRotationFactor ( double  factor)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetKeyLightWarmth()

void vtkPVRenderView::SetKeyLightWarmth ( double  val)

◆ SetKeyLightIntensity()

void vtkPVRenderView::SetKeyLightIntensity ( double  val)

◆ SetKeyLightElevation()

void vtkPVRenderView::SetKeyLightElevation ( double  val)

◆ SetKeyLightAzimuth()

void vtkPVRenderView::SetKeyLightAzimuth ( double  val)

◆ SetFillLightWarmth()

void vtkPVRenderView::SetFillLightWarmth ( double  val)

◆ SetKeyToFillRatio()

void vtkPVRenderView::SetKeyToFillRatio ( double  val)

◆ SetFillLightElevation()

void vtkPVRenderView::SetFillLightElevation ( double  val)

◆ SetFillLightAzimuth()

void vtkPVRenderView::SetFillLightAzimuth ( double  val)

◆ SetBackLightWarmth()

void vtkPVRenderView::SetBackLightWarmth ( double  val)

◆ SetKeyToBackRatio()

void vtkPVRenderView::SetKeyToBackRatio ( double  val)

◆ SetBackLightElevation()

void vtkPVRenderView::SetBackLightElevation ( double  val)

◆ SetBackLightAzimuth()

void vtkPVRenderView::SetBackLightAzimuth ( double  val)

◆ SetHeadLightWarmth()

void vtkPVRenderView::SetHeadLightWarmth ( double  val)

◆ SetKeyToHeadRatio()

void vtkPVRenderView::SetKeyToHeadRatio ( double  val)

◆ SetMaintainLuminance()

void vtkPVRenderView::SetMaintainLuminance ( int  val)

◆ SetUseHiddenLineRemoval()

virtual void vtkPVRenderView::SetUseHiddenLineRemoval ( bool  )
virtual

◆ SetUseDepthPeeling()

virtual void vtkPVRenderView::SetUseDepthPeeling ( int  val)
virtual

◆ SetUseDepthPeelingForVolumes()

virtual void vtkPVRenderView::SetUseDepthPeelingForVolumes ( bool  val)
virtual

◆ SetMaximumNumberOfPeels()

virtual void vtkPVRenderView::SetMaximumNumberOfPeels ( int  val)
virtual

◆ SetBackground()

virtual void vtkPVRenderView::SetBackground ( double  r,
double  g,
double  b 
)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetBackground2()

virtual void vtkPVRenderView::SetBackground2 ( double  r,
double  g,
double  b 
)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetBackgroundTexture()

virtual void vtkPVRenderView::SetBackgroundTexture ( vtkTexture val)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetGradientBackground()

virtual void vtkPVRenderView::SetGradientBackground ( int  val)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetTexturedBackground()

virtual void vtkPVRenderView::SetTexturedBackground ( int  val)
virtual

Reimplemented in vtkPVOrthographicSliceView.

◆ SetSkyboxBackground()

virtual void vtkPVRenderView::SetSkyboxBackground ( int  val)
virtual

◆ SetUseEnvironmentLighting()

virtual void vtkPVRenderView::SetUseEnvironmentLighting ( bool  val)
virtual

◆ SetEnvironmentalBG()

virtual void vtkPVRenderView::SetEnvironmentalBG ( double  r,
double  g,
double  b 
)
virtual

◆ SetEnvironmentalBG2()

virtual void vtkPVRenderView::SetEnvironmentalBG2 ( double  r,
double  g,
double  b 
)
virtual

◆ SetEnvironmentalBGTexture()

virtual void vtkPVRenderView::SetEnvironmentalBGTexture ( vtkTexture val)
virtual

◆ SetGradientEnvironmentalBG()

virtual void vtkPVRenderView::SetGradientEnvironmentalBG ( int  val)
virtual

◆ SetTexturedEnvironmentalBG()

virtual void vtkPVRenderView::SetTexturedEnvironmentalBG ( int  val)
virtual

◆ SetBackgroundMode()

virtual void vtkPVRenderView::SetBackgroundMode ( int  val)
virtual

◆ AddLight()

void vtkPVRenderView::AddLight ( vtkLight )

◆ RemoveLight()

void vtkPVRenderView::RemoveLight ( vtkLight )

◆ SetStereoCapableWindow()

void vtkPVRenderView::SetStereoCapableWindow ( int  val)

◆ SetStereoRender()

void vtkPVRenderView::SetStereoRender ( int  val)

◆ SetStereoType()

virtual void vtkPVRenderView::SetStereoType ( int  )
virtual

◆ SetServerStereoType()

virtual void vtkPVRenderView::SetServerStereoType ( int  )
virtual

◆ SetMultiSamples()

void vtkPVRenderView::SetMultiSamples ( int  val)

◆ SetAlphaBitPlanes()

void vtkPVRenderView::SetAlphaBitPlanes ( int  val)

◆ SetStencilCapable()

void vtkPVRenderView::SetStencilCapable ( int  val)

◆ SetParallelProjection()

void vtkPVRenderView::SetParallelProjection ( int  mode)

◆ SetCamera2DManipulators()

virtual void vtkPVRenderView::SetCamera2DManipulators ( const int  manipulators[9])
virtual

◆ SetCamera3DManipulators()

virtual void vtkPVRenderView::SetCamera3DManipulators ( const int  manipulators[9])
virtual

◆ SetCameraManipulators()

void vtkPVRenderView::SetCameraManipulators ( vtkPVInteractorStyle style,
const int  manipulators[9] 
)

◆ SetCamera2DMouseWheelMotionFactor()

virtual void vtkPVRenderView::SetCamera2DMouseWheelMotionFactor ( double  factor)
virtual

◆ SetCamera3DMouseWheelMotionFactor()

virtual void vtkPVRenderView::SetCamera3DMouseWheelMotionFactor ( double  factor)
virtual

◆ Update()

void vtkPVRenderView::Update ( )
overridevirtual

Overridden to synchronize information among processes whenever data changes.

The vtkSMViewProxy ensures that this method is called only when something has changed on the view-proxy or one of its representations or their inputs. Hence it's okay to do some extra inter-process communication here.

Reimplemented from vtkView.

◆ UpdateLOD()

virtual void vtkPVRenderView::UpdateLOD ( )
virtual

Asks representations to update their LOD geometries.

◆ GetUseLODForInteractiveRender()

virtual bool vtkPVRenderView::GetUseLODForInteractiveRender ( )
virtual

Returns whether the view will use LOD rendering for the next InteractiveRender() call based on the geometry sizes determined by the most recent call to Update().

◆ GetUseDistributedRenderingForRender()

virtual bool vtkPVRenderView::GetUseDistributedRenderingForRender ( )
virtual

Returns whether the view will use distributed rendering for the next full-resolution render.

This uses the full resolution geometry sizes as determined by the most recent call to Update.

◆ GetUseDistributedRenderingForLODRender()

virtual bool vtkPVRenderView::GetUseDistributedRenderingForLODRender ( )
virtual

Returns whether the view will use distributed rendering for the next low-resolution render.

This uses the low-resolution (or LOD) geometry sizes as determined by the most recent call to UpdateLOD.

◆ GetStillRenderProcesses()

virtual vtkTypeUInt32 vtkPVRenderView::GetStillRenderProcesses ( )
virtual

Returns the processes (vtkPVSession::ServerFlags) that are to be involved in the next StillRender() call based on the decisions made during the most recent Update().

◆ GetInteractiveRenderProcesses()

virtual vtkTypeUInt32 vtkPVRenderView::GetInteractiveRenderProcesses ( )
virtual

Returns the processes (vtkPVSession::ServerFlags) that are to be involved in the next InteractiveRender() call based on the decisions made during the most recent Update() and UpdateLOD().

◆ GetDataDistributionMode()

int vtkPVRenderView::GetDataDistributionMode ( bool  low_res)

Returns the data distribution mode to use.

◆ Deliver()

void vtkPVRenderView::Deliver ( int  use_lod,
unsigned int  size,
unsigned int representation_ids 
)
overridevirtual

Called on all processes to request data-delivery for the list of representations.

Note this method has to be called on all processes or it may lead to deadlock.

Reimplemented from vtkPVView.

◆ GetUseOrderedCompositing()

bool vtkPVRenderView::GetUseOrderedCompositing ( )

Returns true when ordered compositing is needed on the current group of processes.

Note that unlike most other functions, this may return different values on different processes e.g.

  • always false on client and dataserver
  • true on pvserver or renderserver if opacity < 1 or volume present, else false

◆ GetRenderEmptyImages()

bool vtkPVRenderView::GetRenderEmptyImages ( )

Returns true when the compositor should not use the empty images optimization.

◆ SetUseFXAA()

virtual void vtkPVRenderView::SetUseFXAA ( bool  )
virtual

Enable/disable FXAA antialiasing.

◆ GetUseFXAA()

virtual bool vtkPVRenderView::GetUseFXAA ( )
virtual

Enable/disable FXAA antialiasing.

◆ SetFXAARelativeContrastThreshold()

void vtkPVRenderView::SetFXAARelativeContrastThreshold ( double  val)

FXAA tunable parameters.

See vtkFXAAOptions for details.

◆ SetFXAAHardContrastThreshold()

void vtkPVRenderView::SetFXAAHardContrastThreshold ( double  val)

FXAA tunable parameters.

See vtkFXAAOptions for details.

◆ SetFXAASubpixelBlendLimit()

void vtkPVRenderView::SetFXAASubpixelBlendLimit ( double  val)

FXAA tunable parameters.

See vtkFXAAOptions for details.

◆ SetFXAASubpixelContrastThreshold()

void vtkPVRenderView::SetFXAASubpixelContrastThreshold ( double  val)

FXAA tunable parameters.

See vtkFXAAOptions for details.

◆ SetFXAAUseHighQualityEndpoints()

void vtkPVRenderView::SetFXAAUseHighQualityEndpoints ( bool  val)

FXAA tunable parameters.

See vtkFXAAOptions for details.

◆ SetFXAAEndpointSearchIterations()

void vtkPVRenderView::SetFXAAEndpointSearchIterations ( int  val)

FXAA tunable parameters.

See vtkFXAAOptions for details.

◆ CopyViewUpdateOptions()

void vtkPVRenderView::CopyViewUpdateOptions ( vtkPVRenderView otherView)

Copy internal fields that are used for rendering decision such as remote/local rendering, composite and so on.

This method was introduced for the quad view so internal views could use the decision that were made in the main view.

◆ AddPropToRenderer()

void vtkPVRenderView::AddPropToRenderer ( vtkProp prop)

Add props directly to the view.

◆ RemovePropFromRenderer()

void vtkPVRenderView::RemovePropFromRenderer ( vtkProp prop)

Add props directly to the view.

◆ SetDrawCells()

void vtkPVRenderView::SetDrawCells ( bool  choice)

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ SetArrayNameToDraw()

void vtkPVRenderView::SetArrayNameToDraw ( const char *  name)

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ SetArrayNumberToDraw()

void vtkPVRenderView::SetArrayNumberToDraw ( int  fieldAttributeType)

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ SetArrayComponentToDraw()

void vtkPVRenderView::SetArrayComponentToDraw ( int  comp)

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ SetScalarRange()

void vtkPVRenderView::SetScalarRange ( double  min,
double  max 
)

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ BeginValueCapture()

void vtkPVRenderView::BeginValueCapture ( )

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ EndValueCapture()

void vtkPVRenderView::EndValueCapture ( )

Tells view that it should draw a particular array component to the screen such that the pixels can be read back and decoded to obtain the values.

◆ SetValueRenderingModeCommand()

void vtkPVRenderView::SetValueRenderingModeCommand ( int  mode)

Current rendering mode of vtkValuePass (float or invertible RGB).

@deprecation Invertible is deprecated, so this currently does nothing and will be removed.

◆ GetValueRenderingModeCommand()

int vtkPVRenderView::GetValueRenderingModeCommand ( )

Current rendering mode of vtkValuePass (float or invertible RGB).

@deprecation Invertible is deprecated, so this currently does nothing and will be removed.

◆ CaptureValuesFloat()

void vtkPVRenderView::CaptureValuesFloat ( )

Access to vtkValuePass::FLOATING_POINT mode rendered image.

vtkValuePass's internal FBO is accessed directly when rendering locally. When rendering in parallel, IceT composites the intermediate results from vtkValuePass and the final result is accessed through vtkIceTCompositePass. Float value rendering is only supported in BATCH mode and in CLIENT mode (local rendering). These methods do nothing if INVERTIBLE_LUT mode is active.

◆ GetCapturedValuesFloat()

vtkFloatArray* vtkPVRenderView::GetCapturedValuesFloat ( )

Access to vtkValuePass::FLOATING_POINT mode rendered image.

vtkValuePass's internal FBO is accessed directly when rendering locally. When rendering in parallel, IceT composites the intermediate results from vtkValuePass and the final result is accessed through vtkIceTCompositePass. Float value rendering is only supported in BATCH mode and in CLIENT mode (local rendering). These methods do nothing if INVERTIBLE_LUT mode is active.

◆ StartCaptureLuminance()

void vtkPVRenderView::StartCaptureLuminance ( )

Tells views that it should draw the lighting contributions to the framebuffer.

◆ StopCaptureLuminance()

void vtkPVRenderView::StopCaptureLuminance ( )

Tells views that it should draw the lighting contributions to the framebuffer.

◆ CaptureZBuffer()

void vtkPVRenderView::CaptureZBuffer ( )

Access to the Z buffer.

◆ GetCapturedZBuffer()

vtkFloatArray* vtkPVRenderView::GetCapturedZBuffer ( )

Access to the Z buffer.

◆ SetEnableOSPRay()

void vtkPVRenderView::SetEnableOSPRay ( bool  )

Switches between rasterization and ray tracing.

◆ GetEnableOSPRay()

bool vtkPVRenderView::GetEnableOSPRay ( )

Switches between rasterization and ray tracing.

◆ SetShadows()

void vtkPVRenderView::SetShadows ( bool  )

Controls whether OSPRay sends casts shadow rays or not.

◆ GetShadows()

bool vtkPVRenderView::GetShadows ( )

Controls whether OSPRay sends casts shadow rays or not.

◆ SetAmbientOcclusionSamples()

void vtkPVRenderView::SetAmbientOcclusionSamples ( int  )

Sets the number of occlusion query rays that OSPRay sends at each intersection.

◆ GetAmbientOcclusionSamples()

int vtkPVRenderView::GetAmbientOcclusionSamples ( )

Sets the number of occlusion query rays that OSPRay sends at each intersection.

◆ SetSamplesPerPixel()

void vtkPVRenderView::SetSamplesPerPixel ( int  )

Set the number of primary rays that OSPRay shoots per pixel.

◆ GetSamplesPerPixel()

int vtkPVRenderView::GetSamplesPerPixel ( )

Set the number of primary rays that OSPRay shoots per pixel.

◆ SetMaxFrames()

void vtkPVRenderView::SetMaxFrames ( int  )

Set the number of render passes OSPRay takes to accumulate subsampled color results.

◆ GetMaxFrames()

int vtkPVRenderView::GetMaxFrames ( )

Set the number of render passes OSPRay takes to accumulate subsampled color results.

◆ GetOSPRayContinueStreaming()

bool vtkPVRenderView::GetOSPRayContinueStreaming ( )

Has OSPRay reached the max frames?

◆ SetDenoise()

void vtkPVRenderView::SetDenoise ( bool  )

Controls whether to use image denoising to improve appearance.

◆ GetDenoise()

bool vtkPVRenderView::GetDenoise ( )

Controls whether to use image denoising to improve appearance.

◆ SetLightScale()

void vtkPVRenderView::SetLightScale ( double  )

Dimish or Amplify all lights in the scene.

◆ GetLightScale()

double vtkPVRenderView::GetLightScale ( )

Dimish or Amplify all lights in the scene.

◆ SetOSPRayRendererType()

void vtkPVRenderView::SetOSPRayRendererType ( std::string  )

Set the OSPRay renderer to use.

May be either scivis (default) or pathtracer.

◆ SetBackgroundNorth()

void vtkPVRenderView::SetBackgroundNorth ( double  x,
double  y,
double  z 
)

Control of background orientation for OSPRay.

◆ SetBackgroundEast()

void vtkPVRenderView::SetBackgroundEast ( double  x,
double  y,
double  z 
)

Control of background orientation for OSPRay.

◆ SetMaterialLibrary()

virtual void vtkPVRenderView::SetMaterialLibrary ( vtkPVMaterialLibrary )
virtual

For OSPRay, set the library of materials.

◆ SetViewTime()

void vtkPVRenderView::SetViewTime ( double  value)
overridevirtual

Get/Set the time this view is showing.

Note
CallOnAllProcesses

Reimplemented from vtkPVView.

◆ SetTimeCacheSize()

void vtkPVRenderView::SetTimeCacheSize ( int  )

Set the size of OSPRay's temporal cache.

◆ GetTimeCacheSize()

int vtkPVRenderView::GetTimeCacheSize ( )

Set the size of OSPRay's temporal cache.

◆ GetDiscreteCameras()

static vtkPVCameraCollection* vtkPVRenderView::GetDiscreteCameras ( vtkInformation info,
vtkPVDataRepresentation repr 
)
static

DiscreteCameras are a collection of cameras when specified, forces the view to only interact to a camera in the collection.

In vtkPVView::REQUEST_UPDATE() pass, representations may request the view to use discrete cameras by providing a vtkPVCameraCollection to the view. Since multiple representations may be visible in the view, it's up to the representations how to handle multiple representations providing different styles.

When set, on each render, vtkPVRenderView will try to update the current camera to match a camera in the collection. During interacting, however, the snapping to a camera in the collection is only done when the snapped to camera is different from the previous. This avoids side effects on camera manipulators that simply update existing camera positions during interaction.

Note
Since this is supposed to set in vtkPVView::REQUEST_UPDATE(), it is unset before the pass is triggered.
Warning
This is a new/experimental feature that was added to support viewing of Cinema databases in ParaView. As the support for Cinema in ParaView improve, this is likely to change.

◆ SetDiscreteCameras()

static void vtkPVRenderView::SetDiscreteCameras ( vtkInformation info,
vtkPVDataRepresentation repr,
vtkPVCameraCollection style 
)
static

DiscreteCameras are a collection of cameras when specified, forces the view to only interact to a camera in the collection.

In vtkPVView::REQUEST_UPDATE() pass, representations may request the view to use discrete cameras by providing a vtkPVCameraCollection to the view. Since multiple representations may be visible in the view, it's up to the representations how to handle multiple representations providing different styles.

When set, on each render, vtkPVRenderView will try to update the current camera to match a camera in the collection. During interacting, however, the snapping to a camera in the collection is only done when the snapped to camera is different from the previous. This avoids side effects on camera manipulators that simply update existing camera positions during interaction.

Note
Since this is supposed to set in vtkPVView::REQUEST_UPDATE(), it is unset before the pass is triggered.
Warning
This is a new/experimental feature that was added to support viewing of Cinema databases in ParaView. As the support for Cinema in ParaView improve, this is likely to change.

◆ GetRenderView()

virtual vtkRenderViewBase* vtkPVRenderView::GetRenderView ( )
virtual

◆ ScaleRendererViewports()

void vtkPVRenderView::ScaleRendererViewports ( const double  viewport[4])
overridevirtual

Overridden to scale the OrientationWidget appropriately.

Reimplemented from vtkPVView.

◆ SynchronizeMaximumIds()

void vtkPVRenderView::SynchronizeMaximumIds ( vtkIdType maxPointId,
vtkIdType maxCellId 
)

This is used by vtkPVHardwareSelector to synchronize element ids between all ranks involved in selection.

◆ Render()

virtual void vtkPVRenderView::Render ( bool  interactive,
bool  skip_rendering 
)
protectedvirtual

Actual render method.

◆ AboutToRenderOnLocalProcess()

virtual void vtkPVRenderView::AboutToRenderOnLocalProcess ( bool  interactive)
inlineprotectedvirtual

Called just before the local process renders.

This is only called on the nodes where the rendering is going to happen.

Reimplemented in vtkPVOrthographicSliceView, and vtkPVMultiSliceView.

Definition at line 1019 of file vtkPVRenderView.h.

◆ ShouldUseDistributedRendering()

bool vtkPVRenderView::ShouldUseDistributedRendering ( double  geometry_size,
bool  using_lod 
)
protected

Returns true if distributed rendering should be used based on the geometry size.

using_lod will be true if this method is called to determine distributed rendering status for renders using lower LOD i.e when called in UpdateLOD().

◆ ShouldUseLODRendering()

bool vtkPVRenderView::ShouldUseLODRendering ( double  geometry)
protected

Returns true if LOD rendering should be used based on the geometry size.

◆ IsProcessRenderingGeometriesForCompositing()

bool vtkPVRenderView::IsProcessRenderingGeometriesForCompositing ( bool  using_distributed_rendering)
protected

Returns true if the local process is invovled in rendering composited geometry i.e.

geometry rendered in view that is composited together.

◆ SynchronizeGeometryBounds()

void vtkPVRenderView::SynchronizeGeometryBounds ( )
protected

Synchronizes bounds information on all nodes.

Note
CallOnAllProcesses

◆ SetLastSelection()

void vtkPVRenderView::SetLastSelection ( vtkSelection )
protected

Set the last selection object.

◆ UpdateCenterAxes()

virtual void vtkPVRenderView::UpdateCenterAxes ( )
protectedvirtual

UpdateCenterAxes().

Updates CenterAxes's scale and position.

Reimplemented in vtkPVOrthographicSliceView.

◆ GetLocalProcessDoesRendering()

bool vtkPVRenderView::GetLocalProcessDoesRendering ( bool  using_distributed_rendering)
protected

Returns true if the local process is doing to do actual render or displaying an image in a viewport.

◆ TestCollaborationCounter()

bool vtkPVRenderView::TestCollaborationCounter ( )
protected

In multi-clients mode, ensures that all processes are in the same "state" as far as the view is concerned.

Returns false if that's not the case.

◆ SynchronizeForCollaboration()

void vtkPVRenderView::SynchronizeForCollaboration ( )
protected

Synchronizes remote-rendering related parameters for collaborative rendering in multi-clients mode.

◆ BuildAnnotationText()

virtual void vtkPVRenderView::BuildAnnotationText ( ostream &  str)
protectedvirtual

Method to build annotation text to annotate the view with runtime information.

◆ GetSynchronizationCounter()

virtual unsigned int vtkPVRenderView::GetSynchronizationCounter ( )
protectedvirtual

SynchronizationCounter is used in multi-clients mode to ensure that the views on two different clients are in the same state as the server side.

◆ GetMakingSelection()

virtual bool vtkPVRenderView::GetMakingSelection ( )
protectedvirtual

Returns true is currently generating a selection.

◆ PrepareSelect()

bool vtkPVRenderView::PrepareSelect ( int  fieldAssociation,
const char *  array = nullptr 
)
protected

Prepare for selection.

Returns false if it is currently generating a selection.

◆ PostSelect()

void vtkPVRenderView::PostSelect ( vtkSelection sel,
const char *  array = nullptr 
)
protected

Post process after selection.

◆ UpdateSkybox()

void vtkPVRenderView::UpdateSkybox ( )
protected

Update skybox actor.

Member Data Documentation

◆ LightKit

vtkLightKit* vtkPVRenderView::LightKit
protected

Definition at line 1112 of file vtkPVRenderView.h.

◆ RenderView

vtkRenderViewBase* vtkPVRenderView::RenderView
protected

Definition at line 1113 of file vtkPVRenderView.h.

◆ NonCompositedRenderer

vtkRenderer* vtkPVRenderView::NonCompositedRenderer
protected

Definition at line 1114 of file vtkPVRenderView.h.

◆ SynchronizedRenderers

vtkPVSynchronizedRenderer* vtkPVRenderView::SynchronizedRenderers
protected

Definition at line 1115 of file vtkPVRenderView.h.

◆ Interactor

vtkSmartPointer<vtkRenderWindowInteractor> vtkPVRenderView::Interactor
protected

Definition at line 1116 of file vtkPVRenderView.h.

◆ RubberBandStyle

vtkInteractorStyleRubberBand3D* vtkPVRenderView::RubberBandStyle
protected

Definition at line 1117 of file vtkPVRenderView.h.

◆ RubberBandZoom

vtkInteractorStyleRubberBandZoom* vtkPVRenderView::RubberBandZoom
protected

Definition at line 1118 of file vtkPVRenderView.h.

◆ PolygonStyle

vtkInteractorStyleDrawPolygon* vtkPVRenderView::PolygonStyle
protected

Definition at line 1119 of file vtkPVRenderView.h.

◆ CenterAxes

vtkPVCenterAxesActor* vtkPVRenderView::CenterAxes
protected

Definition at line 1120 of file vtkPVRenderView.h.

◆ OrientationWidget

vtkPVAxesWidget* vtkPVRenderView::OrientationWidget
protected

Definition at line 1121 of file vtkPVRenderView.h.

◆ Selector

vtkPVHardwareSelector* vtkPVRenderView::Selector
protected

Definition at line 1122 of file vtkPVRenderView.h.

◆ LastSelection

vtkSelection* vtkPVRenderView::LastSelection
protected

Definition at line 1123 of file vtkPVRenderView.h.

◆ GridAxes3DActor

vtkSmartPointer<vtkPVGridAxes3DActor> vtkPVRenderView::GridAxes3DActor
protected

Definition at line 1124 of file vtkPVRenderView.h.

◆ Skybox

vtkNew<vtkSkybox> vtkPVRenderView::Skybox
protected

Definition at line 1125 of file vtkPVRenderView.h.

◆ NeedSkybox

bool vtkPVRenderView::NeedSkybox = false
protected

Definition at line 1126 of file vtkPVRenderView.h.

◆ StillRenderImageReductionFactor

int vtkPVRenderView::StillRenderImageReductionFactor
protected

Definition at line 1128 of file vtkPVRenderView.h.

◆ InteractiveRenderImageReductionFactor

int vtkPVRenderView::InteractiveRenderImageReductionFactor
protected

Definition at line 1129 of file vtkPVRenderView.h.

◆ InteractionMode

int vtkPVRenderView::InteractionMode
protected

Definition at line 1130 of file vtkPVRenderView.h.

◆ ShowAnnotation

bool vtkPVRenderView::ShowAnnotation
protected

Definition at line 1131 of file vtkPVRenderView.h.

◆ UpdateAnnotation

bool vtkPVRenderView::UpdateAnnotation
protected

Definition at line 1132 of file vtkPVRenderView.h.

◆ SuppressRendering

bool vtkPVRenderView::SuppressRendering
protected

Definition at line 1141 of file vtkPVRenderView.h.

◆ TwoDInteractorStyle

vtkPVInteractorStyle* vtkPVRenderView::TwoDInteractorStyle
protected

Definition at line 1144 of file vtkPVRenderView.h.

◆ ThreeDInteractorStyle

vtkPVInteractorStyle* vtkPVRenderView::ThreeDInteractorStyle
protected

Definition at line 1145 of file vtkPVRenderView.h.

◆ InteractorStyle

vtkPVInteractorStyle* vtkPVRenderView::InteractorStyle
protected

Definition at line 1148 of file vtkPVRenderView.h.

◆ DiscreteCameras

vtkWeakPointer<vtkPVCameraCollection> vtkPVRenderView::DiscreteCameras
protected

Definition at line 1150 of file vtkPVRenderView.h.

◆ SynchronizationCounter

unsigned int vtkPVRenderView::SynchronizationCounter
protected

Definition at line 1154 of file vtkPVRenderView.h.

◆ RemoteRenderingThreshold

double vtkPVRenderView::RemoteRenderingThreshold
protected

Definition at line 1157 of file vtkPVRenderView.h.

◆ LODRenderingThreshold

double vtkPVRenderView::LODRenderingThreshold
protected

Definition at line 1158 of file vtkPVRenderView.h.

◆ GeometryBounds

vtkBoundingBox vtkPVRenderView::GeometryBounds
protected

Definition at line 1159 of file vtkPVRenderView.h.

◆ UseInteractiveRenderingForScreenshots

bool vtkPVRenderView::UseInteractiveRenderingForScreenshots
protected

Definition at line 1161 of file vtkPVRenderView.h.

◆ NeedsOrderedCompositing

bool vtkPVRenderView::NeedsOrderedCompositing
protected

Definition at line 1162 of file vtkPVRenderView.h.

◆ RenderEmptyImages

bool vtkPVRenderView::RenderEmptyImages
protected

Definition at line 1163 of file vtkPVRenderView.h.

◆ UseFXAA

bool vtkPVRenderView::UseFXAA
protected

Definition at line 1165 of file vtkPVRenderView.h.

◆ FXAAOptions

vtkNew<vtkFXAAOptions> vtkPVRenderView::FXAAOptions
protected

Definition at line 1166 of file vtkPVRenderView.h.

◆ LODResolution

double vtkPVRenderView::LODResolution
protected

Definition at line 1168 of file vtkPVRenderView.h.

◆ UseLightKit

bool vtkPVRenderView::UseLightKit
protected

Definition at line 1169 of file vtkPVRenderView.h.

◆ UsedLODForLastRender

bool vtkPVRenderView::UsedLODForLastRender
protected

Definition at line 1171 of file vtkPVRenderView.h.

◆ UseLODForInteractiveRender

bool vtkPVRenderView::UseLODForInteractiveRender
protected

Definition at line 1172 of file vtkPVRenderView.h.

◆ UseOutlineForLODRendering

bool vtkPVRenderView::UseOutlineForLODRendering
protected

Definition at line 1173 of file vtkPVRenderView.h.

◆ UseDistributedRenderingForRender

bool vtkPVRenderView::UseDistributedRenderingForRender
protected

Definition at line 1174 of file vtkPVRenderView.h.

◆ UseDistributedRenderingForLODRender

bool vtkPVRenderView::UseDistributedRenderingForLODRender
protected

Definition at line 1175 of file vtkPVRenderView.h.

◆ StillRenderProcesses

vtkTypeUInt32 vtkPVRenderView::StillRenderProcesses
protected

Definition at line 1177 of file vtkPVRenderView.h.

◆ InteractiveRenderProcesses

vtkTypeUInt32 vtkPVRenderView::InteractiveRenderProcesses
protected

Definition at line 1178 of file vtkPVRenderView.h.

◆ PriorityQueueBuildTimeStamp

vtkTimeStamp vtkPVRenderView::PriorityQueueBuildTimeStamp
protected

Keeps track of the time when the priority-queue for streaming was generated.

Definition at line 1184 of file vtkPVRenderView.h.

◆ LockBounds

bool vtkPVRenderView::LockBounds
protected

Definition at line 1186 of file vtkPVRenderView.h.


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