#include <vtkVolumeRepresentation.h>

Detailed Description

Renders volumetric data using volume rendering.

vtkVolumeRepresentation is a data representation that renders volumetric data (vtkImageData, vtkRectilinearGrid, vtkUnstructuredGrid) using vtkSmartVolumeMapper, which auto-selects the best available volume rendering backend. When no transfer functions are supplied it builds both from the scalar range of the data, so a volume is visible before anything is configured.

The API here covers what it takes to make data visible and legible: which array is drawn, the transfer functions it is drawn through, and shading. Everything else is a property of the objects underneath, reachable through GetVolumeProperty() and GetVolumeMapper(): ambient, diffuse, specular and interpolation type on the property; blend mode and requested render mode on the mapper.

Internal pipeline:

* Input (vtkImageData / vtkUnstructuredGrid)
*   -> vtkSmartVolumeMapper
*     -> vtkVolume
*

See also: vtkScivisDataRepresentation vtkScivisView vtkSurfaceRepresentation

Examples:: vtkVolumeRepresentation (Examples)

Tests:: vtkVolumeRepresentation (Tests)

Definition at line 55 of file vtkVolumeRepresentation.h.

Inheritance diagram for vtkVolumeRepresentation:

[legend]

Collaboration diagram for vtkVolumeRepresentation:

[legend]

Public Types
typedef vtkScivisDataRepresentation	Superclass
Public Types inherited from vtkScivisDataRepresentation
typedef vtkScivisRepresentation	Superclass
Public Types inherited from vtkScivisRepresentation
typedef vtkPassInputTypeAlgorithm	Superclass
Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkVolumeRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	The representation stores its properties on the volume mapper and volume it owns rather than in its own ivars.

void	SetColorTransferFunction (vtkColorTransferFunction *ctf)
	Transfer functions for color and opacity.
vtkColorTransferFunction *	GetColorTransferFunction ()
	Transfer functions for color and opacity.
void	SetScalarOpacity (vtkPiecewiseFunction *pf)
	Transfer functions for color and opacity.
vtkPiecewiseFunction *	GetScalarOpacity ()
	Transfer functions for color and opacity.
void	SetScalarOpacityUnitDistance (double distance)
	Transfer functions for color and opacity.
double	GetScalarOpacityUnitDistance ()
	Transfer functions for color and opacity.

void	ResetColorTransferFunction ()
	Give a transfer function back to the representation: discard the one set with SetColorTransferFunction() or SetScalarOpacity() and rebuild the generated one from the current scalar range.
void	ResetScalarOpacity ()
	Give a transfer function back to the representation: discard the one set with SetColorTransferFunction() or SetScalarOpacity() and rebuild the generated one from the current scalar range.
void	ResetTransferFunctions ()
	Give a transfer function back to the representation: discard the one set with SetColorTransferFunction() or SetScalarOpacity() and rebuild the generated one from the current scalar range.

void	SetShade (bool val)
	Whether the volume is lit.
bool	GetShade ()
	Whether the volume is lit.

void	ColorByPointArray (const char *arrayName)
	Which array is rendered.
void	ColorByCellArray (const char *arrayName)
	Which array is rendered.
void	ResetColorArray ()
	Which array is rendered.

void	SetColorMap (vtkScalarsToColors *map) override
	The vtkScivisDataRepresentation contract.
void	SetVisibility (bool val) override
	The vtkScivisDataRepresentation contract.
bool	GetVisibility () override
	The vtkScivisDataRepresentation contract.
bool	GetBounds (double bounds[6]) override
	The vtkScivisDataRepresentation contract.
const char *	GetRenderedArrayName () override
	The vtkScivisDataRepresentation contract.
int	GetRenderedFieldAssociation () override
	The vtkScivisDataRepresentation contract.
bool	GetDataRange (const char *arrayName, int fieldAssoc, double range[2], int component=-1) override
	The vtkScivisDataRepresentation contract.
vtkScalarsToColors *	GetColorMap () override
	The vtkScivisDataRepresentation contract.

vtkVolume *	GetVolume ()
	The objects this representation is built from, for everything the API above does not cover: ambient, diffuse, specular and interpolation type on the property, blend mode and requested render mode on the mapper.
vtkVolumeProperty *	GetVolumeProperty ()
	The objects this representation is built from, for everything the API above does not cover: ambient, diffuse, specular and interpolation type on the property, blend mode and requested render mode on the mapper.
vtkSmartVolumeMapper *	GetVolumeMapper ()
	The objects this representation is built from, for everything the API above does not cover: ambient, diffuse, specular and interpolation type on the property, blend mode and requested render mode on the mapper.
Public Member Functions inherited from vtkScivisDataRepresentation
vtkScivisDataRepresentation *	NewInstance () const
vtkAlgorithmOutput *	GetInternalOutputPort ()
	A shallow copy of an input, kept up to date, that the filters inside a representation can be connected to without holding its own pipeline open.
vtkAlgorithmOutput *	GetInternalOutputPort (int port)
virtual vtkAlgorithmOutput *	GetInternalOutputPort (int port, int conn)
void	Select (vtkScivisView view, vtkSelection selection)
	Hand this representation a selection made in view.
void	Select (vtkScivisView view, vtkSelection selection, bool extend)
vtkSelection *	GetCurrentSelection ()
	What this representation currently has selected, or null.
void	AddClippingPlane (vtkPlane *plane)
	Planes that cut away part of what this representation draws.
void	RemoveClippingPlane (vtkPlane *plane)
	Planes that cut away part of what this representation draws.
void	RemoveAllClippingPlanes ()
	Planes that cut away part of what this representation draws.
void	SetClippingPlanes (vtkPlaneCollection *planes)
	Planes that cut away part of what this representation draws.
vtkPlaneCollection *	GetClippingPlanes ()
	Planes that cut away part of what this representation draws.
int	GetNumberOfClippingPlanes ()
	Planes that cut away part of what this representation draws.
virtual void	SetSelectable (bool)
	Whether a view may select in this representation at all.
virtual bool	GetSelectable ()
	Whether a view may select in this representation at all.
virtual void	SelectableOn ()
	Whether a view may select in this representation at all.
virtual void	SelectableOff ()
	Whether a view may select in this representation at all.
Public Member Functions inherited from vtkScivisRepresentation
vtkScivisRepresentation *	NewInstance () const
Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithm *	NewInstance () const
vtkDataObject *	GetInput ()
	Get the input data object.
vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details
vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkDataObject *	GetOutput (int)
	Get the output data object for a port on this algorithm.
vtkPolyData *	GetPolyDataOutput ()
	Get the output as a concrete type.
vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as a concrete type.
vtkImageData *	GetImageDataOutput ()
	Get the output as a concrete type.
vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as a concrete type.
vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as a concrete type.
vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as a concrete type.
vtkGraph *	GetGraphOutput ()
	Get the output as a concrete type.
vtkMolecule *	GetMoleculeOutput ()
	Get the output as a concrete type.
vtkTable *	GetTableOutput ()
	Get the output as a concrete type.
vtkHyperTreeGrid *	GetHyperTreeGridOutput ()
	Get the output as a concrete type.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Check to see if an input's ABORTED flag is set or if an upstream algorithm's AbortExecute is set.
bool	CheckAbortAndInvoke ()
	Invoke AbortCheck event then return CheckAbort result.
void	InvokeCleanupAbortCheck ()
	Invoke CleanupAbortCheck event, usually used by application to cleanup multi process communications triggered by CheckAbortAndInvoke.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
int	GetNumberOfInputArraySpecifications ()
	Get the number of input array indices that have already been set.
bool	ResetInputArraySpecifications ()
	Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0).
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0).
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual bool	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual bool	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual bool	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual void	AbortOutputOn ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual void	AbortOutputOff ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
void	SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name, int component)
	This method variant also accepts a component to consider rather than the entire tuple.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
	This method variant also accepts a component to consider rather than the entire tuple.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName, const char *component)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual bool	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual bool	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkVolumeRepresentation *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkVolumeRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkScivisDataRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
static vtkScivisDataRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkScivisRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
static vtkScivisRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPassInputTypeAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVolumeRepresentation ()
	~vtkVolumeRepresentation () override
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when a request asks the algorithm to do its work.
bool	AddToView (vtkScivisView *view) override
	Called when this representation is added to or removed from a view.
bool	RemoveFromView (vtkScivisView *view) override
	Called when this representation is added to or removed from a view.
Protected Member Functions inherited from vtkScivisDataRepresentation
	vtkScivisDataRepresentation ()
	~vtkScivisDataRepresentation () override
virtual vtkSelection *	ConvertSelection (vtkScivisView view, vtkSelection selection)
	Turn a selection made in view into one expressed over this representation's own input.
virtual void	UpdateSelection (vtkSelection *selection, bool extend)
	Make selection current and fire SelectionChangedEvent.
Protected Member Functions inherited from vtkScivisRepresentation
	vtkScivisRepresentation ()
	~vtkScivisRepresentation () override
Protected Member Functions inherited from vtkPassInputTypeAlgorithm
	vtkPassInputTypeAlgorithm ()
	~vtkPassInputTypeAlgorithm () override=default
virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks for Information.
virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request ask for temporal information to be updated.
virtual int	RequestUpdateTimeDependentInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request ask for meta information to be updated.
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
vtkDataObject *	GetInput (int port)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm () override
bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
int	GetInputArrayComponent (int idx)
	Get the component to process of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkSmartPointer< vtkAbstractArray >	GetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested)
	Get an array from the input at index idx.
vtkSmartPointer< vtkAbstractArray >	GetInputArray (int idx, vtkDataObject *input, int &association, int requestedComponent=vtkArrayComponents::Requested)
	Get an array from the input at index idx.
template<typename ArrayType, typename... Params>
vtkSmartPointer< ArrayType >	GetInputArrayAs (Params &&... params)
	Get an array from the input at index idx.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkScivisDataRepresentation
vtkNew< vtkPlaneCollection >	ClippingPlanes
vtkSmartPointer< vtkSelection >	CurrentSelection
bool	Selectable
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Member Typedef Documentation

◆ Superclass

typedef vtkScivisDataRepresentation vtkVolumeRepresentation::Superclass

Definition at line 59 of file vtkVolumeRepresentation.h.

Constructor & Destructor Documentation

◆ vtkVolumeRepresentation()

vtkVolumeRepresentation::vtkVolumeRepresentation ( )

protected

◆ ~vtkVolumeRepresentation()

vtkVolumeRepresentation::~vtkVolumeRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

vtkVolumeRepresentation * vtkVolumeRepresentation::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkVolumeRepresentation::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkVolumeRepresentation::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkScivisDataRepresentation.

◆ SafeDownCast()

vtkVolumeRepresentation * vtkVolumeRepresentation::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVolumeRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkScivisDataRepresentation.

◆ NewInstance()

vtkVolumeRepresentation * vtkVolumeRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkScivisDataRepresentation.

◆ GetMTime()

vtkMTimeType vtkVolumeRepresentation::GetMTime ( )

overridevirtual

The representation stores its properties on the volume mapper and volume it owns rather than in its own ivars.

Those objects are also reachable through GetVolume() and friends, so the modified time reported here is the latest of this object's own and theirs.

Reimplemented from vtkObject.

◆ SetColorTransferFunction()

void vtkVolumeRepresentation::SetColorTransferFunction ( vtkColorTransferFunction * ctf )

Transfer functions for color and opacity.

The representation builds both from the scalar range of its input the first time it executes, and stops maintaining whichever one you set here. The getters always return the function actually in use, generated or your own; before the first execution they return whatever the volume property was constructed with.

◆ GetColorTransferFunction()

vtkColorTransferFunction * vtkVolumeRepresentation::GetColorTransferFunction ( )

Transfer functions for color and opacity.

The representation builds both from the scalar range of its input the first time it executes, and stops maintaining whichever one you set here. The getters always return the function actually in use, generated or your own; before the first execution they return whatever the volume property was constructed with.

◆ SetScalarOpacity()

void vtkVolumeRepresentation::SetScalarOpacity ( vtkPiecewiseFunction * pf )

Transfer functions for color and opacity.

The representation builds both from the scalar range of its input the first time it executes, and stops maintaining whichever one you set here. The getters always return the function actually in use, generated or your own; before the first execution they return whatever the volume property was constructed with.

◆ GetScalarOpacity()

vtkPiecewiseFunction * vtkVolumeRepresentation::GetScalarOpacity ( )

Transfer functions for color and opacity.

The representation builds both from the scalar range of its input the first time it executes, and stops maintaining whichever one you set here. The getters always return the function actually in use, generated or your own; before the first execution they return whatever the volume property was constructed with.

◆ SetScalarOpacityUnitDistance()

void vtkVolumeRepresentation::SetScalarOpacityUnitDistance ( double distance )

Transfer functions for color and opacity.

The representation builds both from the scalar range of its input the first time it executes, and stops maintaining whichever one you set here. The getters always return the function actually in use, generated or your own; before the first execution they return whatever the volume property was constructed with.

◆ GetScalarOpacityUnitDistance()

double vtkVolumeRepresentation::GetScalarOpacityUnitDistance ( )

Transfer functions for color and opacity.

The representation builds both from the scalar range of its input the first time it executes, and stops maintaining whichever one you set here. The getters always return the function actually in use, generated or your own; before the first execution they return whatever the volume property was constructed with.

◆ ResetColorTransferFunction()

void vtkVolumeRepresentation::ResetColorTransferFunction ( )

Give a transfer function back to the representation: discard the one set with SetColorTransferFunction() or SetScalarOpacity() and rebuild the generated one from the current scalar range.

Resetting one function leaves the other alone, whether it is generated or your own.

These also serve as a way to re-derive the generated functions after the input data changes, which the representation does not do on its own.

◆ ResetScalarOpacity()

void vtkVolumeRepresentation::ResetScalarOpacity ( )

Give a transfer function back to the representation: discard the one set with SetColorTransferFunction() or SetScalarOpacity() and rebuild the generated one from the current scalar range.

Resetting one function leaves the other alone, whether it is generated or your own.

These also serve as a way to re-derive the generated functions after the input data changes, which the representation does not do on its own.

◆ ResetTransferFunctions()

void vtkVolumeRepresentation::ResetTransferFunctions ( )

Give a transfer function back to the representation: discard the one set with SetColorTransferFunction() or SetScalarOpacity() and rebuild the generated one from the current scalar range.

Resetting one function leaves the other alone, whether it is generated or your own.

These also serve as a way to re-derive the generated functions after the input data changes, which the representation does not do on its own.

◆ SetShade()

void vtkVolumeRepresentation::SetShade ( bool val )

Whether the volume is lit.

For the rest of the shading parameters – ambient, diffuse, specular, specular power, interpolation type – use GetVolumeProperty().

◆ GetShade()

bool vtkVolumeRepresentation::GetShade ( )

Whether the volume is lit.

For the rest of the shading parameters – ambient, diffuse, specular, specular power, interpolation type – use GetVolumeProperty().

◆ ColorByPointArray()

void vtkVolumeRepresentation::ColorByPointArray ( const char * arrayName )

Which array is rendered.

The mapper draws the data's active scalars until one of these selects an array; ResetColorArray goes back to that.

The generated transfer functions span the range of the array being rendered, so selecting a different array rebuilds whichever of them is not yours, exactly as ResetTransferFunctions() would.

◆ ColorByCellArray()

void vtkVolumeRepresentation::ColorByCellArray ( const char * arrayName )

Which array is rendered.

The mapper draws the data's active scalars until one of these selects an array; ResetColorArray goes back to that.

The generated transfer functions span the range of the array being rendered, so selecting a different array rebuilds whichever of them is not yours, exactly as ResetTransferFunctions() would.

◆ ResetColorArray()

void vtkVolumeRepresentation::ResetColorArray ( )

Which array is rendered.

The mapper draws the data's active scalars until one of these selects an array; ResetColorArray goes back to that.

The generated transfer functions span the range of the array being rendered, so selecting a different array rebuilds whichever of them is not yours, exactly as ResetTransferFunctions() would.

◆ SetColorMap()

void vtkVolumeRepresentation::SetColorMap ( vtkScalarsToColors * map )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisDataRepresentation.

◆ SetVisibility()

void vtkVolumeRepresentation::SetVisibility ( bool val )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisRepresentation.

◆ GetVisibility()

bool vtkVolumeRepresentation::GetVisibility ( )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisRepresentation.

◆ GetBounds()

bool vtkVolumeRepresentation::GetBounds ( double bounds[6] )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisDataRepresentation.

◆ GetRenderedArrayName()

const char * vtkVolumeRepresentation::GetRenderedArrayName ( )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisDataRepresentation.

◆ GetRenderedFieldAssociation()

int vtkVolumeRepresentation::GetRenderedFieldAssociation ( )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisDataRepresentation.

◆ GetDataRange()

bool vtkVolumeRepresentation::GetDataRange	(	const char *	arrayName,
		int	fieldAssoc,
		double	range[2],
		int	component = -1 )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisDataRepresentation.

◆ GetColorMap()

vtkScalarsToColors * vtkVolumeRepresentation::GetColorMap ( )

overridevirtual

The vtkScivisDataRepresentation contract.

GetColorMap() reports the color transfer function, so a view labels this volume's scalar bar with the colors actually on screen. It is the same object GetColorTransferFunction() returns; the two differ only in type, and the typed one is the one to use when you want to add points to it.

SetColorMap() takes a vtkColorTransferFunction and nothing else. A volume colors through a transfer function, so a map that is not one – a lookup table, say, which is what a view usually has to offer – cannot be used and is ignored rather than refused, since a view offers the same map to everything drawing an array and expects to be turned down. Passing a transfer function here is the same as SetColorTransferFunction().

Implements vtkScivisDataRepresentation.

◆ GetVolume()

vtkVolume * vtkVolumeRepresentation::GetVolume ( )

The objects this representation is built from, for everything the API above does not cover: ambient, diffuse, specular and interpolation type on the property, blend mode and requested render mode on the mapper.

Two things the representation holds them to, which reaching in will undo. It tracks whether each transfer function is yours or one it generated, so setting the property's color or scalar opacity directly leaves it believing the function is still its own, and the next change of array will build over what you set – use SetColorTransferFunction() and SetScalarOpacity(). And the mapper follows the clipping planes held by vtkScivisRepresentation, so giving it a collection of its own disconnects AddClippingPlane().

◆ GetVolumeProperty()

vtkVolumeProperty * vtkVolumeRepresentation::GetVolumeProperty ( )

The objects this representation is built from, for everything the API above does not cover: ambient, diffuse, specular and interpolation type on the property, blend mode and requested render mode on the mapper.

Two things the representation holds them to, which reaching in will undo. It tracks whether each transfer function is yours or one it generated, so setting the property's color or scalar opacity directly leaves it believing the function is still its own, and the next change of array will build over what you set – use SetColorTransferFunction() and SetScalarOpacity(). And the mapper follows the clipping planes held by vtkScivisRepresentation, so giving it a collection of its own disconnects AddClippingPlane().

◆ GetVolumeMapper()

vtkSmartVolumeMapper * vtkVolumeRepresentation::GetVolumeMapper ( )

The objects this representation is built from, for everything the API above does not cover: ambient, diffuse, specular and interpolation type on the property, blend mode and requested render mode on the mapper.

Two things the representation holds them to, which reaching in will undo. It tracks whether each transfer function is yours or one it generated, so setting the property's color or scalar opacity directly leaves it believing the function is still its own, and the next change of array will build over what you set – use SetColorTransferFunction() and SetScalarOpacity(). And the mapper follows the clipping planes held by vtkScivisRepresentation, so giving it a collection of its own disconnects AddClippingPlane().

◆ RequestData()

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

overrideprotectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work.

This is the method you should override to do whatever the algorithm is designed to do. This happens during the final pass in the pipeline execution process.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ AddToView()

bool vtkVolumeRepresentation::AddToView ( vtkScivisView * view )

overrideprotectedvirtual

Called when this representation is added to or removed from a view.

Returning false from AddToView() refuses the view, and the view drops the representation again.

Reimplemented from vtkScivisRepresentation.

◆ RemoveFromView()

bool vtkVolumeRepresentation::RemoveFromView ( vtkScivisView * view )

overrideprotectedvirtual

Called when this representation is added to or removed from a view.

Returning false from AddToView() refuses the view, and the view drops the representation again.

Reimplemented from vtkScivisRepresentation.

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

Views/Scivis/vtkVolumeRepresentation.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkVolumeRepresentation()

◆ ~vtkVolumeRepresentation()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ SetColorTransferFunction()

◆ GetColorTransferFunction()

◆ SetScalarOpacity()

◆ GetScalarOpacity()

◆ SetScalarOpacityUnitDistance()

◆ GetScalarOpacityUnitDistance()

◆ ResetColorTransferFunction()

◆ ResetScalarOpacity()

◆ ResetTransferFunctions()

◆ SetShade()

◆ GetShade()

◆ ColorByPointArray()

◆ ColorByCellArray()

◆ ResetColorArray()

◆ SetColorMap()

◆ SetVisibility()

◆ GetVisibility()

◆ GetBounds()

◆ GetRenderedArrayName()

◆ GetRenderedFieldAssociation()

◆ GetDataRange()

◆ GetColorMap()

◆ GetVolume()

◆ GetVolumeProperty()

◆ GetVolumeMapper()

◆ RequestData()

◆ AddToView()

◆ RemoveFromView()