VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSmartVolumeMapper Class Reference

Adaptive volume mapper. More...

#include <vtkSmartVolumeMapper.h>

Inheritance diagram for vtkSmartVolumeMapper:
[legend]
Collaboration diagram for vtkSmartVolumeMapper:
[legend]

Public Types

enum  {
  DefaultRenderMode =0, RayCastRenderMode =1, GPURenderMode =2, OSPRayRenderMode =3,
  UndefinedRenderMode =4, InvalidRenderMode =5
}
 
enum  VectorModeType { DISABLED = -1, MAGNITUDE = 0, COMPONENT = 1 }
 VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities. More...
 
typedef vtkVolumeMapper Superclass
 
- Public Types inherited from vtkVolumeMapper
enum  BlendModes {
  COMPOSITE_BLEND, MAXIMUM_INTENSITY_BLEND, MINIMUM_INTENSITY_BLEND, AVERAGE_INTENSITY_BLEND,
  ADDITIVE_BLEND, ISOSURFACE_BLEND, SLICE_BLEND
}
 Blend modes. More...
 
typedef vtkAbstractVolumeMapper Superclass
 
- Public Types inherited from vtkAbstractVolumeMapper
typedef vtkAbstractMapper3D Superclass
 
- Public Types inherited from vtkAbstractMapper3D
typedef vtkAbstractMapper Superclass
 
- Public Types inherited from vtkAbstractMapper
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. More...
 
vtkSmartVolumeMapperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFinalColorWindow (float)
 Set the final color window. More...
 
virtual float GetFinalColorWindow ()
 Get the final color window. More...
 
virtual void SetFinalColorLevel (float)
 Set the final color level. More...
 
virtual float GetFinalColorLevel ()
 Get the final color level. More...
 
void SetRequestedRenderMode (int mode)
 Set the requested render mode. More...
 
void SetRequestedRenderModeToDefault ()
 Set the requested render mode to vtkSmartVolumeMapper::DefaultRenderMode. More...
 
void SetRequestedRenderModeToRayCast ()
 Set the requested render mode to vtkSmartVolumeMapper::RayCastRenderMode. More...
 
void SetRequestedRenderModeToGPU ()
 Set the requested render mode to vtkSmartVolumeMapper::GPURenderMode. More...
 
void SetRequestedRenderModeToOSPRay ()
 Set the requested render mode to vtkSmartVolumeMapper::OSPRayRenderMode. More...
 
virtual int GetRequestedRenderMode ()
 Get the requested render mode. More...
 
int GetLastUsedRenderMode ()
 This will return the render mode used during the previous call to Render(). More...
 
virtual void SetMaxMemoryInBytes (vtkIdType)
 Value passed to the GPU mapper. More...
 
virtual vtkIdType GetMaxMemoryInBytes ()
 
virtual void SetMaxMemoryFraction (float)
 Value passed to the GPU mapper. More...
 
virtual float GetMaxMemoryFraction ()
 
virtual void SetInterpolationMode (int)
 Set interpolation mode for downsampling (lowres GPU) (initial value: cubic). More...
 
virtual int GetInterpolationMode ()
 
void SetInterpolationModeToNearestNeighbor ()
 
void SetInterpolationModeToLinear ()
 
void SetInterpolationModeToCubic ()
 
void CreateCanonicalView (vtkRenderer *ren, vtkVolume *volume, vtkVolume *volume2, vtkImageData *image, int blend_mode, double viewDirection[3], double viewUp[3])
 This method can be used to render a representative view of the input data into the supplied image given the supplied blending mode, view direction, and view up vector. More...
 
virtual void SetInteractiveUpdateRate (double)
 If the DesiredUpdateRate of the vtkRenderWindow that caused the Render falls at or above this rate, the render is considered interactive and the mapper may be adjusted (depending on the render mode). More...
 
virtual double GetInteractiveUpdateRate ()
 Get the update rate at or above which this is considered an interactive render. More...
 
virtual void SetInteractiveAdjustSampleDistances (vtkTypeBool)
 If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper. More...
 
virtual vtkTypeBool GetInteractiveAdjustSampleDistances ()
 
virtual void InteractiveAdjustSampleDistancesOn ()
 
virtual void InteractiveAdjustSampleDistancesOff ()
 
virtual void SetAutoAdjustSampleDistances (vtkTypeBool)
 If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use). More...
 
virtual vtkTypeBool GetAutoAdjustSampleDistances ()
 
virtual void AutoAdjustSampleDistancesOn ()
 
virtual void AutoAdjustSampleDistancesOff ()
 
virtual void SetSampleDistance (float)
 Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering. More...
 
virtual float GetSampleDistance ()
 
void Render (vtkRenderer *, vtkVolume *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper. More...
 
void SetVectorMode (int mode)
 
virtual int GetVectorMode ()
 
virtual void SetVectorComponent (int)
 
virtual int GetVectorComponent ()
 
- Public Member Functions inherited from vtkVolumeMapper
vtkVolumeMapperNewInstance () const
 
virtual void SetInputData (vtkImageData *)
 Set/Get the input data. More...
 
virtual void SetInputData (vtkDataSet *)
 
virtual vtkImageDataGetInput ()
 
virtual vtkImageDataGetInput (const int port)
 
virtual void SetBlendMode (int)
 Set/Get the blend mode. More...
 
void SetBlendModeToComposite ()
 
void SetBlendModeToMaximumIntensity ()
 
void SetBlendModeToMinimumIntensity ()
 
void SetBlendModeToAverageIntensity ()
 
void SetBlendModeToAdditive ()
 
void SetBlendModeToIsoSurface ()
 
void SetBlendModeToSlice ()
 
virtual int GetBlendMode ()
 
virtual void SetAverageIPScalarRange (double, double)
 Set/Get the scalar range to be considered for average intensity projection blend mode. More...
 
void SetAverageIPScalarRange (double[2])
 
virtual doubleGetAverageIPScalarRange ()
 
virtual void GetAverageIPScalarRange (double data[2])
 
virtual void SetCropping (vtkTypeBool)
 Turn On/Off orthogonal cropping. More...
 
virtual vtkTypeBool GetCropping ()
 
virtual void CroppingOn ()
 
virtual void CroppingOff ()
 
virtual void SetCroppingRegionPlanes (double, double, double, double, double, double)
 Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered. More...
 
virtual void SetCroppingRegionPlanes (double[6])
 
virtual doubleGetCroppingRegionPlanes ()
 
virtual void GetCroppingRegionPlanes (double data[6])
 
virtual doubleGetVoxelCroppingRegionPlanes ()
 Get the cropping region planes in voxels. More...
 
virtual void GetVoxelCroppingRegionPlanes (double data[6])
 
virtual void SetCroppingRegionFlags (int)
 Set the flags for the cropping regions. More...
 
virtual int GetCroppingRegionFlags ()
 
void SetCroppingRegionFlagsToSubVolume ()
 
void SetCroppingRegionFlagsToFence ()
 
void SetCroppingRegionFlagsToInvertedFence ()
 
void SetCroppingRegionFlagsToCross ()
 
void SetCroppingRegionFlagsToInvertedCross ()
 
- Public Member Functions inherited from vtkAbstractVolumeMapper
vtkAbstractVolumeMapperNewInstance () const
 
virtual vtkDataSetGetDataSetInput ()
 Set/Get the input data. More...
 
virtual vtkDataObjectGetDataObjectInput ()
 
doubleGetBounds () override
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6]) override
 Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void SetScalarMode (int)
 Control how the mapper works with scalar point data and cell attribute data. More...
 
virtual int GetScalarMode ()
 
virtual void SetArrayAccessMode (int)
 
void SetScalarModeToDefault ()
 
void SetScalarModeToUsePointData ()
 
void SetScalarModeToUseCellData ()
 
void SetScalarModeToUsePointFieldData ()
 
void SetScalarModeToUseCellFieldData ()
 
virtual void SelectScalarArray (int arrayNum)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering. More...
 
virtual void SelectScalarArray (const char *arrayName)
 
virtual char * GetArrayName ()
 Get the array name or number and component to use for rendering. More...
 
virtual int GetArrayId ()
 
virtual int GetArrayAccessMode ()
 
const char * GetScalarModeAsString ()
 Return the method for obtaining scalar data. More...
 
virtual float GetGradientMagnitudeScale ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...
 
virtual float GetGradientMagnitudeBias ()
 
virtual float GetGradientMagnitudeScale (int)
 
virtual float GetGradientMagnitudeBias (int)
 
- Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3DNewInstance () const
 
doubleGetCenter ()
 Return the Center of this mapper's data. More...
 
void GetCenter (double center[3])
 
double GetLength ()
 Return the diagonal length of this mappers bounding box. More...
 
virtual vtkTypeBool IsARayCastMapper ()
 Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper. More...
 
virtual vtkTypeBool IsARenderIntoImageMapper ()
 Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer. More...
 
void GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
 Get the ith clipping plane as a homogeneous plane equation. More...
 
- Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapperNewInstance () const
 
vtkMTimeType GetMTime () override
 Override Modifiedtime as we have added Clipping planes. More...
 
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered. More...
 
void AddClippingPlane (vtkPlane *plane)
 Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
 
void RemoveClippingPlane (vtkPlane *plane)
 
void RemoveAllClippingPlanes ()
 
virtual void SetClippingPlanes (vtkPlaneCollection *)
 Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
void SetClippingPlanes (vtkPlanes *planes)
 An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes. More...
 
virtual void ShallowCopy (vtkAbstractMapper *m)
 Make a shallow copy of this mapper. More...
 
int GetNumberOfClippingPlanes ()
 Get the number of clipping planes. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkSmartVolumeMapperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSmartVolumeMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkVolumeMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumeMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractVolumeMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractVolumeMapperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapper3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractMapperSafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars. More...
 
static vtkAbstractArrayGetAbstractScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
 Internal helper function for getting the active scalars as an abstract array. More...
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSmartVolumeMapper ()
 
 ~vtkSmartVolumeMapper () override
 
void ConnectMapperInput (vtkVolumeMapper *m)
 Connect input of the vtkSmartVolumeMapper to the input of the internal volume mapper by doing a shallow to avoid memory leaks. More...
 
void ConnectFilterInput (vtkImageResample *f)
 Connect input of the vtkSmartVolumeMapper to the input of the internal resample filter by doing a shallow to avoid memory leaks. More...
 
void Initialize (vtkRenderer *ren, vtkVolume *vol)
 The initialize method. More...
 
void ComputeRenderMode (vtkRenderer *ren, vtkVolume *vol)
 The method that computes the render mode from the requested render mode based on the support status for each render method. More...
 
virtual vtkGPUVolumeRayCastMapperGetGPUMapper ()
 
- Protected Member Functions inherited from vtkVolumeMapper
 vtkVolumeMapper ()
 
 ~vtkVolumeMapper () override
 
double SpacingAdjustedSampleDistance (double inputSpacing[3], int inputExtent[6])
 Compute a sample distance from the data spacing. More...
 
void ConvertCroppingRegionPlanesToVoxels ()
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAbstractVolumeMapper
 vtkAbstractVolumeMapper ()
 
 ~vtkAbstractVolumeMapper () override
 
- Protected Member Functions inherited from vtkAbstractMapper3D
 vtkAbstractMapper3D ()
 
 ~vtkAbstractMapper3D () override
 
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 
 ~vtkAbstractMapper () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

float FinalColorWindow
 Window / level ivars. More...
 
float FinalColorLevel
 
vtkIdType MaxMemoryInBytes
 GPU mapper-specific memory ivars. More...
 
float MaxMemoryFraction
 
int InterpolationMode
 Used for downsampling. More...
 
int RequestedRenderMode
 The requested render mode is used to compute the current render mode. More...
 
int CurrentRenderMode
 
int Initialized
 Initialization variables. More...
 
vtkTimeStamp SupportStatusCheckTime
 
int GPUSupported
 
int RayCastSupported
 
int LowResGPUNecessary
 
vtkImageResampleGPUResampleFilter
 This is the resample filter that may be used if we need to create a low resolution version of the volume for GPU rendering. More...
 
vtkImageMagnitudeImageMagnitude
 This filter is used to compute the magnitude of 3-component data. More...
 
vtkImageDataInputDataMagnitude
 
vtkGPUVolumeRayCastMapperGPULowResMapper
 The three potential mappers. More...
 
vtkGPUVolumeRayCastMapperGPUMapper
 
vtkFixedPointVolumeRayCastMapperRayCastMapper
 
int InitializedBlendMode
 We need to keep track of the blend mode we had when we initialized because we need to reinitialize (and recheck hardware support) if it changes. More...
 
float SampleDistance
 The distance between sample points along the ray. More...
 
vtkTypeBool AutoAdjustSampleDistances
 Set whether or not the sample distance should be automatically calculated within the internal volume mapper. More...
 
double InteractiveUpdateRate
 If the DesiredUpdateRate of the vtkRenderWindow causing the Render is at or above this value, the render is considered interactive. More...
 
vtkTypeBool InteractiveAdjustSampleDistances
 If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper. More...
 
int VectorMode
 VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities. More...
 
int VectorComponent
 
vtkTimeStamp MagnitudeUploadTime
 
- Protected Attributes inherited from vtkVolumeMapper
int BlendMode
 
double AverageIPScalarRange [2]
 Threshold range for average intensity projection. More...
 
vtkTypeBool Cropping
 Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...
 
double CroppingRegionPlanes [6]
 
double VoxelCroppingRegionPlanes [6]
 
int CroppingRegionFlags
 
- Protected Attributes inherited from vtkAbstractVolumeMapper
int ScalarMode
 
char * ArrayName
 
int ArrayId
 
int ArrayAccessMode
 
- Protected Attributes inherited from vtkAbstractMapper3D
double Bounds [6]
 
double Center [3]
 
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
 
double TimeToDraw
 
vtkWindowLastWindow
 
vtkPlaneCollectionClippingPlanes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkMultiBlockVolumeMapper
 Expose GPU mapper for additional customization. More...
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Adaptive volume mapper.

vtkSmartVolumeMapper is a volume mapper that will delegate to a specific volume mapper based on rendering parameters and available hardware. Use the SetRequestedRenderMode() method to control the behavior of the selection. The following options are available:

vtkSmartVolumeMapper::DefaultRenderMode:
Allow the vtkSmartVolumeMapper to select the best mapper based on rendering parameters and hardware support. If GPU ray casting is supported, this mapper will be used for all rendering. If not, then the vtkFixedPointRayCastMapper will be used exclusively. This is the default requested render mode, and is generally the best option. When you use this option, your volume will always be rendered, but the method used to render it may vary based on parameters and platform.
vtkSmartVolumeMapper::RayCastRenderMode:
Use the vtkFixedPointVolumeRayCastMapper for both interactive and still rendering. When you use this option your volume will always be rendered with the vtkFixedPointVolumeRayCastMapper.
vtkSmartVolumeMapper::GPURenderMode:
Use the vtkGPUVolumeRayCastMapper, if supported, for both interactive and still rendering. If the GPU ray caster is not supported (due to hardware limitations or rendering parameters) then no image will be rendered. Use this option only if you have already checked for supported based on the current hardware, number of scalar components, and rendering parameters in the vtkVolumeProperty.
vtkSmartVolumeMapper::GPURenderMode:
You can adjust the contrast and brightness in the rendered image using the FinalColorWindow and FinalColorLevel ivars. By default the FinalColorWindow is set to 1.0, and the FinalColorLevel is set to 0.5, which applies no correction to the computed image. To apply the window / level operation to the computer image color, first a Scale and Bias value are computed:
 scale = 1.0 / this->FinalColorWindow
 bias  = 0.5 - this->FinalColorLevel / this->FinalColorWindow
 
To compute a new color (R', G', B', A') from an existing color (R,G,B,A) for a pixel, the following equation is used:
 R' = R*scale + bias*A
 G' = G*scale + bias*A
 B' = B*scale + bias*A
 A' = A
 
Note that bias is multiplied by the alpha component before adding because the red, green, and blue component of the color are already pre-multiplied by alpha. Also note that the window / level operation leaves the alpha component unchanged - it only adjusts the RGB values.
Examples:
vtkSmartVolumeMapper (Examples)
Tests:
vtkSmartVolumeMapper (Tests)

Definition at line 96 of file vtkSmartVolumeMapper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 100 of file vtkSmartVolumeMapper.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
DefaultRenderMode 
RayCastRenderMode 
GPURenderMode 
OSPRayRenderMode 
UndefinedRenderMode 
InvalidRenderMode 

Definition at line 143 of file vtkSmartVolumeMapper.h.

◆ VectorModeType

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

Enumerator
DISABLED 
MAGNITUDE 
COMPONENT 

Definition at line 330 of file vtkSmartVolumeMapper.h.

Constructor & Destructor Documentation

◆ vtkSmartVolumeMapper()

vtkSmartVolumeMapper::vtkSmartVolumeMapper ( )
protected

◆ ~vtkSmartVolumeMapper()

vtkSmartVolumeMapper::~vtkSmartVolumeMapper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSmartVolumeMapper* vtkSmartVolumeMapper::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkSmartVolumeMapper::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkSmartVolumeMapper::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 vtkVolumeMapper.

◆ SafeDownCast()

static vtkSmartVolumeMapper* vtkSmartVolumeMapper::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSmartVolumeMapper::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkVolumeMapper.

◆ NewInstance()

vtkSmartVolumeMapper* vtkSmartVolumeMapper::NewInstance ( ) const

◆ PrintSelf()

void vtkSmartVolumeMapper::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 vtkVolumeMapper.

◆ SetFinalColorWindow()

virtual void vtkSmartVolumeMapper::SetFinalColorWindow ( float  )
virtual

Set the final color window.

This controls the contrast of the image. The default value is 1.0. The Window can be negative (this causes a "negative" effect on the image) Although Window can be set to 0.0, any value less than 0.00001 and greater than or equal to 0.0 will be set to 0.00001, and any value greater than -0.00001 but less than or equal to 0.0 will be set to -0.00001. Initial value is 1.0.

◆ GetFinalColorWindow()

virtual float vtkSmartVolumeMapper::GetFinalColorWindow ( )
virtual

Get the final color window.

Initial value is 1.0.

◆ SetFinalColorLevel()

virtual void vtkSmartVolumeMapper::SetFinalColorLevel ( float  )
virtual

Set the final color level.

The level controls the brightness of the image. The final color window will be centered at the final color level, and together represent a linear remapping of color values. The default value for the level is 0.5.

◆ GetFinalColorLevel()

virtual float vtkSmartVolumeMapper::GetFinalColorLevel ( )
virtual

Get the final color level.

◆ SetRequestedRenderMode()

void vtkSmartVolumeMapper::SetRequestedRenderMode ( int  mode)

Set the requested render mode.

The default is vtkSmartVolumeMapper::DefaultRenderMode.

◆ SetRequestedRenderModeToDefault()

void vtkSmartVolumeMapper::SetRequestedRenderModeToDefault ( )

Set the requested render mode to vtkSmartVolumeMapper::DefaultRenderMode.

This is the best option for an application that must adapt to different data types, hardware, and rendering parameters.

◆ SetRequestedRenderModeToRayCast()

void vtkSmartVolumeMapper::SetRequestedRenderModeToRayCast ( )

Set the requested render mode to vtkSmartVolumeMapper::RayCastRenderMode.

This option will use software rendering exclusively. This is a good option if you know there is no hardware acceleration.

◆ SetRequestedRenderModeToGPU()

void vtkSmartVolumeMapper::SetRequestedRenderModeToGPU ( )

Set the requested render mode to vtkSmartVolumeMapper::GPURenderMode.

This option will use hardware accelerated rendering exclusively. This is a good option if you know there is hardware acceleration.

◆ SetRequestedRenderModeToOSPRay()

void vtkSmartVolumeMapper::SetRequestedRenderModeToOSPRay ( )

Set the requested render mode to vtkSmartVolumeMapper::OSPRayRenderMode.

This option will use intel OSPRay to do software rendering exclusively.

◆ GetRequestedRenderMode()

virtual int vtkSmartVolumeMapper::GetRequestedRenderMode ( )
virtual

Get the requested render mode.

◆ GetLastUsedRenderMode()

int vtkSmartVolumeMapper::GetLastUsedRenderMode ( )

This will return the render mode used during the previous call to Render().

◆ SetMaxMemoryInBytes()

virtual void vtkSmartVolumeMapper::SetMaxMemoryInBytes ( vtkIdType  )
virtual

Value passed to the GPU mapper.

Ignored by other mappers. Maximum size of the 3D texture in GPU memory. Will default to the size computed from the graphics card. Can be adjusted by the user. Useful if the automatic detection is defective or missing.

◆ GetMaxMemoryInBytes()

virtual vtkIdType vtkSmartVolumeMapper::GetMaxMemoryInBytes ( )
virtual

◆ SetMaxMemoryFraction()

virtual void vtkSmartVolumeMapper::SetMaxMemoryFraction ( float  )
virtual

Value passed to the GPU mapper.

Ignored by other mappers. Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

◆ GetMaxMemoryFraction()

virtual float vtkSmartVolumeMapper::GetMaxMemoryFraction ( )
virtual

◆ SetInterpolationMode()

virtual void vtkSmartVolumeMapper::SetInterpolationMode ( int  )
virtual

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

◆ GetInterpolationMode()

virtual int vtkSmartVolumeMapper::GetInterpolationMode ( )
virtual

◆ SetInterpolationModeToNearestNeighbor()

void vtkSmartVolumeMapper::SetInterpolationModeToNearestNeighbor ( )

◆ SetInterpolationModeToLinear()

void vtkSmartVolumeMapper::SetInterpolationModeToLinear ( )

◆ SetInterpolationModeToCubic()

void vtkSmartVolumeMapper::SetInterpolationModeToCubic ( )

◆ CreateCanonicalView()

void vtkSmartVolumeMapper::CreateCanonicalView ( vtkRenderer ren,
vtkVolume volume,
vtkVolume volume2,
vtkImageData image,
int  blend_mode,
double  viewDirection[3],
double  viewUp[3] 
)

This method can be used to render a representative view of the input data into the supplied image given the supplied blending mode, view direction, and view up vector.

◆ SetInteractiveUpdateRate()

virtual void vtkSmartVolumeMapper::SetInteractiveUpdateRate ( double  )
virtual

If the DesiredUpdateRate of the vtkRenderWindow that caused the Render falls at or above this rate, the render is considered interactive and the mapper may be adjusted (depending on the render mode).

Initial value is 1.0.

◆ GetInteractiveUpdateRate()

virtual double vtkSmartVolumeMapper::GetInteractiveUpdateRate ( )
virtual

Get the update rate at or above which this is considered an interactive render.

Initial value is 1.0.

◆ SetInteractiveAdjustSampleDistances()

virtual void vtkSmartVolumeMapper::SetInteractiveAdjustSampleDistances ( vtkTypeBool  )
virtual

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still. By default, InteractiveAdjustSampleDistances is enabled.

◆ GetInteractiveAdjustSampleDistances()

virtual vtkTypeBool vtkSmartVolumeMapper::GetInteractiveAdjustSampleDistances ( )
virtual

◆ InteractiveAdjustSampleDistancesOn()

virtual void vtkSmartVolumeMapper::InteractiveAdjustSampleDistancesOn ( )
virtual

◆ InteractiveAdjustSampleDistancesOff()

virtual void vtkSmartVolumeMapper::InteractiveAdjustSampleDistancesOff ( )
virtual

◆ SetAutoAdjustSampleDistances()

virtual void vtkSmartVolumeMapper::SetAutoAdjustSampleDistances ( vtkTypeBool  )
virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

Note that, this flag is ignored when InteractiveAdjustSampleDistances is enabled. To explicitly set and use this flag, one must disable InteractiveAdjustSampleDistances.

◆ GetAutoAdjustSampleDistances()

virtual vtkTypeBool vtkSmartVolumeMapper::GetAutoAdjustSampleDistances ( )
virtual

◆ AutoAdjustSampleDistancesOn()

virtual void vtkSmartVolumeMapper::AutoAdjustSampleDistancesOn ( )
virtual

◆ AutoAdjustSampleDistancesOff()

virtual void vtkSmartVolumeMapper::AutoAdjustSampleDistancesOff ( )
virtual

◆ SetSampleDistance()

virtual void vtkSmartVolumeMapper::SetSampleDistance ( float  )
virtual

Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.

If SampleDistance is negative, it will be computed based on the dataset spacing. Initial value is -1.0.

◆ GetSampleDistance()

virtual float vtkSmartVolumeMapper::GetSampleDistance ( )
virtual

◆ Render()

void vtkSmartVolumeMapper::Render ( vtkRenderer ,
vtkVolume  
)
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume.

Implements vtkVolumeMapper.

◆ ReleaseGraphicsResources()

void vtkSmartVolumeMapper::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkVolumeMapper.

◆ SetVectorMode()

void vtkSmartVolumeMapper::SetVectorMode ( int  mode)

◆ GetVectorMode()

virtual int vtkSmartVolumeMapper::GetVectorMode ( )
virtual

◆ SetVectorComponent()

virtual void vtkSmartVolumeMapper::SetVectorComponent ( int  )
virtual

◆ GetVectorComponent()

virtual int vtkSmartVolumeMapper::GetVectorComponent ( )
virtual

◆ ConnectMapperInput()

void vtkSmartVolumeMapper::ConnectMapperInput ( vtkVolumeMapper m)
protected

Connect input of the vtkSmartVolumeMapper to the input of the internal volume mapper by doing a shallow to avoid memory leaks.

Precondition
m_exists: m!=0

◆ ConnectFilterInput()

void vtkSmartVolumeMapper::ConnectFilterInput ( vtkImageResample f)
protected

Connect input of the vtkSmartVolumeMapper to the input of the internal resample filter by doing a shallow to avoid memory leaks.

Precondition
m_exists: f!=0

◆ Initialize()

void vtkSmartVolumeMapper::Initialize ( vtkRenderer ren,
vtkVolume vol 
)
protected

The initialize method.

Called from ComputeRenderMode whenever something relevant has changed.

◆ ComputeRenderMode()

void vtkSmartVolumeMapper::ComputeRenderMode ( vtkRenderer ren,
vtkVolume vol 
)
protected

The method that computes the render mode from the requested render mode based on the support status for each render method.

◆ GetGPUMapper()

virtual vtkGPUVolumeRayCastMapper* vtkSmartVolumeMapper::GetGPUMapper ( )
protectedvirtual

Friends And Related Function Documentation

◆ vtkMultiBlockVolumeMapper

friend class vtkMultiBlockVolumeMapper
friend

Expose GPU mapper for additional customization.

Definition at line 441 of file vtkSmartVolumeMapper.h.

Member Data Documentation

◆ FinalColorWindow

float vtkSmartVolumeMapper::FinalColorWindow
protected

Window / level ivars.

Definition at line 366 of file vtkSmartVolumeMapper.h.

◆ FinalColorLevel

float vtkSmartVolumeMapper::FinalColorLevel
protected

Definition at line 367 of file vtkSmartVolumeMapper.h.

◆ MaxMemoryInBytes

vtkIdType vtkSmartVolumeMapper::MaxMemoryInBytes
protected

GPU mapper-specific memory ivars.

Definition at line 374 of file vtkSmartVolumeMapper.h.

◆ MaxMemoryFraction

float vtkSmartVolumeMapper::MaxMemoryFraction
protected

Definition at line 375 of file vtkSmartVolumeMapper.h.

◆ InterpolationMode

int vtkSmartVolumeMapper::InterpolationMode
protected

Used for downsampling.

Definition at line 381 of file vtkSmartVolumeMapper.h.

◆ RequestedRenderMode

int vtkSmartVolumeMapper::RequestedRenderMode
protected

The requested render mode is used to compute the current render mode.

Note that the current render mode can be invalid if the requested mode is not supported.

Definition at line 389 of file vtkSmartVolumeMapper.h.

◆ CurrentRenderMode

int vtkSmartVolumeMapper::CurrentRenderMode
protected

Definition at line 390 of file vtkSmartVolumeMapper.h.

◆ Initialized

int vtkSmartVolumeMapper::Initialized
protected

Initialization variables.

Definition at line 397 of file vtkSmartVolumeMapper.h.

◆ SupportStatusCheckTime

vtkTimeStamp vtkSmartVolumeMapper::SupportStatusCheckTime
protected

Definition at line 398 of file vtkSmartVolumeMapper.h.

◆ GPUSupported

int vtkSmartVolumeMapper::GPUSupported
protected

Definition at line 399 of file vtkSmartVolumeMapper.h.

◆ RayCastSupported

int vtkSmartVolumeMapper::RayCastSupported
protected

Definition at line 400 of file vtkSmartVolumeMapper.h.

◆ LowResGPUNecessary

int vtkSmartVolumeMapper::LowResGPUNecessary
protected

Definition at line 401 of file vtkSmartVolumeMapper.h.

◆ GPUResampleFilter

vtkImageResample* vtkSmartVolumeMapper::GPUResampleFilter
protected

This is the resample filter that may be used if we need to create a low resolution version of the volume for GPU rendering.

Definition at line 408 of file vtkSmartVolumeMapper.h.

◆ ImageMagnitude

vtkImageMagnitude* vtkSmartVolumeMapper::ImageMagnitude
protected

This filter is used to compute the magnitude of 3-component data.

MAGNITUDE is one of the supported modes when rendering separately a single independent component.

Note
This feature was added specifically for ParaView so it might eventually be moved into a derived mapper in ParaView.

Definition at line 420 of file vtkSmartVolumeMapper.h.

◆ InputDataMagnitude

vtkImageData* vtkSmartVolumeMapper::InputDataMagnitude
protected

Definition at line 421 of file vtkSmartVolumeMapper.h.

◆ GPULowResMapper

vtkGPUVolumeRayCastMapper* vtkSmartVolumeMapper::GPULowResMapper
protected

The three potential mappers.

Definition at line 442 of file vtkSmartVolumeMapper.h.

◆ GPUMapper

vtkGPUVolumeRayCastMapper* vtkSmartVolumeMapper::GPUMapper
protected

Definition at line 449 of file vtkSmartVolumeMapper.h.

◆ RayCastMapper

vtkFixedPointVolumeRayCastMapper* vtkSmartVolumeMapper::RayCastMapper
protected

Definition at line 450 of file vtkSmartVolumeMapper.h.

◆ InitializedBlendMode

int vtkSmartVolumeMapper::InitializedBlendMode
protected

We need to keep track of the blend mode we had when we initialized because we need to reinitialize (and recheck hardware support) if it changes.

Definition at line 459 of file vtkSmartVolumeMapper.h.

◆ SampleDistance

float vtkSmartVolumeMapper::SampleDistance
protected

The distance between sample points along the ray.

Definition at line 464 of file vtkSmartVolumeMapper.h.

◆ AutoAdjustSampleDistances

vtkTypeBool vtkSmartVolumeMapper::AutoAdjustSampleDistances
protected

Set whether or not the sample distance should be automatically calculated within the internal volume mapper.

Definition at line 470 of file vtkSmartVolumeMapper.h.

◆ InteractiveUpdateRate

double vtkSmartVolumeMapper::InteractiveUpdateRate
protected

If the DesiredUpdateRate of the vtkRenderWindow causing the Render is at or above this value, the render is considered interactive.

Otherwise it is considered still.

Definition at line 477 of file vtkSmartVolumeMapper.h.

◆ InteractiveAdjustSampleDistances

vtkTypeBool vtkSmartVolumeMapper::InteractiveAdjustSampleDistances
protected

If the InteractiveAdjustSampleDistances flag is enabled, vtkSmartVolumeMapper interactively sets and resets the AutoAdjustSampleDistances flag on the internal volume mapper.

This flag along with InteractiveUpdateRate is useful to adjust volume mapper sample distance based on whether the render is interactive or still.

Definition at line 486 of file vtkSmartVolumeMapper.h.

◆ VectorMode

int vtkSmartVolumeMapper::VectorMode
protected

VectorMode is a special rendering mode for 3-component vectors which makes use of GPURayCastMapper's independent-component capabilities.

In this mode, a single component in the vector can be selected for rendering. In addition, the mapper can compute a scalar field representing the magnitude of this vector using a vtkImageMagnitude object (MAGNITUDE mode).

Definition at line 496 of file vtkSmartVolumeMapper.h.

◆ VectorComponent

int vtkSmartVolumeMapper::VectorComponent
protected

Definition at line 497 of file vtkSmartVolumeMapper.h.

◆ MagnitudeUploadTime

vtkTimeStamp vtkSmartVolumeMapper::MagnitudeUploadTime
protected

Definition at line 498 of file vtkSmartVolumeMapper.h.


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