vtkImageVolumeRepresentation Class Reference

representation for showing image datasets as a volume. More...

#include <vtkImageVolumeRepresentation.h>

Inheritance diagram for vtkImageVolumeRepresentation:

Collaboration diagram for vtkImageVolumeRepresentation:

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)
	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	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)
void	SetAmbient (double)
void	SetDiffuse (double)
void	SetSpecular (double)
void	SetSpecularPower (double)
void	SetShade (bool)
void	SetIndependantComponents (bool)
void	SetRequestedRenderMode (int)
vtkPVLODVolume *	GetActor ()
	Provides access to the actor used by this representation. 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 vtkImageVolumeRepresentation *	New ()
static int	IsTypeOf (const char *type)
static vtkImageVolumeRepresentation *	SafeDownCast (vtkObject *o)
static void	PassOrderedCompositingInformation (vtkPVDataRepresentation *self, vtkInformation *inInfo)
	Helper method to pass input image extent information to the view to use in determining the cuts for ordered compositing. More...
Static Public Member Functions inherited from vtkPVDataRepresentation
static int	IsTypeOf (const char *type)
static vtkPVDataRepresentation *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkImageVolumeRepresentation ()
	~vtkImageVolumeRepresentation ()
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...
virtual vtkPVLODVolume *	GetRenderedProp ()
	Used in ConvertSelection to locate the rendered prop. 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
vtkImageData *	Cache
vtkPVCacheKeeper *	CacheKeeper
vtkSmartVolumeMapper *	VolumeMapper
vtkVolumeProperty *	Property
vtkPVLODVolume *	Actor
vtkOutlineSource *	OutlineSource
vtkPolyDataMapper *	OutlineMapper
unsigned long	DataSize
double	DataBounds [6]
vtkNew< vtkPExtentTranslator >	PExtentTranslator
double	Origin [3]
double	Spacing [3]
int	WholeExtent [6]
Protected Attributes inherited from vtkPVDataRepresentation
double	UpdateTime
bool	UpdateTimeValid
unsigned int	UniqueIdentifier

Detailed Description

representation for showing image datasets as a volume.

vtkImageVolumeRepresentation is a representation for volume rendering vtkImageData. Unlike other data-representations used by ParaView, this representation does not support delivery to client (or render server) nodes. In those configurations, it merely delivers a outline for the image to the client and render-server and those nodes simply render the outline.

Definition at line 47 of file vtkImageVolumeRepresentation.h.

Member Typedef Documentation

Superclass

typedef vtkPVDataRepresentation vtkImageVolumeRepresentation::Superclass

Definition at line 52 of file vtkImageVolumeRepresentation.h.

Constructor & Destructor Documentation

vtkImageVolumeRepresentation()

vtkImageVolumeRepresentation::vtkImageVolumeRepresentation ( )

protected

~vtkImageVolumeRepresentation()

vtkImageVolumeRepresentation::~vtkImageVolumeRepresentation ( )

protected

Member Function Documentation

New()

static vtkImageVolumeRepresentation* vtkImageVolumeRepresentation::New ( )

static

GetClassName()

virtual const char* vtkImageVolumeRepresentation::GetClassName ( )

virtual

Reimplemented from vtkPVDataRepresentation.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkPVDataRepresentation.

SafeDownCast()

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

static

PrintSelf()

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

ProcessViewRequest()

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

MarkModified()

virtual void vtkImageVolumeRepresentation::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 vtkImageVolumeRepresentation::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.

SetOrientation()

void vtkImageVolumeRepresentation::SetOrientation	(	double	,
		double	,
		double
	)

SetOrigin()

void vtkImageVolumeRepresentation::SetOrigin	(	double	,
		double	,
		double
	)

SetPickable()

void vtkImageVolumeRepresentation::SetPickable

(

int

val

)

SetPosition()

void vtkImageVolumeRepresentation::SetPosition	(	double	,
		double	,
		double
	)

SetScale()

void vtkImageVolumeRepresentation::SetScale	(	double	,
		double	,
		double
	)

SetInterpolationType()

void vtkImageVolumeRepresentation::SetInterpolationType

(

int

val

)

SetColor()

void vtkImageVolumeRepresentation::SetColor

(

vtkColorTransferFunction *

lut

)

SetScalarOpacity()

void vtkImageVolumeRepresentation::SetScalarOpacity

(

vtkPiecewiseFunction *

pwf

)

SetScalarOpacityUnitDistance()

void vtkImageVolumeRepresentation::SetScalarOpacityUnitDistance

(

double

val

)

SetAmbient()

void vtkImageVolumeRepresentation::SetAmbient

(

double

)

SetDiffuse()

void vtkImageVolumeRepresentation::SetDiffuse

(

double

)

SetSpecular()

void vtkImageVolumeRepresentation::SetSpecular

(

double

)

SetSpecularPower()

void vtkImageVolumeRepresentation::SetSpecularPower

(

double

)

SetShade()

void vtkImageVolumeRepresentation::SetShade

(

bool

)

SetIndependantComponents()

void vtkImageVolumeRepresentation::SetIndependantComponents

(

bool

)

SetRequestedRenderMode()

void vtkImageVolumeRepresentation::SetRequestedRenderMode

(

int

)

GetActor()

vtkPVLODVolume* vtkImageVolumeRepresentation::GetActor ( )

inline

Provides access to the actor used by this representation.

Definition at line 106 of file vtkImageVolumeRepresentation.h.

PassOrderedCompositingInformation()

static void vtkImageVolumeRepresentation::PassOrderedCompositingInformation ( vtkPVDataRepresentation *  self, vtkInformation *  inInfo  )

static

Helper method to pass input image extent information to the view to use in determining the cuts for ordered compositing.

FillInputPortInformation()

virtual int vtkImageVolumeRepresentation::FillInputPortInformation ( int  port, vtkInformation *  info  )

protectedvirtual

Fill input port information.

RequestData()

virtual int vtkImageVolumeRepresentation::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

protectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

AddToView()

virtual bool vtkImageVolumeRepresentation::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 vtkImageVolumeRepresentation::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 vtkImageVolumeRepresentation::IsCached ( double  cache_key )

protectedvirtual

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

Reimplemented from vtkPVDataRepresentation.

UpdateMapperParameters()

virtual void vtkImageVolumeRepresentation::UpdateMapperParameters ( )

protectedvirtual

Passes on parameters to the active volume mapper.

GetRenderedProp()

virtual vtkPVLODVolume* vtkImageVolumeRepresentation::GetRenderedProp ( )

inlineprotectedvirtual

Used in ConvertSelection to locate the rendered prop.

Definition at line 153 of file vtkImageVolumeRepresentation.h.

Member Data Documentation

Cache

vtkImageData* vtkImageVolumeRepresentation::Cache

protected

Definition at line 153 of file vtkImageVolumeRepresentation.h.

CacheKeeper

vtkPVCacheKeeper* vtkImageVolumeRepresentation::CacheKeeper

protected

Definition at line 156 of file vtkImageVolumeRepresentation.h.

VolumeMapper

vtkSmartVolumeMapper* vtkImageVolumeRepresentation::VolumeMapper

protected

Definition at line 157 of file vtkImageVolumeRepresentation.h.

Property

vtkVolumeProperty* vtkImageVolumeRepresentation::Property

protected

Definition at line 158 of file vtkImageVolumeRepresentation.h.

Actor

vtkPVLODVolume* vtkImageVolumeRepresentation::Actor

protected

Definition at line 159 of file vtkImageVolumeRepresentation.h.

OutlineSource

vtkOutlineSource* vtkImageVolumeRepresentation::OutlineSource

protected

Definition at line 161 of file vtkImageVolumeRepresentation.h.

OutlineMapper

vtkPolyDataMapper* vtkImageVolumeRepresentation::OutlineMapper

protected

Definition at line 162 of file vtkImageVolumeRepresentation.h.

DataSize

unsigned long vtkImageVolumeRepresentation::DataSize

protected

Definition at line 163 of file vtkImageVolumeRepresentation.h.

DataBounds

double vtkImageVolumeRepresentation::DataBounds[6]

protected

Definition at line 166 of file vtkImageVolumeRepresentation.h.

PExtentTranslator

vtkNew<vtkPExtentTranslator> vtkImageVolumeRepresentation::PExtentTranslator

protected

Definition at line 170 of file vtkImageVolumeRepresentation.h.

Origin

double vtkImageVolumeRepresentation::Origin[3]

protected

Definition at line 171 of file vtkImageVolumeRepresentation.h.

Spacing

double vtkImageVolumeRepresentation::Spacing[3]

protected

Definition at line 172 of file vtkImageVolumeRepresentation.h.

WholeExtent

int vtkImageVolumeRepresentation::WholeExtent[6]

protected

Definition at line 173 of file vtkImageVolumeRepresentation.h.

---

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

• /builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/ClientServerCore/Rendering/vtkImageVolumeRepresentation.h