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

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

#include <vtkUnstructuredGridVolumeRepresentation.h>

Inheritance diagram for vtkUnstructuredGridVolumeRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkUnstructuredGridVolumeRepresentation:
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)
 
void AddVolumeMapper (const char *name, vtkUnstructuredGridVolumeMapper *)
 Register a volume mapper with the representation. More...
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. 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...
 
virtual void SetUseDataPartitions (bool)
 Specify whether or not to redistribute the data. More...
 
virtual bool GetUseDataPartitions ()
 Specify whether or not to redistribute the data. 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 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

 vtkUnstructuredGridVolumeRepresentation ()
 
 ~vtkUnstructuredGridVolumeRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
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

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 vtkUnstructuredGrid datasets as volumes.

vtkUnstructuredGridVolumeRepresentation is a representation for volume rendering vtkUnstructuredGrid datasets. It simply renders a translucent surface for LOD i.e. interactive rendering.

Definition at line 45 of file vtkUnstructuredGridVolumeRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 50 of file vtkUnstructuredGridVolumeRepresentation.h.

Constructor & Destructor Documentation

§ vtkUnstructuredGridVolumeRepresentation()

vtkUnstructuredGridVolumeRepresentation::vtkUnstructuredGridVolumeRepresentation ( )
protected

§ ~vtkUnstructuredGridVolumeRepresentation()

vtkUnstructuredGridVolumeRepresentation::~vtkUnstructuredGridVolumeRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkUnstructuredGridVolumeRepresentation* vtkUnstructuredGridVolumeRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkUnstructuredGridVolumeRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ SafeDownCast()

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

§ PrintSelf()

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

§ AddVolumeMapper()

void vtkUnstructuredGridVolumeRepresentation::AddVolumeMapper ( const char *  name,
vtkUnstructuredGridVolumeMapper *   
)

Register a volume mapper with the representation.

§ SetActiveVolumeMapper()

virtual void vtkUnstructuredGridVolumeRepresentation::SetActiveVolumeMapper ( const char *  )
virtual

Set the active volume mapper to use.

§ GetActiveVolumeMapper()

vtkUnstructuredGridVolumeMapper* vtkUnstructuredGridVolumeRepresentation::GetActiveVolumeMapper ( )

Set the active volume mapper to use.

§ ProcessViewRequest()

virtual int vtkUnstructuredGridVolumeRepresentation::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 vtkPVDataRepresentation.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ MarkModified()

virtual void vtkUnstructuredGridVolumeRepresentation::MarkModified ( )
virtual

This needs to be called on all instances of vtkGeometryRepresentation when the input is modified.

This is essential since the geometry filter does not have any real-input on the client side which messes with the Update requests.

Reimplemented from vtkPVDataRepresentation.

§ SetVisibility()

virtual void vtkUnstructuredGridVolumeRepresentation::SetVisibility ( bool  val)
virtual

Get/Set the visibility for this representation.

When the visibility of representation of false, all view passes are ignored. Overridden to propagate to the active representation.

Reimplemented from vtkPVDataRepresentation.

§ SetExtractedBlockIndex()

void vtkUnstructuredGridVolumeRepresentation::SetExtractedBlockIndex ( unsigned int  index)

§ SetOrientation()

void vtkUnstructuredGridVolumeRepresentation::SetOrientation ( double  ,
double  ,
double   
)

§ SetOrigin()

void vtkUnstructuredGridVolumeRepresentation::SetOrigin ( double  ,
double  ,
double   
)

§ SetPickable()

void vtkUnstructuredGridVolumeRepresentation::SetPickable ( int  val)

§ SetPosition()

void vtkUnstructuredGridVolumeRepresentation::SetPosition ( double  ,
double  ,
double   
)

§ SetScale()

void vtkUnstructuredGridVolumeRepresentation::SetScale ( double  ,
double  ,
double   
)

§ SetInterpolationType()

void vtkUnstructuredGridVolumeRepresentation::SetInterpolationType ( int  val)

§ SetColor()

void vtkUnstructuredGridVolumeRepresentation::SetColor ( vtkColorTransferFunction *  lut)

§ SetScalarOpacity()

void vtkUnstructuredGridVolumeRepresentation::SetScalarOpacity ( vtkPiecewiseFunction *  pwf)

§ SetScalarOpacityUnitDistance()

void vtkUnstructuredGridVolumeRepresentation::SetScalarOpacityUnitDistance ( double  val)

§ GetActor()

vtkPVLODVolume* vtkUnstructuredGridVolumeRepresentation::GetActor ( )
inline

Provides access to the actor used by this representation.

Definition at line 112 of file vtkUnstructuredGridVolumeRepresentation.h.

§ SetUseDataPartitions()

virtual void vtkUnstructuredGridVolumeRepresentation::SetUseDataPartitions ( bool  )
virtual

Specify whether or not to redistribute the data.

The default is false since that is the only way in general to guarantee correct rendering. Can set to true if all rendered data sets are based on the same data partitioning in order to save on the data redistribution.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ GetUseDataPartitions()

virtual bool vtkUnstructuredGridVolumeRepresentation::GetUseDataPartitions ( )
virtual

Specify whether or not to redistribute the data.

The default is false since that is the only way in general to guarantee correct rendering. Can set to true if all rendered data sets are based on the same data partitioning in order to save on the data redistribution.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ FillInputPortInformation()

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

Fill input port information.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ RequestData()

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

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkStructuredGridVolumeRepresentation.

§ AddToView()

virtual bool vtkUnstructuredGridVolumeRepresentation::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 vtkUnstructuredGridVolumeRepresentation::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.

§ IsCached()

virtual bool vtkUnstructuredGridVolumeRepresentation::IsCached ( double  cache_key)
protectedvirtual

Overridden to check with the vtkPVCacheKeeper to see if the key is cached.

Reimplemented from vtkPVDataRepresentation.

§ UpdateMapperParameters()

virtual void vtkUnstructuredGridVolumeRepresentation::UpdateMapperParameters ( )
protectedvirtual

Passes on parameters to the active volume mapper.

Member Data Documentation

§ Preprocessor

vtkVolumeRepresentationPreprocessor* vtkUnstructuredGridVolumeRepresentation::Preprocessor
protected

Definition at line 160 of file vtkUnstructuredGridVolumeRepresentation.h.

§ CacheKeeper

vtkPVCacheKeeper* vtkUnstructuredGridVolumeRepresentation::CacheKeeper
protected

Definition at line 161 of file vtkUnstructuredGridVolumeRepresentation.h.

§ DefaultMapper

vtkProjectedTetrahedraMapper* vtkUnstructuredGridVolumeRepresentation::DefaultMapper
protected

Definition at line 162 of file vtkUnstructuredGridVolumeRepresentation.h.

§ Property

vtkVolumeProperty* vtkUnstructuredGridVolumeRepresentation::Property
protected

Definition at line 163 of file vtkUnstructuredGridVolumeRepresentation.h.

§ Actor

vtkPVLODVolume* vtkUnstructuredGridVolumeRepresentation::Actor
protected

Definition at line 164 of file vtkUnstructuredGridVolumeRepresentation.h.

§ LODGeometryFilter

vtkPVGeometryFilter* vtkUnstructuredGridVolumeRepresentation::LODGeometryFilter
protected

Definition at line 166 of file vtkUnstructuredGridVolumeRepresentation.h.

§ LODMapper

vtkPolyDataMapper* vtkUnstructuredGridVolumeRepresentation::LODMapper
protected

Definition at line 167 of file vtkUnstructuredGridVolumeRepresentation.h.

§ DataBounds

double vtkUnstructuredGridVolumeRepresentation::DataBounds[6]
protected

Definition at line 168 of file vtkUnstructuredGridVolumeRepresentation.h.

§ UseDataPartitions

bool vtkUnstructuredGridVolumeRepresentation::UseDataPartitions
protected

Definition at line 170 of file vtkUnstructuredGridVolumeRepresentation.h.


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