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 vtkVolumeRepresentation	Superclass
Public Types inherited from vtkVolumeRepresentation
typedef vtkPVDataRepresentation	Superclass
Public Types inherited from vtkPVDataRepresentation
enum	{ SkippedUpdateDataEvent = vtkCommand::UserEvent + 91, UpdateTimeChangedEvent }
typedef vtkDataRepresentation	Superclass
Public Types inherited from vtkDataRepresentation
typedef vtkPassInputTypeAlgorithm	Superclass
Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision
enum	DesiredOutputPrecision
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
int	ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo) override
	vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
void	SetAmbient (double)
void	SetDiffuse (double)
void	SetSpecular (double)
void	SetSpecularPower (double)
void	SetShade (bool)
void	SetAnisotropy (float)
void	SetSliceFunction (vtkImplicitFunction *slice)
void	SetRequestedRenderMode (int)
void	SetBlendMode (int)
void	SetCropping (int)
void	SetGlobalIlluminationReach (float)
void	SetVolumetricScatteringBlending (float)
void	SetUseTransfer2D (bool)
void	SetUseGradientForTransfer2D (bool)
void	SelectColorArray2 (int, int, int, int, const char *name)
void	SelectColorArray2Component (int component)
void	SetTransferFunction2D (vtkPVTransferFunction2D *transfer2d)
void	SetIsosurfaceValue (int i, double value)
	Methods to set isosurface values. More...
void	SetNumberOfIsosurfaces (int number)
	Methods to set isosurface values. More...
virtual void	SetCroppingOrigin (double, double, double)
	Get/Set the cropping origin. More...
virtual void	SetCroppingOrigin (double [3])
	Get/Set the cropping origin. More...
virtual double *	GetCroppingOrigin ()
	Get/Set the cropping origin. More...
virtual void	GetCroppingOrigin (double &, double &, double &)
	Get/Set the cropping origin. More...
virtual void	GetCroppingOrigin (double [3])
	Get/Set the cropping origin. More...
virtual void	SetCroppingScale (double, double, double)
	Get/Set the cropping scale. More...
virtual void	SetCroppingScale (double [3])
	Get/Set the cropping scale. More...
virtual double *	GetCroppingScale ()
	Get/Set the cropping scale. More...
virtual void	GetCroppingScale (double &, double &, double &)
	Get/Set the cropping scale. More...
virtual void	GetCroppingScale (double [3])
	Get/Set the cropping scale. More...
Public Member Functions inherited from vtkVolumeRepresentation
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetVisibility (bool val) override
	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	SetMapScalars (bool)
void	SetMultiComponentsMapping (bool)
void	SetUseSeparateOpacityArray (bool)
void	SelectOpacityArray (int, int, int, int, const char *name)
void	SelectOpacityArrayComponent (int component)
vtkPVLODVolume *	GetActor ()
	Provides access to the actor used by this representation. More...
Public Member Functions inherited from vtkPVDataRepresentation
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...
double	GetCacheKey () const
	Returns the cache-key the representation is currently using. More...
vtkAlgorithmOutput *	GetInternalOutputPort () override
	Retrieves an output port for the input data object at the specified port and connection index. More...
vtkAlgorithmOutput *	GetInternalOutputPort (int port) override
vtkAlgorithmOutput *	GetInternalOutputPort (int port, int conn) override
vtkView *	GetView () const
	Provides access to the view. More...
vtkMTimeType	GetPipelineDataTime ()
	Returns the timestamp when RequestData was executed on the representation. More...
bool	GetNeedsUpdate ()
	Returns true if the representation needs an update. More...
virtual void	SetArrayIdNames (const char *vtkNotUsed(pointArray), const char *vtkNotUsed(cellArray))
	Specify the array names used for the selection. More...
virtual void	SetUpdateTime (double time)
	Set the update time. More...
virtual double	GetUpdateTime ()
	Set the update time. More...
virtual bool	GetUpdateTimeValid ()
	Get whether the UpdateTime is valid. More...
void	ResetUpdateTime ()
	Get whether the UpdateTime is valid. More...
virtual void	SetForcedCacheKey (double val)
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...
virtual void	SetForceUseCache (bool val)
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...
virtual double	GetForcedCacheKey ()
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...
virtual bool	GetForceUseCache ()
	Generally, caching is within the purview of the vtkPVView (and subclasses). More...
bool	AddToView (vtkView *view) override
	Making these methods public. More...
bool	RemoveFromView (vtkView *view) override
	Making these methods public. 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::string &	GetLogName () const
	This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
virtual bool	GetHasTemporalPipeline ()
	This flag indicates if the representation is for a temporal pipeline. More...
virtual void	SetHasTemporalPipeline (bool)
	This flag indicates if the representation is for a temporal pipeline. More...
void	SetInputConnection (int port, vtkAlgorithmOutput *input) override
	Overridden to ensure that MarkModified is called. More...
void	AddInputConnection (int port, vtkAlgorithmOutput *input) override
	Overridden to ensure that MarkModified is called. More...
Public Member Functions inherited from vtkDataRepresentation
vtkDataRepresentation *	NewInstance () const
virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
virtual vtkSelection *	ConvertSelection (vtkView *view, vtkSelection *selection)
vtkAlgorithmOutput *	GetInputConnection (int port=0, int index=0)
vtkAnnotationLink *	GetAnnotationLink ()
void	SetAnnotationLink (vtkAnnotationLink *link)
void	Select (vtkView *view, vtkSelection *selection)
void	Select (vtkView *view, vtkSelection *selection, bool extend)
void	Annotate (vtkView *view, vtkAnnotationLayers *annotations)
void	Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
virtual void	SetSelectable (bool)
virtual bool	GetSelectable ()
virtual void	SelectableOn ()
virtual void	SelectableOff ()
void	UpdateSelection (vtkSelection *selection)
void	UpdateSelection (vtkSelection *selection, bool extend)
void	UpdateAnnotations (vtkAnnotationLayers *annotations)
void	UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port, int conn)
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port, int conn)
virtual void	SetSelectionType (int)
virtual int	GetSelectionType ()
virtual void	SetSelectionArrayNames (vtkStringArray *names)
virtual vtkStringArray *	GetSelectionArrayNames ()
virtual void	SetSelectionArrayName (const char *name)
virtual const char *	GetSelectionArrayName ()
vtkAlgorithmOutput *	GetInputConnection (int port=0, int index=0)
vtkAnnotationLink *	GetAnnotationLink ()
void	SetAnnotationLink (vtkAnnotationLink *link)
void	Select (vtkView *view, vtkSelection *selection)
void	Select (vtkView *view, vtkSelection *selection, bool extend)
void	Annotate (vtkView *view, vtkAnnotationLayers *annotations)
void	Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
virtual void	SetSelectable (bool)
virtual bool	GetSelectable ()
virtual void	SelectableOn ()
virtual void	SelectableOff ()
void	UpdateSelection (vtkSelection *selection)
void	UpdateSelection (vtkSelection *selection, bool extend)
void	UpdateAnnotations (vtkAnnotationLayers *annotations)
void	UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port, int conn)
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort ()
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port, int conn)
virtual void	SetSelectionType (int)
virtual int	GetSelectionType ()
virtual void	SetSelectionArrayNames (vtkStringArray *names)
virtual vtkStringArray *	GetSelectionArrayNames ()
virtual void	SetSelectionArrayName (const char *name)
virtual const char *	GetSelectionArrayName ()
Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithm *	NewInstance () const
vtkPolyData *	GetPolyDataOutput ()
vtkStructuredPoints *	GetStructuredPointsOutput ()
vtkImageData *	GetImageDataOutput ()
vtkStructuredGrid *	GetStructuredGridOutput ()
vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
vtkRectilinearGrid *	GetRectilinearGridOutput ()
vtkTable *	GetTableOutput ()
vtkGraph *	GetGraphOutput ()
vtkDataObject *	GetInput ()
vtkDataObject *	GetOutput ()
vtkDataObject *	GetOutput (int)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkDataObject *	GetOutput ()
vtkDataObject *	GetOutput (int)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual int	Update (int port, vtkInformationVector *requests)
virtual int	Update (vtkInformation *requests)
virtual int	UpdateExtent (const int extents[6])
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
void	SetUpdateExtent (int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
void	Register (vtkObjectBase *o) VTK_OVERRIDE
void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
void	Register (vtkObjectBase *o) VTK_OVERRIDE
void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
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)
vtkCommand *	GetCommand (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)
vtkCommand *	GetCommand (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)
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 vtkImageVolumeRepresentation *	New ()
static int	IsTypeOf (const char *type)
static vtkImageVolumeRepresentation *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkVolumeRepresentation
static int	IsTypeOf (const char *type)
static vtkVolumeRepresentation *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkPVDataRepresentation
static int	IsTypeOf (const char *type)
static vtkPVDataRepresentation *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkDataRepresentation
static vtkDataRepresentation *	New ()
static int	IsTypeOf (const char *type)
static vtkDataRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkPassInputTypeAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
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 vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkImageVolumeRepresentation ()
	~vtkImageVolumeRepresentation () override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill input port information. More...
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
bool	AddToView (vtkView *view) override
	Adds the representation to the view. More...
bool	RemoveFromView (vtkView *view) override
	Removes the representation to the view. 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 vtkVolumeRepresentation
	vtkVolumeRepresentation ()
	~vtkVolumeRepresentation () override
bool	AppendOpacityComponent (vtkDataSet *dataset)
	Appends a designated opacity component to a scalar array used for color/opacity mapping. More...
Protected Member Functions inherited from vtkPVDataRepresentation
	vtkPVDataRepresentation ()
	~vtkPVDataRepresentation () override
vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive. More...
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Overridden to invoke vtkCommand::UpdateDataEvent. More...
int	RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
int	RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Protected Member Functions inherited from vtkDataRepresentation
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataRepresentation ()
	~vtkDataRepresentation ()
virtual void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual bool	AddToView (vtkView *vtkNotUsed(view))
virtual bool	RemoveFromView (vtkView *vtkNotUsed(view))
virtual vtkAnnotationLayers *	ConvertAnnotations (vtkView *view, vtkAnnotationLayers *annotations)
vtkTrivialProducer *	GetInternalInput (int port, int conn)
void	SetInternalInput (int port, int conn, vtkTrivialProducer *producer)
virtual void	SetAnnotationLinkInternal (vtkAnnotationLink *link)
Protected Member Functions inherited from vtkPassInputTypeAlgorithm
	vtkPassInputTypeAlgorithm ()
	~vtkPassInputTypeAlgorithm ()
virtual int	RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
vtkDataObject *	GetInput (int port)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetErrorCode (unsigned long)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
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 &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkDataObject >	Cache
vtkSmartPointer< vtkVolumeMapper >	VolumeMapper
vtkNew< vtkPolyDataMapper >	OutlineMapper
int	WholeExtent [6] = { 0, -1, 0, -1, 0, -1 }
double	CroppingOrigin [3] = { 0, 0, 0 }
double	CroppingScale [3] = { 1, 1, 1 }
bool	UseTransfer2D = false
bool	UseGradientForTransfer2D = true
vtkPVTransferFunction2D *	TransferFunction2D = nullptr
int	ColorArray2FieldAssociation = -1
int	ColorArray2Component = -1
std::string	ColorArray2Name
Protected Attributes inherited from vtkVolumeRepresentation
vtkNew< vtkVolumeProperty >	Property
vtkSmartPointer< vtkPVLODVolume >	Actor
vtkNew< vtkOutlineSource >	OutlineSource
unsigned long	DataSize = 0
double	DataBounds [6]
bool	MapScalars = true
bool	MultiComponentsMapping = false
bool	UseSeparateOpacityArray = false
std::string	OpacityArrayName
int	OpacityArrayFieldAssociation = -1
int	OpacityArrayComponent = -1
Protected Attributes inherited from vtkPVDataRepresentation
double	UpdateTime
bool	UpdateTimeValid
unsigned int	UniqueIdentifier
Protected Attributes inherited from vtkDataRepresentation
bool	Selectable
int	SelectionType
vtkStringArray *	SelectionArrayNames
Command *	Observer
vtkAnnotationLink *	AnnotationLinkInternal
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION
	DOUBLE_PRECISION
	DEFAULT_PRECISION
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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.

vtkImageVolumeRepresentation has a few caveats:

1. It only supports vtkImageData and vtkPartitionedDataSet comprising of vtkImageData. In case of latter, any partition not a vtkImageData will be silently skipped.
2. In distributed mode, bounds on each rank as assumed to be non-overlapping.

Definition at line 47 of file vtkImageVolumeRepresentation.h.

Member Typedef Documentation

Superclass

typedef vtkVolumeRepresentation vtkImageVolumeRepresentation::Superclass

Definition at line 51 of file vtkImageVolumeRepresentation.h.

Constructor & Destructor Documentation

vtkImageVolumeRepresentation()

vtkImageVolumeRepresentation::vtkImageVolumeRepresentation ( )

protected

~vtkImageVolumeRepresentation()

vtkImageVolumeRepresentation::~vtkImageVolumeRepresentation ( )

overrideprotected

Member Function Documentation

New()

static vtkImageVolumeRepresentation* vtkImageVolumeRepresentation::New ( )

static

GetClassName()

virtual const char* vtkImageVolumeRepresentation::GetClassName ( )

virtual

Reimplemented from vtkVolumeRepresentation.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkVolumeRepresentation.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkDataRepresentation.

ProcessViewRequest()

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

overridevirtual

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.

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

)

SetAnisotropy()

void vtkImageVolumeRepresentation::SetAnisotropy

(

float

)

SetSliceFunction()

void vtkImageVolumeRepresentation::SetSliceFunction

(

vtkImplicitFunction *

slice

)

SetIsosurfaceValue()

void vtkImageVolumeRepresentation::SetIsosurfaceValue	(	int	i,
		double	value
	)

Methods to set isosurface values.

SetNumberOfIsosurfaces()

void vtkImageVolumeRepresentation::SetNumberOfIsosurfaces

(

int

number

)

Methods to set isosurface values.

SetRequestedRenderMode()

void vtkImageVolumeRepresentation::SetRequestedRenderMode

(

int

)

SetBlendMode()

void vtkImageVolumeRepresentation::SetBlendMode

(

int

)

SetCropping()

void vtkImageVolumeRepresentation::SetCropping

(

int

)

SetGlobalIlluminationReach()

void vtkImageVolumeRepresentation::SetGlobalIlluminationReach

(

float

)

SetVolumetricScatteringBlending()

void vtkImageVolumeRepresentation::SetVolumetricScatteringBlending

(

float

)

SetCroppingOrigin() [1/2]

virtual void vtkImageVolumeRepresentation::SetCroppingOrigin ( double  , double  , double    )

virtual

Get/Set the cropping origin.

SetCroppingOrigin() [2/2]

virtual void vtkImageVolumeRepresentation::SetCroppingOrigin ( double  [3] )

virtual

Get/Set the cropping origin.

GetCroppingOrigin() [1/3]

virtual double* vtkImageVolumeRepresentation::GetCroppingOrigin ( )

virtual

Get/Set the cropping origin.

GetCroppingOrigin() [2/3]

virtual void vtkImageVolumeRepresentation::GetCroppingOrigin ( double &  , double &  , double &    )

virtual

Get/Set the cropping origin.

GetCroppingOrigin() [3/3]

virtual void vtkImageVolumeRepresentation::GetCroppingOrigin ( double  [3] )

virtual

Get/Set the cropping origin.

SetCroppingScale() [1/2]

virtual void vtkImageVolumeRepresentation::SetCroppingScale ( double  , double  , double    )

virtual

Get/Set the cropping scale.

SetCroppingScale() [2/2]

virtual void vtkImageVolumeRepresentation::SetCroppingScale ( double  [3] )

virtual

Get/Set the cropping scale.

GetCroppingScale() [1/3]

virtual double* vtkImageVolumeRepresentation::GetCroppingScale ( )

virtual

Get/Set the cropping scale.

GetCroppingScale() [2/3]

virtual void vtkImageVolumeRepresentation::GetCroppingScale ( double &  , double &  , double &    )

virtual

Get/Set the cropping scale.

GetCroppingScale() [3/3]

virtual void vtkImageVolumeRepresentation::GetCroppingScale ( double  [3] )

virtual

Get/Set the cropping scale.

SetUseTransfer2D()

void vtkImageVolumeRepresentation::SetUseTransfer2D

(

bool

)

SetUseGradientForTransfer2D()

void vtkImageVolumeRepresentation::SetUseGradientForTransfer2D

(

bool

)

SelectColorArray2()

void vtkImageVolumeRepresentation::SelectColorArray2	(	int	,
		int	,
		int	,
		int	,
		const char *	name
	)

SelectColorArray2Component()

void vtkImageVolumeRepresentation::SelectColorArray2Component

(

int

component

)

SetTransferFunction2D()

void vtkImageVolumeRepresentation::SetTransferFunction2D

(

vtkPVTransferFunction2D *

transfer2d

)

FillInputPortInformation()

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

overrideprotectedvirtual

Fill input port information.

Reimplemented from vtkPassInputTypeAlgorithm.

RequestData()

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

overrideprotectedvirtual

Reimplemented from vtkDataRepresentation.

AddToView()

bool vtkImageVolumeRepresentation::AddToView ( vtkView *  view )

overrideprotected

Adds the representation to the view.

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

RemoveFromView()

bool vtkImageVolumeRepresentation::RemoveFromView ( vtkView *  view )

overrideprotected

Removes the representation to the view.

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

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 146 of file vtkImageVolumeRepresentation.h.

Member Data Documentation

Cache

vtkSmartPointer<vtkDataObject> vtkImageVolumeRepresentation::Cache

protected

Definition at line 146 of file vtkImageVolumeRepresentation.h.

VolumeMapper

vtkSmartPointer<vtkVolumeMapper> vtkImageVolumeRepresentation::VolumeMapper

protected

Definition at line 149 of file vtkImageVolumeRepresentation.h.

OutlineMapper

vtkNew<vtkPolyDataMapper> vtkImageVolumeRepresentation::OutlineMapper

protected

Definition at line 151 of file vtkImageVolumeRepresentation.h.

WholeExtent

int vtkImageVolumeRepresentation::WholeExtent[6] = { 0, -1, 0, -1, 0, -1 }

protected

Definition at line 153 of file vtkImageVolumeRepresentation.h.

CroppingOrigin

double vtkImageVolumeRepresentation::CroppingOrigin[3] = { 0, 0, 0 }

protected

Definition at line 154 of file vtkImageVolumeRepresentation.h.

CroppingScale

double vtkImageVolumeRepresentation::CroppingScale[3] = { 1, 1, 1 }

protected

Definition at line 155 of file vtkImageVolumeRepresentation.h.

UseTransfer2D

bool vtkImageVolumeRepresentation::UseTransfer2D = false

protected

Definition at line 158 of file vtkImageVolumeRepresentation.h.

UseGradientForTransfer2D

bool vtkImageVolumeRepresentation::UseGradientForTransfer2D = true

protected

Definition at line 159 of file vtkImageVolumeRepresentation.h.

TransferFunction2D

vtkPVTransferFunction2D* vtkImageVolumeRepresentation::TransferFunction2D = nullptr

protected

Definition at line 160 of file vtkImageVolumeRepresentation.h.

ColorArray2FieldAssociation

int vtkImageVolumeRepresentation::ColorArray2FieldAssociation = -1

protected

Definition at line 161 of file vtkImageVolumeRepresentation.h.

ColorArray2Component

int vtkImageVolumeRepresentation::ColorArray2Component = -1

protected

Definition at line 162 of file vtkImageVolumeRepresentation.h.

ColorArray2Name

std::string vtkImageVolumeRepresentation::ColorArray2Name

protected

Definition at line 163 of file vtkImageVolumeRepresentation.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkImageVolumeRepresentation.h