vtkOpenGLImageMapper Class Reference

2D image display support for OpenGL More...

#include <vtkOpenGLImageMapper.h>

Inheritance diagram for vtkOpenGLImageMapper:

Collaboration diagram for vtkOpenGLImageMapper:

Public Types
typedef vtkImageMapper	Superclass
typedef vtkImageMapper	Superclass
Public Types inherited from vtkImageMapper
typedef vtkMapper2D	Superclass
Public Types inherited from vtkMapper2D
typedef vtkAbstractMapper	Superclass
Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkOpenGLImageMapper *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsA (const char *type)
vtkOpenGLImageMapper *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
void	DrawPixels (vtkViewport *vp, int width, int height, int numComponents, void *data)
void	ReleaseGraphicsResources (vtkWindow *)
void	RenderOverlay (vtkViewport *viewport, vtkActor2D *actor)
void	RenderData (vtkViewport *viewport, vtkImageData *data, vtkActor2D *actor)
void	RenderOverlay (vtkViewport *viewport, vtkActor2D *actor)
void	RenderData (vtkViewport *viewport, vtkImageData *data, vtkActor2D *actor)
Public Member Functions inherited from vtkImageMapper
vtkImageMapper *	NewInstance () const
unsigned long int	GetMTime ()
void	RenderStart (vtkViewport *viewport, vtkActor2D *actor)
virtual void	SetColorWindow (double)
virtual double	GetColorWindow ()
virtual void	SetColorLevel (double)
virtual double	GetColorLevel ()
virtual void	SetZSlice (int)
virtual int	GetZSlice ()
int	GetWholeZMin ()
int	GetWholeZMax ()
double	GetColorShift ()
double	GetColorScale ()
virtual void	SetInputData (vtkImageData *input)
vtkImageData *	GetInput ()
virtual void	SetRenderToRectangle (int)
virtual int	GetRenderToRectangle ()
virtual void	RenderToRectangleOn ()
virtual void	RenderToRectangleOff ()
virtual void	SetUseCustomExtents (int)
virtual int	GetUseCustomExtents ()
virtual void	UseCustomExtentsOn ()
virtual void	UseCustomExtentsOff ()
virtual void	SetCustomDisplayExtents (int data[])
virtual int *	GetCustomDisplayExtents ()
virtual void	GetCustomDisplayExtents (int data[4])
Public Member Functions inherited from vtkMapper2D
vtkMapper2D *	NewInstance () const
virtual void	RenderOpaqueGeometry (vtkViewport *, vtkActor2D *)
virtual void	RenderTranslucentPolygonalGeometry (vtkViewport *, vtkActor2D *)
virtual int	HasTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper *	NewInstance () const
void	SetClippingPlanes (vtkPlanes *planes)
void	ShallowCopy (vtkAbstractMapper *m)
virtual double	GetTimeToDraw ()
void	AddClippingPlane (vtkPlane *plane)
void	RemoveClippingPlane (vtkPlane *plane)
void	RemoveAllClippingPlanes ()
virtual void	SetClippingPlanes (vtkPlaneCollection *)
virtual vtkPlaneCollection *	GetClippingPlanes ()
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkOpenGLImageMapper *	New ()
static int	IsTypeOf (const char *type)
static vtkOpenGLImageMapper *	SafeDownCast (vtkObjectBase *o)
static vtkOpenGLImageMapper *	New ()
static int	IsTypeOf (const char *type)
static vtkOpenGLImageMapper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageMapper
static int	IsTypeOf (const char *type)
static vtkImageMapper *	SafeDownCast (vtkObjectBase *o)
static vtkImageMapper *	New ()
Static Public Member Functions inherited from vtkMapper2D
static int	IsTypeOf (const char *type)
static vtkMapper2D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper
static int	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)
static vtkAbstractArray *	GetAbstractScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLImageMapper ()
	~vtkOpenGLImageMapper ()
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLImageMapper ()
	~vtkOpenGLImageMapper ()
Protected Member Functions inherited from vtkImageMapper
	vtkImageMapper ()
	~vtkImageMapper ()
virtual int	FillInputPortInformation (int, vtkInformation *)
Protected Member Functions inherited from vtkMapper2D
	vtkMapper2D ()
	~vtkMapper2D ()
Protected Member Functions inherited from vtkAbstractMapper
	vtkAbstractMapper ()
	~vtkAbstractMapper ()
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTexturedActor2D *	Actor
Protected Attributes inherited from vtkImageMapper
double	ColorWindow
double	ColorLevel
int	PositionAdjustment [2]
int	ZSlice
int	UseCustomExtents
int	CustomDisplayExtents [4]
int	RenderToRectangle
Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer
double	TimeToDraw
vtkWindow *	LastWindow
vtkPlaneCollection *	ClippingPlanes
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkImageMapper
int	DisplayExtent [6]
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

2D image display support for OpenGL

vtkOpenGLImageMapper is a concrete subclass of vtkImageMapper that renders images under OpenGL

Warning

vtkOpenGLImageMapper does not support vtkBitArray, you have to convert the array first to vtkUnsignedCharArray (for example)

See also

vtkImageMapper

Definition at line 37 of file vtkOpenGLImageMapper.h.

Member Typedef Documentation

typedef vtkImageMapper vtkOpenGLImageMapper::Superclass

Definition at line 41 of file vtkOpenGLImageMapper.h.

typedef vtkImageMapper vtkOpenGLImageMapper::Superclass

Definition at line 42 of file vtkOpenGLImageMapper.h.

Constructor & Destructor Documentation

vtkOpenGLImageMapper::vtkOpenGLImageMapper ( )

protected

vtkOpenGLImageMapper::~vtkOpenGLImageMapper ( )

protected

vtkOpenGLImageMapper::vtkOpenGLImageMapper ( )

protected

vtkOpenGLImageMapper::~vtkOpenGLImageMapper ( )

protected

Member Function Documentation

static vtkOpenGLImageMapper* vtkOpenGLImageMapper::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkOpenGLImageMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageMapper.

vtkOpenGLImageMapper* vtkOpenGLImageMapper::NewInstance

(

)

const

virtual void vtkOpenGLImageMapper::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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 vtkImageMapper.

void vtkOpenGLImageMapper::RenderOverlay ( vtkViewport *  viewport, vtkActor2D *  actor  )

inlinevirtual

Handle the render method.

Reimplemented from vtkMapper2D.

Definition at line 46 of file vtkOpenGLImageMapper.h.

void vtkOpenGLImageMapper::RenderData ( vtkViewport *  viewport, vtkImageData *  data, vtkActor2D *  actor  )

virtual

Called by the Render function in vtkImageMapper. Actually draws the image to the screen.

Implements vtkImageMapper.

static vtkOpenGLImageMapper* vtkOpenGLImageMapper::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkOpenGLImageMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageMapper.

vtkOpenGLImageMapper* vtkOpenGLImageMapper::NewInstance

(

)

const

virtual void vtkOpenGLImageMapper::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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 vtkImageMapper.

void vtkOpenGLImageMapper::RenderOverlay ( vtkViewport *  viewport, vtkActor2D *  actor  )

inlinevirtual

Handle the render method.

Reimplemented from vtkMapper2D.

Definition at line 47 of file vtkOpenGLImageMapper.h.

void vtkOpenGLImageMapper::RenderData ( vtkViewport *  viewport, vtkImageData *  data, vtkActor2D *  actor  )

virtual

Called by the Render function in vtkImageMapper. Actually draws the image to the screen.

Implements vtkImageMapper.

void vtkOpenGLImageMapper::DrawPixels	(	vtkViewport *	vp,
		int	width,
		int	height,
		int	numComponents,
		void *	data
	)

draw the data once it has been converted to uchar, windowed leveled used internally by the templated functions

void vtkOpenGLImageMapper::ReleaseGraphicsResources ( vtkWindow *  )

virtual

Release any graphics resources that are being consumed by this mapper, the image texture in particular.

Reimplemented from vtkAbstractMapper.

Member Data Documentation

vtkTexturedActor2D* vtkOpenGLImageMapper::Actor

protected

Definition at line 70 of file vtkOpenGLImageMapper.h.

---

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

• dox/Rendering/OpenGL/vtkOpenGLImageMapper.h