VTK: vtkImageMapper3D Class Reference

| VTK 9.3.1

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkImageMapper3D Class Referenceabstract

abstract class for mapping images to the screen More...

`#include <vtkImageMapper3D.h>`

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

## Public Types
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...
vtkImageMapper3D * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
virtual void | Render (vtkRenderer *renderer, vtkImageSlice *prop)=0
| This should only be called by the renderer. More...
void | ReleaseGraphicsResources (vtkWindow *) override=0
| Release any graphics resources that are being consumed by this mapper. More...
virtual void | GetSlicePlaneInDataCoords (vtkMatrix4x4 *propMatrix, double plane[4])
| Get the plane as a homogeneous 4-vector that gives the plane equation coefficients. More...
virtual void | GetIndexBounds (double extent[6])=0
void | SetInputData (vtkImageData *input)
| The input data for this mapper. More...
vtkImageData * | GetInput ()
| The input data for this mapper. More...
vtkDataSet * | GetDataSetInput ()
| The input data for this mapper. More...
vtkDataObject * | GetDataObjectInput ()
| The input data for this mapper. More...
virtual void | SetBorder (vtkTypeBool)
| Instead of displaying the image only out to the image bounds, include a half-voxel border around the image. More...
virtual void | BorderOn ()
| Instead of displaying the image only out to the image bounds, include a half-voxel border around the image. More...
virtual void | BorderOff ()
| Instead of displaying the image only out to the image bounds, include a half-voxel border around the image. More...
virtual vtkTypeBool | GetBorder ()
| Instead of displaying the image only out to the image bounds, include a half-voxel border around the image. More...
virtual void | SetBackground (vtkTypeBool)
| Instead of rendering only to the image border, render out to the viewport boundary with the background color. More...
virtual void | BackgroundOn ()
| Instead of rendering only to the image border, render out to the viewport boundary with the background color. More...
virtual void | BackgroundOff ()
| Instead of rendering only to the image border, render out to the viewport boundary with the background color. More...
virtual vtkTypeBool | GetBackground ()
| Instead of rendering only to the image border, render out to the viewport boundary with the background color. More...
virtual void | SetSliceAtFocalPoint (vtkTypeBool)
| Automatically set the slice position to the camera focal point. More...
virtual void | SliceAtFocalPointOn ()
| Automatically set the slice position to the camera focal point. More...
virtual void | SliceAtFocalPointOff ()
| Automatically set the slice position to the camera focal point. More...
virtual vtkTypeBool | GetSliceAtFocalPoint ()
| Automatically set the slice position to the camera focal point. More...
virtual void | SetSliceFacesCamera (vtkTypeBool)
| Automatically set the slice orientation so that it faces the camera. More...
virtual void | SliceFacesCameraOn ()
| Automatically set the slice orientation so that it faces the camera. More...
virtual void | SliceFacesCameraOff ()
| Automatically set the slice orientation so that it faces the camera. More...
virtual vtkTypeBool | GetSliceFacesCamera ()
| Automatically set the slice orientation so that it faces the camera. More...
virtual vtkPlane * | GetSlicePlane ()
| A plane that describes what slice of the input is being rendered by the mapper. More...
virtual void | SetNumberOfThreads (int)
| The number of threads to create when rendering. More...
virtual int | GetNumberOfThreads ()
| The number of threads to create when rendering. More...
virtual void | SetStreaming (vtkTypeBool)
| Turn on streaming, to pull the minimum amount of data from the input. More...
virtual vtkTypeBool | GetStreaming ()
| Turn on streaming, to pull the minimum amount of data from the input. More...
virtual void | StreamingOn ()
| Turn on streaming, to pull the minimum amount of data from the input. More...
virtual void | StreamingOff ()
| Turn on streaming, to pull the minimum amount of data from the input. More...
Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3D * | NewInstance () const
virtual double * | GetBounds ()=0
| Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
virtual void | GetBounds (double bounds[6])
| Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
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...
double * | GetCenter ()
| Return the Center of this mapper's data. More...
void | GetCenter (double center[3])
| Return the Center of this mapper's data. More...
Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper * | NewInstance () const
vtkMTimeType | GetMTime () override
| Override Modifiedtime as we have added Clipping planes. More...
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...
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)
| Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
void | RemoveAllClippingPlanes ()
| Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
virtual void | SetClippingPlanes (vtkPlaneCollection *)
| Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
virtual vtkPlaneCollection * | GetClippingPlanes ()
| Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * | NewInstance () const
vtkTypeBool | HasExecutive ()
| Check whether this algorithm has an assigned executive. More...
vtkExecutive * | GetExecutive ()
| Get this algorithm's executive. More...
virtual void | SetExecutive (vtkExecutive *executive)
| Set this algorithm's executive. 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...
vtkInformation * | GetInputPortInformation (int port)
| Get the information object associated with an input port. More...
vtkInformation * | GetOutputPortInformation (int port)
| Get the information object associated with an output port. More...
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 | SetAbortExecuteAndUpdateTime ()
| Set AbortExecute Flag and update LastAbortTime. More...
void | UpdateProgress (double amount)
| Update the progress of the process object. More...
bool | CheckAbort ()
| Checks to see if this filter should abort. More...
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
| String based versions of SetInputArrayToProcess(). More...
vtkInformation * | GetInputArrayInformation (int idx)
| Get the info object for the specified input array to this algorithm. More...
void | RemoveAllInputs ()
| Remove all the input data. More...
vtkDataObject * | GetOutputDataObject (int port)
| Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject * | GetInputDataObject (int port, int connection)
| Get the data object that will contain the algorithm input for the given port and given connection. More...
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)
vtkAlgorithmOutput * | GetOutputPort (int index)
| Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput * | GetOutputPort ()
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...
vtkAlgorithmOutput * | GetInputConnection (int port, int index)
| Get the algorithm output port connected to an input port. More...
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. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index)
| Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm ()
| Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive * | GetInputExecutive (int port, int index)
| Returns the executive associated with a particular input connection. More...
vtkExecutive * | GetInputExecutive ()
| Equivalent to GetInputExecutive(0, 0) More...
vtkInformation * | GetInputInformation (int port, int index)
| Return the information object that is associated with a particular input connection. More...
vtkInformation * | GetInputInformation ()
| Equivalent to GetInputInformation(0, 0) More...
vtkInformation * | GetOutputInformation (int port)
| Return the information object that is associated with a particular output port. More...
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 vtkInformation * | GetInformation ()
| Set/Get the information object associated with this algorithm. More...
virtual void | SetInformation (vtkInformation *)
| Set/Get the information object associated with this algorithm. More...
bool | UsesGarbageCollector () const override
| Participate in garbage collection. More...
virtual void | SetAbortExecute (vtkTypeBool)
| Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool | GetAbortExecute ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOn ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOff ()
| Set/Get the AbortExecute flag for the process object. More...
virtual double | GetProgress ()
| Get the execution progress of a process object. More...
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg)
| Set/get a Container algorithm for this algorithm. More...
vtkAlgorithm * | GetContainerAlgorithm ()
| Set/get a Container algorithm for this algorithm. More...
virtual void | SetAbortOutput (bool)
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
virtual bool | GetAbortOutput ()
| Set/Get an internal variable used to communicate between the algorithm and executive. 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 ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressScale ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
void | SetProgressText (const char *ptext)
| Set the current text message associated with the progress state. More...
virtual char * | GetProgressText ()
| Set the current text message associated with the progress state. More...
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)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | SetInputConnection (vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | AddInputConnection (vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | Update (int port)
| Bring this algorithm's outputs up-to-date. More...
virtual void | Update ()
| Bring this algorithm's outputs up-to-date. More...
virtual void | SetReleaseDataFlag (vtkTypeBool)
| Turn release data flag on or off for all output ports. More...
virtual vtkTypeBool | GetReleaseDataFlag ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOn ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOff ()
| Turn release data flag on or off for all output ports. More...
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)
| 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 * | GetUpdateExtent ()
| These functions return the update extent for output ports that use 3D extents. More...
int * | GetUpdateExtent (int port)
| These functions return the update extent for output ports that use 3D extents. More...
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. More...
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. More...
void | GetUpdateExtent (int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
int | GetUpdatePiece ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdatePiece (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel (int port)
| These functions return the update extent for output ports that use piece extents. More...
void | SetProgressObserver (vtkProgressObserver *)
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver * | GetProgressObserver ()
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
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...
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. 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)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand * | GetCommand (unsigned long tag)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObserver (vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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)
| 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, 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...
vtkTypeBool | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
vtkTypeBool | InvokeEvent (const char *event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
virtual void | SetObjectName (const std::string &objectName)
| Set/get the name of this object for reporting purposes. More...
virtual std::string | GetObjectName () const
| Set/get the name of this object for reporting purposes. More...
Public Member Functions inherited from vtkObjectBase
const char * | GetClassName () const
| Return the class name as a string. More...
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). 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 | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
int | GetReferenceCount ()
| Return the current reference count of this object. More...
void | SetReferenceCount (int)
| Sets the reference count. More...
bool | GetIsInMemkind () const
| A local state flag that remembers whether this object lives in the normal or extended memory space. More...
virtual void | PrintHeader (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...
virtual void | PrintTrailer (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...

## Static Public Member Functions
static vtkTypeBool | IsTypeOf (const char *type)
static vtkImageMapper3D * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAbstractMapper3D * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAbstractMapper * | SafeDownCast (vtkObjectBase *o)
static vtkDataArray * | GetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
| Internal helper function for getting the active scalars. More...
static vtkAbstractArray * | GetAbstractScalars (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 vtkUnsignedCharArray * | GetGhostArray (vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
| Returns the ghost array associated with the corresponding scalar mode, if present. More...
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. More...
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. More...
static vtkInformationIntegerKey * | CAN_HANDLE_PIECE_REQUEST ()
| Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
static vtkInformationIntegerKey * | ABORTED ()
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 vtkObject * | New ()
| 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 (vtkTypeBool val)
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOn ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOff ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static vtkTypeBool | GetGlobalWarningDisplay ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
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 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). More...
static vtkObjectBase * | New ()
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void | SetMemkindDirectory (const char *directoryname)
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
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. More...

## Protected Member Functions
virtual vtkObjectBase * | NewInstanceInternal () const
| vtkImageMapper3D ()
| ~vtkImageMapper3D () override
vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
| Handle requests from the pipeline executive. More...
unsigned char * | MakeTextureData (vtkImageProperty *property, vtkImageData *input, int extent[6], int &xsize, int &ysize, int &bytesPerPixel, bool &reuseTexture, bool &reuseData)
| Perform window/level and color mapping operations to produce unsigned char data that can be used as a texture. More...
void | MakeTextureGeometry (const int extent[6], double coords[12], double tcoords[8])
| Compute the coordinates and texture coordinates for the image, given an extent that describes a single slice. More...
virtual void | ComputeTextureSize (const int extent[6], int &xdim, int &ydim, int imageSize[2], int textureSize[2])
| Given an extent that describes a slice (it must have unit thickness in one of the three directions), return the dimension indices that correspond to the texture "x" and "y", provide the x, y image size, and provide the texture size (padded to a power of two if the hardware requires). More...
vtkRenderer * | GetCurrentRenderer ()
| Get the renderer associated with this mapper, or zero if none. More...
vtkImageSlice * | GetCurrentProp ()
| Get the vtkImage prop associated with this mapper, or zero if none. More...
vtkMatrix4x4 * | GetDataToWorldMatrix ()
| Get the data-to-world matrix for this mapper, according to the assembly path for its prop. More...
void | GetBackgroundColor (vtkImageProperty *property, double color[4])
| Get the background color, by using the first color in the supplied lookup table, or black if there is no lookup table. More...
int | FillInputPortInformation (int port, vtkInformation *info) override
| See algorithm for more info. More...
int | FillOutputPortInformation (int port, vtkInformation *info) override
| See algorithm for more info. More...
Protected Member Functions inherited from vtkAbstractMapper3D
| vtkAbstractMapper3D ()
| ~vtkAbstractMapper3D () override=default
Protected Member Functions inherited from vtkAbstractMapper
| vtkAbstractMapper ()
| ~vtkAbstractMapper () override
Protected Member Functions inherited from vtkAlgorithm
| vtkAlgorithm ()
| ~vtkAlgorithm () override
bool | CheckUpstreamAbort ()
| Checks to see if an upstream filter has been aborted. 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 association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
| This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive * | CreateDefaultExecutive ()
| Create a default executive. 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)
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)
| Filters that have multiple connections on one port can use this signature. More...
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. More...
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. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
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. More...
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. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
virtual void | SetErrorCode (unsigned long)
| The error code contains a possible error that occurred while reading or writing the file. More...
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 ()
| These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
| vtkObjectBase ()
virtual | ~vtkObjectBase ()
| vtkObjectBase (const vtkObjectBase &)
void | operator= (const vtkObjectBase &)

## Static Protected Member Functions
static void | CheckerboardRGBA (unsigned char *data, int xsize, int ysize, double originx, double originy, double spacingx, double spacingy)
| Checkerboard the alpha component of an RGBA image. More...
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
vtkTypeBool | Border
vtkTypeBool | Background
vtkScalarsToColors * | DefaultLookupTable
vtkMultiThreader * | Threader
int | NumberOfThreads
vtkTypeBool | Streaming
vtkPlane * | SlicePlane
vtkTypeBool | SliceAtFocalPoint
vtkTypeBool | SliceFacesCamera
double | DataSpacing [3]
double | DataOrigin [3]
double | DataDirection [9]
int | DataWholeExtent [6]
bool | MatteEnable
bool | ColorEnable
bool | DepthEnable
Protected Attributes inherited from vtkAbstractMapper3D
double | Bounds [6]
double | Center [3]
Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog * | Timer
double | TimeToDraw
vtkWindow * | LastWindow
vtkPlaneCollection * | ClippingPlanes
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. More...
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

## Friends
class | vtkImageToImageMapper3DFriendship

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > | AbortExecute
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

abstract class for mapping images to the screen

vtkImageMapper3D is a mapper that will draw a 2D image, or a slice of a 3D image. The slice plane can be set automatically follow the camera, so that it slices through the focal point and faces the camera.

Thanks:
  Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.

See also
  vtkImage vtkImageProperty vtkImageResliceMapper vtkImageSliceMapper

Online Examples:

Tests:
  vtkImageMapper3D (Tests)

Definition at line 49 of file vtkImageMapper3D.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkAbstractMapper3D vtkImageMapper3D::Superclass

Definition at line 52 of file vtkImageMapper3D.h.

## Constructor & Destructor Documentation

## ◆ vtkImageMapper3D()

vtkImageMapper3D::vtkImageMapper3D | ( |  | ) |
| protected

## ◆ ~vtkImageMapper3D()

vtkImageMapper3D::~vtkImageMapper3D | ( |  | ) |
| overrideprotected

## Member Function Documentation

## ◆ IsTypeOf()

static vtkTypeBool vtkImageMapper3D::IsTypeOf | ( | const char * | type | ) |
| static

## ◆ IsA()

virtual vtkTypeBool vtkImageMapper3D::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 vtkAbstractMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper, vtkImageResliceMapper, and vtkImageSliceMapper.

## ◆ SafeDownCast()

static vtkImageMapper3D* vtkImageMapper3D::SafeDownCast | ( | vtkObjectBase * | o | ) |
| static

## ◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageMapper3D::NewInstanceInternal | ( |  | ) | const
| protectedvirtual

Reimplemented from vtkAbstractMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper, vtkImageResliceMapper, and vtkImageSliceMapper.

## ◆ NewInstance()

vtkImageMapper3D* vtkImageMapper3D::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkImageMapper3D::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 vtkAbstractMapper3D.

Reimplemented in vtkOpenGLImageSliceMapper, vtkImageResliceMapper, and vtkImageSliceMapper.

## ◆ Render()

virtual void vtkImageMapper3D::Render | ( | vtkRenderer * | renderer,
|  | vtkImageSlice * | prop
| ) |  |
| pure virtual

This should only be called by the renderer.

Implemented in vtkImageResliceMapper, vtkImageSliceMapper, and vtkOpenGLImageSliceMapper.

## ◆ ReleaseGraphicsResources()

void vtkImageMapper3D::ReleaseGraphicsResources | ( | vtkWindow * |  | ) |
| overridepure virtual

Release any graphics resources that are being consumed by this mapper.

The parameter window is used to determine which graphic resources to release.

Reimplemented from vtkAbstractMapper.

Implemented in vtkOpenGLImageSliceMapper, vtkImageResliceMapper, and vtkImageSliceMapper.

## ◆ SetInputData()

void vtkImageMapper3D::SetInputData | ( | vtkImageData * | input | ) |

The input data for this mapper.

## ◆ GetInput()

vtkImageData* vtkImageMapper3D::GetInput | ( |  | ) |

The input data for this mapper.

## ◆ GetDataSetInput()

vtkDataSet* vtkImageMapper3D::GetDataSetInput | ( |  | ) |

The input data for this mapper.

## ◆ GetDataObjectInput()

vtkDataObject* vtkImageMapper3D::GetDataObjectInput | ( |  | ) |

The input data for this mapper.

## ◆ SetBorder()

virtual void vtkImageMapper3D::SetBorder | ( | vtkTypeBool |  | ) |
| virtual

Instead of displaying the image only out to the image bounds, include a half-voxel border around the image.

Within this border, the image values will be extrapolated rather than interpolated.

## ◆ BorderOn()

virtual void vtkImageMapper3D::BorderOn | ( |  | ) |
| virtual

Instead of displaying the image only out to the image bounds, include a half-voxel border around the image.

Within this border, the image values will be extrapolated rather than interpolated.

## ◆ BorderOff()

virtual void vtkImageMapper3D::BorderOff | ( |  | ) |
| virtual

Instead of displaying the image only out to the image bounds, include a half-voxel border around the image.

Within this border, the image values will be extrapolated rather than interpolated.

## ◆ GetBorder()

virtual vtkTypeBool vtkImageMapper3D::GetBorder | ( |  | ) |
| virtual

Instead of displaying the image only out to the image bounds, include a half-voxel border around the image.

Within this border, the image values will be extrapolated rather than interpolated.

## ◆ SetBackground()

virtual void vtkImageMapper3D::SetBackground | ( | vtkTypeBool |  | ) |
| virtual

Instead of rendering only to the image border, render out to the viewport boundary with the background color.

The background color will be the lowest color on the lookup table that is being used for the image.

## ◆ BackgroundOn()

virtual void vtkImageMapper3D::BackgroundOn | ( |  | ) |
| virtual

Instead of rendering only to the image border, render out to the viewport boundary with the background color.

The background color will be the lowest color on the lookup table that is being used for the image.

## ◆ BackgroundOff()

virtual void vtkImageMapper3D::BackgroundOff | ( |  | ) |
| virtual

Instead of rendering only to the image border, render out to the viewport boundary with the background color.

The background color will be the lowest color on the lookup table that is being used for the image.

## ◆ GetBackground()

virtual vtkTypeBool vtkImageMapper3D::GetBackground | ( |  | ) |
| virtual

Instead of rendering only to the image border, render out to the viewport boundary with the background color.

The background color will be the lowest color on the lookup table that is being used for the image.

## ◆ SetSliceAtFocalPoint()

virtual void vtkImageMapper3D::SetSliceAtFocalPoint | ( | vtkTypeBool |  | ) |
| virtual

Automatically set the slice position to the camera focal point.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ SliceAtFocalPointOn()

virtual void vtkImageMapper3D::SliceAtFocalPointOn | ( |  | ) |
| virtual

Automatically set the slice position to the camera focal point.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ SliceAtFocalPointOff()

virtual void vtkImageMapper3D::SliceAtFocalPointOff | ( |  | ) |
| virtual

Automatically set the slice position to the camera focal point.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ GetSliceAtFocalPoint()

virtual vtkTypeBool vtkImageMapper3D::GetSliceAtFocalPoint | ( |  | ) |
| virtual

Automatically set the slice position to the camera focal point.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ SetSliceFacesCamera()

virtual void vtkImageMapper3D::SetSliceFacesCamera | ( | vtkTypeBool |  | ) |
| virtual

Automatically set the slice orientation so that it faces the camera.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ SliceFacesCameraOn()

virtual void vtkImageMapper3D::SliceFacesCameraOn | ( |  | ) |
| virtual

Automatically set the slice orientation so that it faces the camera.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ SliceFacesCameraOff()

virtual void vtkImageMapper3D::SliceFacesCameraOff | ( |  | ) |
| virtual

Automatically set the slice orientation so that it faces the camera.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ GetSliceFacesCamera()

virtual vtkTypeBool vtkImageMapper3D::GetSliceFacesCamera | ( |  | ) |
| virtual

Automatically set the slice orientation so that it faces the camera.

This provides a convenient way to interact with the image, since most Interactors directly control the camera.

## ◆ GetSlicePlane()

virtual vtkPlane* vtkImageMapper3D::GetSlicePlane | ( |  | ) |
| virtual

A plane that describes what slice of the input is being rendered by the mapper.

This plane is in world coordinates, not data coordinates. Before using this plane, call Update or UpdateInformation to make sure the plane is up-to-date. These methods are automatically called by Render.

## ◆ GetSlicePlaneInDataCoords()

virtual void vtkImageMapper3D::GetSlicePlaneInDataCoords | ( | vtkMatrix4x4 * | propMatrix,
|  | double | plane[4]
| ) |  |
| virtual

Get the plane as a homogeneous 4-vector that gives the plane equation coefficients.

The prop3D matrix must be provided so that the plane can be converted to data coords.

Reimplemented in vtkImageSliceMapper.

## ◆ SetNumberOfThreads()

virtual void vtkImageMapper3D::SetNumberOfThreads | ( | int |  | ) |
| virtual

The number of threads to create when rendering.

## ◆ GetNumberOfThreads()

virtual int vtkImageMapper3D::GetNumberOfThreads | ( |  | ) |
| virtual

The number of threads to create when rendering.

## ◆ SetStreaming()

virtual void vtkImageMapper3D::SetStreaming | ( | vtkTypeBool |  | ) |
| virtual

Turn on streaming, to pull the minimum amount of data from the input.

Streaming decreases the memory required to display large images, since only one slice will be pulled through the input pipeline if only one slice is mapped to the screen. The default behavior is to pull the full 3D input extent through the input pipeline, but to do this only when the input data changes. The default behavior results in much faster follow-up renders when the input data is static.

## ◆ GetStreaming()

virtual vtkTypeBool vtkImageMapper3D::GetStreaming | ( |  | ) |
| virtual

Turn on streaming, to pull the minimum amount of data from the input.

Streaming decreases the memory required to display large images, since only one slice will be pulled through the input pipeline if only one slice is mapped to the screen. The default behavior is to pull the full 3D input extent through the input pipeline, but to do this only when the input data changes. The default behavior results in much faster follow-up renders when the input data is static.

## ◆ StreamingOn()

virtual void vtkImageMapper3D::StreamingOn | ( |  | ) |
| virtual

Turn on streaming, to pull the minimum amount of data from the input.

Streaming decreases the memory required to display large images, since only one slice will be pulled through the input pipeline if only one slice is mapped to the screen. The default behavior is to pull the full 3D input extent through the input pipeline, but to do this only when the input data changes. The default behavior results in much faster follow-up renders when the input data is static.

## ◆ StreamingOff()

virtual void vtkImageMapper3D::StreamingOff | ( |  | ) |
| virtual

Turn on streaming, to pull the minimum amount of data from the input.

Streaming decreases the memory required to display large images, since only one slice will be pulled through the input pipeline if only one slice is mapped to the screen. The default behavior is to pull the full 3D input extent through the input pipeline, but to do this only when the input data changes. The default behavior results in much faster follow-up renders when the input data is static.

## ◆ GetIndexBounds()

virtual void vtkImageMapper3D::GetIndexBounds | ( | double | extent[6] | ) |
| pure virtual

Implemented in vtkImageResliceMapper, and vtkImageSliceMapper.

## ◆ FillInputPortInformation()

int vtkImageMapper3D::FillInputPortInformation | ( | int | port,
|  | vtkInformation * | info
| ) |  |
| overrideprotectedvirtual

See algorithm for more info.

Reimplemented from vtkAlgorithm.

## ◆ FillOutputPortInformation()

int vtkImageMapper3D::FillOutputPortInformation | ( | int | port,
|  | vtkInformation * | info
| ) |  |
| overrideprotectedvirtual

See algorithm for more info.

Reimplemented from vtkAlgorithm.

## ◆ ProcessRequest()

vtkTypeBool vtkImageMapper3D::ProcessRequest | ( | vtkInformation * | request,
|  | vtkInformationVector ** | inInfo,
|  | vtkInformationVector * | outInfo
| ) |  |
| overrideprotectedvirtual

Handle requests from the pipeline executive.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkImageResliceMapper, and vtkImageSliceMapper.

## ◆ CheckerboardRGBA()

static void vtkImageMapper3D::CheckerboardRGBA | ( | unsigned char * | data,
|  | int | xsize,
|  | int | ysize,
|  | double | originx,
|  | double | originy,
|  | double | spacingx,
|  | double | spacingy
| ) |  |
| staticprotected

Checkerboard the alpha component of an RGBA image.

The origin and spacing are in pixel units.

## ◆ MakeTextureData()

unsigned char* vtkImageMapper3D::MakeTextureData | ( | vtkImageProperty * | property,
|  | vtkImageData * | input,
|  | int | extent[6],
|  | int & | xsize,
|  | int & | ysize,
|  | int & | bytesPerPixel,
|  | bool & | reuseTexture,
|  | bool & | reuseData
| ) |  |
| protected

Perform window/level and color mapping operations to produce unsigned char data that can be used as a texture.

Given an image and an extent that describes a single slice, this method will return a contiguous block of unsigned char data that can be loaded into a texture. The values of xsize, ysize, bytesPerPixel, must be pre-loaded with the current texture size and depth. When the method returns, these values will be set to the dimensions of the data that was produced. The values of reuseData and reuseTexture are typically pre-loaded with true. If reuseTexture is false upon return, then texture size or format has changed If reuseData is false upon return, then the returned array must be freed after use with delete [].

## ◆ MakeTextureGeometry()

void vtkImageMapper3D::MakeTextureGeometry | ( | const int | extent[6],
|  | double | coords[12],
|  | double | tcoords[8]
| ) |  |
| protected

Compute the coordinates and texture coordinates for the image, given an extent that describes a single slice.

## ◆ ComputeTextureSize()

virtual void vtkImageMapper3D::ComputeTextureSize | ( | const int | extent[6],
|  | int & | xdim,
|  | int & | ydim,
|  | int | imageSize[2],
|  | int | textureSize[2]
| ) |  |
| protectedvirtual

Given an extent that describes a slice (it must have unit thickness in one of the three directions), return the dimension indices that correspond to the texture "x" and "y", provide the x, y image size, and provide the texture size (padded to a power of two if the hardware requires).

Reimplemented in vtkOpenGLImageSliceMapper.

## ◆ GetCurrentRenderer()

vtkRenderer* vtkImageMapper3D::GetCurrentRenderer | ( |  | ) |
| protected

Get the renderer associated with this mapper, or zero if none.

This will raise an error if multiple renderers are found.

## ◆ GetCurrentProp()

vtkImageSlice* vtkImageMapper3D::GetCurrentProp | ( |  | ) |
| inlineprotected

Get the vtkImage prop associated with this mapper, or zero if none.

Definition at line 236 of file vtkImageMapper3D.h.

## ◆ GetDataToWorldMatrix()

vtkMatrix4x4* vtkImageMapper3D::GetDataToWorldMatrix | ( |  | ) |
| protected

Get the data-to-world matrix for this mapper, according to the assembly path for its prop.

## ◆ GetBackgroundColor()

void vtkImageMapper3D::GetBackgroundColor | ( | vtkImageProperty * | property,
|  | double | color[4]
| ) |  |
| protected

Get the background color, by using the first color in the supplied lookup table, or black if there is no lookup table.

## Friends And Related Function Documentation

## ◆ vtkImageToImageMapper3DFriendship

friend class vtkImageToImageMapper3DFriendship
| friend

Definition at line 284 of file vtkImageMapper3D.h.

## Member Data Documentation

## ◆ Border

vtkTypeBool vtkImageMapper3D::Border
| protected

Definition at line 250 of file vtkImageMapper3D.h.

## ◆ Background

vtkTypeBool vtkImageMapper3D::Background
| protected

Definition at line 251 of file vtkImageMapper3D.h.

## ◆ DefaultLookupTable

vtkScalarsToColors* vtkImageMapper3D::DefaultLookupTable
| protected

Definition at line 252 of file vtkImageMapper3D.h.

## ◆ Threader

vtkMultiThreader* vtkImageMapper3D::Threader
| protected

Definition at line 253 of file vtkImageMapper3D.h.

## ◆ NumberOfThreads

int vtkImageMapper3D::NumberOfThreads
| protected

Definition at line 254 of file vtkImageMapper3D.h.

## ◆ Streaming

vtkTypeBool vtkImageMapper3D::Streaming
| protected

Definition at line 255 of file vtkImageMapper3D.h.

## ◆ SlicePlane

vtkPlane* vtkImageMapper3D::SlicePlane
| protected

Definition at line 258 of file vtkImageMapper3D.h.

## ◆ SliceAtFocalPoint

vtkTypeBool vtkImageMapper3D::SliceAtFocalPoint
| protected

Definition at line 259 of file vtkImageMapper3D.h.

## ◆ SliceFacesCamera

vtkTypeBool vtkImageMapper3D::SliceFacesCamera
| protected

Definition at line 260 of file vtkImageMapper3D.h.

## ◆ DataSpacing

double vtkImageMapper3D::DataSpacing[3]
| protected

Definition at line 263 of file vtkImageMapper3D.h.

## ◆ DataOrigin

double vtkImageMapper3D::DataOrigin[3]
| protected

Definition at line 264 of file vtkImageMapper3D.h.

## ◆ DataDirection

double vtkImageMapper3D::DataDirection[9]
| protected

Definition at line 265 of file vtkImageMapper3D.h.

## ◆ DataWholeExtent

int vtkImageMapper3D::DataWholeExtent[6]
| protected

Definition at line 266 of file vtkImageMapper3D.h.

## ◆ MatteEnable

bool vtkImageMapper3D::MatteEnable
| protected

Definition at line 269 of file vtkImageMapper3D.h.

## ◆ ColorEnable

bool vtkImageMapper3D::ColorEnable
| protected

Definition at line 270 of file vtkImageMapper3D.h.

## ◆ DepthEnable

bool vtkImageMapper3D::DepthEnable
| protected

Definition at line 271 of file vtkImageMapper3D.h.

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

- Rendering/Core/vtkImageMapper3D.h