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

a simple outline representation for AMR datasets that supports streaming. More...

#include <vtkAMROutlineRepresentation.h>

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

Public Types

typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 Overridden to handle various view passes. More...
 
virtual void SetVisibility (bool val)
 Get/Set the visibility for this representation. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 This is one of the most important functions. More...
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Initialize the representation with an identifier range so each internal representation can own a unique ID. More...
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 

Static Public Member Functions

static vtkAMROutlineRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAMROutlineRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkAMROutlineRepresentation ()
 
 ~vtkAMROutlineRepresentation ()
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestInformation (vtkInformation *rqst, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Overridden to check if the input pipeline is streaming capable. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Setup the block request. More...
 
virtual int RequestData (vtkInformation *rqst, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Generate the outline for the current input. More...
 
bool StreamingUpdate (const double view_planes[24])
 Returns true if this representation has a "next piece" that it streamed. More...
 
virtual bool GetStreamingCapablePipeline ()
 Returns true when the input pipeline supports streaming. More...
 
virtual bool GetInStreamingUpdate ()
 Returns true when StreamingUpdate() is being processed. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual bool IsCached (double cache_key)
 Subclasses should override this method when they support caching to indicate if the particular key is cached. More...
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkSmartPointer< vtkDataObject > ProcessedData
 This is the data object generated processed by the most recent call to RequestData() while not streaming. More...
 
vtkSmartPointer< vtkDataObject > ProcessedPiece
 This is the data object generated processed by the most recent call to RequestData() while streaming. More...
 
vtkWeakPointer< vtkDataObject > RenderedData
 Helps us keep track of the data being rendered. More...
 
vtkSmartPointer< vtkAMRStreamingPriorityQueuePriorityQueue
 vtkAMRStreamingPriorityQueue is a helper class we used to compute the order in which to request blocks from the input pipeline. More...
 
vtkBoundingBox DataBounds
 Used to keep track of data bounds. More...
 
vtkSmartPointer< vtkCompositePolyDataMapper2 > Mapper
 Actor used to render the outlines in the view. More...
 
vtkSmartPointer< vtkPVLODActorActor
 Actor used to render the outlines in the view. More...
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

a simple outline representation for AMR datasets that supports streaming.

vtkAMROutlineRepresentation is a simple representation for Overlapping-AMR datasets that with streaming capabilities. It demonstrates how a representation can exploit streaming capabilities provided by ParaView's Render View (vtkPVRenderView).

Definition at line 38 of file vtkAMROutlineRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 43 of file vtkAMROutlineRepresentation.h.

Constructor & Destructor Documentation

§ vtkAMROutlineRepresentation()

vtkAMROutlineRepresentation::vtkAMROutlineRepresentation ( )
protected

§ ~vtkAMROutlineRepresentation()

vtkAMROutlineRepresentation::~vtkAMROutlineRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkAMROutlineRepresentation* vtkAMROutlineRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkAMROutlineRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVDataRepresentation.

§ SafeDownCast()

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

§ PrintSelf()

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

§ ProcessViewRequest()

virtual int vtkAMROutlineRepresentation::ProcessViewRequest ( vtkInformationRequestKey *  request_type,
vtkInformation *  inInfo,
vtkInformation *  outInfo 
)
virtual

Overridden to handle various view passes.

Reimplemented from vtkPVDataRepresentation.

§ SetVisibility()

virtual void vtkAMROutlineRepresentation::SetVisibility ( bool  val)
virtual

Get/Set the visibility for this representation.

When the visibility of representation of false, all view passes are ignored.

Reimplemented from vtkPVDataRepresentation.

§ AddToView()

virtual bool vtkAMROutlineRepresentation::AddToView ( vtkView *  view)
protectedvirtual

Adds the representation to the view.

This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Reimplemented from vtkPVDataRepresentation.

§ RemoveFromView()

virtual bool vtkAMROutlineRepresentation::RemoveFromView ( vtkView *  view)
protectedvirtual

Removes the representation to the view.

This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Reimplemented from vtkPVDataRepresentation.

§ FillInputPortInformation()

int vtkAMROutlineRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protected

Fill input port information.

§ RequestInformation()

virtual int vtkAMROutlineRepresentation::RequestInformation ( vtkInformation *  rqst,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Overridden to check if the input pipeline is streaming capable.

This method should check if streaming is enabled i.e. vtkPVView::GetEnableStreaming() and the input pipeline provides necessary AMR meta-data.

§ RequestUpdateExtent()

virtual int vtkAMROutlineRepresentation::RequestUpdateExtent ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Setup the block request.

During StreamingUpdate, this will request the blocks based on priorities determined by the vtkAMRStreamingPriorityQueue, otherwise it doesn't make any specific request. AMR sources can treat the absence of specific block request to mean various things. It's expected that read only the root block (or a few more) in that case.

Reimplemented from vtkPVDataRepresentation.

§ RequestData()

virtual int vtkAMROutlineRepresentation::RequestData ( vtkInformation *  rqst,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Generate the outline for the current input.

When not in StreamingUpdate, this also initializes the priority queue since the input AMR may have totally changed, including its structure.

Reimplemented from vtkPVDataRepresentation.

§ GetStreamingCapablePipeline()

virtual bool vtkAMROutlineRepresentation::GetStreamingCapablePipeline ( )
protectedvirtual

Returns true when the input pipeline supports streaming.

It is set in RequestInformation().

§ GetInStreamingUpdate()

virtual bool vtkAMROutlineRepresentation::GetInStreamingUpdate ( )
protectedvirtual

Returns true when StreamingUpdate() is being processed.

§ StreamingUpdate()

bool vtkAMROutlineRepresentation::StreamingUpdate ( const double  view_planes[24])
protected

Returns true if this representation has a "next piece" that it streamed.

This method will update the PriorityQueue using the view planes specified and then call Update() on the representation, making it reexecute and regenerate the outline for the next "piece" of data.

Member Data Documentation

§ ProcessedData

vtkSmartPointer<vtkDataObject> vtkAMROutlineRepresentation::ProcessedData
protected

This is the data object generated processed by the most recent call to RequestData() while not streaming.

This is non-empty only on the data-server nodes.

Definition at line 135 of file vtkAMROutlineRepresentation.h.

§ ProcessedPiece

vtkSmartPointer<vtkDataObject> vtkAMROutlineRepresentation::ProcessedPiece
protected

This is the data object generated processed by the most recent call to RequestData() while streaming.

This is non-empty only on the data-server nodes.

Definition at line 142 of file vtkAMROutlineRepresentation.h.

§ RenderedData

vtkWeakPointer<vtkDataObject> vtkAMROutlineRepresentation::RenderedData
protected

Helps us keep track of the data being rendered.

Definition at line 147 of file vtkAMROutlineRepresentation.h.

§ PriorityQueue

vtkSmartPointer<vtkAMRStreamingPriorityQueue> vtkAMROutlineRepresentation::PriorityQueue
protected

vtkAMRStreamingPriorityQueue is a helper class we used to compute the order in which to request blocks from the input pipeline.

Implementations can come up with their own rules to decide the request order based on application and data type.

Definition at line 155 of file vtkAMROutlineRepresentation.h.

§ Mapper

vtkSmartPointer<vtkCompositePolyDataMapper2> vtkAMROutlineRepresentation::Mapper
protected

Actor used to render the outlines in the view.

Definition at line 161 of file vtkAMROutlineRepresentation.h.

§ Actor

vtkSmartPointer<vtkPVLODActor> vtkAMROutlineRepresentation::Actor
protected

Actor used to render the outlines in the view.

Definition at line 162 of file vtkAMROutlineRepresentation.h.

§ DataBounds

vtkBoundingBox vtkAMROutlineRepresentation::DataBounds
protected

Used to keep track of data bounds.

Definition at line 168 of file vtkAMROutlineRepresentation.h.


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