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

representation for showing vtkStructuredGrid datasets as volumes. More...

#include <vtkStructuredGridVolumeRepresentation.h>

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

Public Types

typedef vtkUnstructuredGridVolumeRepresentation Superclass
 
- Public Types inherited from vtkUnstructuredGridVolumeRepresentation
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)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
void SetUseDataPartitions (bool)
 When on (default), the representation tells the view to use the partitioning information from the input structured grid for ordered compositing. More...
 
virtual bool GetUseDataPartitions ()
 When on (default), the representation tells the view to use the partitioning information from the input structured grid for ordered compositing. More...
 
- Public Member Functions inherited from vtkUnstructuredGridVolumeRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
void AddVolumeMapper (const char *name, vtkUnstructuredGridVolumeMapper *)
 Register a volume mapper with the representation. More...
 
virtual void MarkModified ()
 This needs to be called on all instances of vtkGeometryRepresentation when the input is modified. More...
 
virtual void SetVisibility (bool val)
 Get/Set the visibility for this representation. More...
 
void SetExtractedBlockIndex (unsigned int index)
 
void SetOrientation (double, double, double)
 
void SetOrigin (double, double, double)
 
void SetPickable (int val)
 
void SetPosition (double, double, double)
 
void SetScale (double, double, double)
 
void SetInterpolationType (int val)
 
void SetColor (vtkColorTransferFunction *lut)
 
void SetScalarOpacity (vtkPiecewiseFunction *pwf)
 
void SetScalarOpacityUnitDistance (double val)
 
vtkPVLODVolumeGetActor ()
 Provides access to the actor used by this representation. More...
 
virtual void SetActiveVolumeMapper (const char *)
 Set the active volume mapper to use. More...
 
vtkUnstructuredGridVolumeMapper * GetActiveVolumeMapper ()
 Set the active volume mapper to use. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
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 vtkStructuredGridVolumeRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkStructuredGridVolumeRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkUnstructuredGridVolumeRepresentation
static vtkUnstructuredGridVolumeRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkUnstructuredGridVolumeRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkStructuredGridVolumeRepresentation ()
 
 ~vtkStructuredGridVolumeRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
- Protected Member Functions inherited from vtkUnstructuredGridVolumeRepresentation
 vtkUnstructuredGridVolumeRepresentation ()
 
 ~vtkUnstructuredGridVolumeRepresentation ()
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
virtual bool IsCached (double cache_key)
 Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...
 
virtual void UpdateMapperParameters ()
 Passes on parameters to the active volume mapper. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

bool UseDataPartitions
 
vtkTableExtentTranslatorTableExtentTranslator
 
- Protected Attributes inherited from vtkUnstructuredGridVolumeRepresentation
vtkVolumeRepresentationPreprocessorPreprocessor
 
vtkPVCacheKeeperCacheKeeper
 
vtkProjectedTetrahedraMapper * DefaultMapper
 
vtkVolumeProperty * Property
 
vtkPVLODVolumeActor
 
vtkPVGeometryFilterLODGeometryFilter
 
vtkPolyDataMapper * LODMapper
 
double DataBounds [6]
 
bool UseDataPartitions
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

representation for showing vtkStructuredGrid datasets as volumes.

vtkStructuredGridVolumeRepresentation is a representation for volume rendering vtkStructuredGrid datasets with one caveat: it assumes that the structured grid is not "curved" i.e. bounding boxes of non-intersecting extents don't intersect (or intersect negligibly). This is the default (and faster) method. Alternatively, one can set UseDataPartitions to off and the representation will simply rely on the view to build the sorting order using the unstructured grid. In which case, however data will be transferred among processing.

Definition at line 37 of file vtkStructuredGridVolumeRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkStructuredGridVolumeRepresentation.h.

Constructor & Destructor Documentation

◆ vtkStructuredGridVolumeRepresentation()

vtkStructuredGridVolumeRepresentation::vtkStructuredGridVolumeRepresentation ( )
protected

◆ ~vtkStructuredGridVolumeRepresentation()

vtkStructuredGridVolumeRepresentation::~vtkStructuredGridVolumeRepresentation ( )
protected

Member Function Documentation

◆ New()

static vtkStructuredGridVolumeRepresentation* vtkStructuredGridVolumeRepresentation::New ( )
static

◆ GetClassName()

virtual const char* vtkStructuredGridVolumeRepresentation::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetUseDataPartitions()

void vtkStructuredGridVolumeRepresentation::SetUseDataPartitions ( bool  )
virtual

When on (default), the representation tells the view to use the partitioning information from the input structured grid for ordered compositing.

When off we let the view build its own ordering and redistribute data as needed.

Reimplemented from vtkUnstructuredGridVolumeRepresentation.

◆ GetUseDataPartitions()

virtual bool vtkStructuredGridVolumeRepresentation::GetUseDataPartitions ( )
virtual

When on (default), the representation tells the view to use the partitioning information from the input structured grid for ordered compositing.

When off we let the view build its own ordering and redistribute data as needed.

Reimplemented from vtkUnstructuredGridVolumeRepresentation.

◆ ProcessViewRequest()

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

vtkAlgorithm::ProcessRequest() equivalent for rendering passes.

This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering.

Reimplemented from vtkUnstructuredGridVolumeRepresentation.

◆ FillInputPortInformation()

virtual int vtkStructuredGridVolumeRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Fill input port information.

Reimplemented from vtkUnstructuredGridVolumeRepresentation.

◆ RequestData()

virtual int vtkStructuredGridVolumeRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkUnstructuredGridVolumeRepresentation.

Member Data Documentation

◆ UseDataPartitions

bool vtkStructuredGridVolumeRepresentation::UseDataPartitions
protected

Definition at line 76 of file vtkStructuredGridVolumeRepresentation.h.

◆ TableExtentTranslator

vtkTableExtentTranslator* vtkStructuredGridVolumeRepresentation::TableExtentTranslator
protected

Definition at line 77 of file vtkStructuredGridVolumeRepresentation.h.


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