helper class for a ray cast image More...

#include <vtkFixedPointRayCastImage.h>

Inheritance diagram for vtkFixedPointRayCastImage:

Collaboration diagram for vtkFixedPointRayCastImage:

Public Types
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...

vtkFixedPointRayCastImage *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

unsigned short *	GetImage ()
	Get the internal storage for the image. More...

void	AllocateImage ()
	Call this method once the ImageMemorySize has been set the allocate the image. More...

void	ClearImage ()
	Clear the image to (0,0,0,0) for each pixel. More...

float	GetZBufferValue (int x, int y)
	Get the ZBuffer value corresponding to location (x,y) where (x,y) are indexing into the ImageInUse image. More...

float *	GetZBuffer ()
	Get the ZBuffer. More...

void	AllocateZBuffer ()


virtual void	SetImageViewportSize (int, int)
	Set / Get the ImageViewportSize. More...

void	SetImageViewportSize (int[2])
	Set / Get the ImageViewportSize. More...

virtual int *	GetImageViewportSize ()
	Set / Get the ImageViewportSize. More...

virtual void	GetImageViewportSize (int data[2])
	Set / Get the ImageViewportSize. More...


virtual void	SetImageMemorySize (int, int)
	Set / Get the ImageMemorySize. More...

void	SetImageMemorySize (int[2])
	Set / Get the ImageMemorySize. More...

virtual int *	GetImageMemorySize ()
	Set / Get the ImageMemorySize. More...

virtual void	GetImageMemorySize (int data[2])
	Set / Get the ImageMemorySize. More...


virtual void	SetImageInUseSize (int, int)
	Set / Get the size of the image we are actually using. More...

void	SetImageInUseSize (int[2])
	Set / Get the size of the image we are actually using. More...

virtual int *	GetImageInUseSize ()
	Set / Get the size of the image we are actually using. More...

virtual void	GetImageInUseSize (int data[2])
	Set / Get the size of the image we are actually using. More...


virtual void	SetImageOrigin (int, int)
	Set / Get the origin of the image. More...

void	SetImageOrigin (int[2])
	Set / Get the origin of the image. More...

virtual int *	GetImageOrigin ()
	Set / Get the origin of the image. More...

virtual void	GetImageOrigin (int data[2])
	Set / Get the origin of the image. More...


virtual void	SetImageSampleDistance (float)
	Set / Get the ImageSampleDistance that will be used for rendering. More...

virtual float	GetImageSampleDistance ()
	Set / Get the ImageSampleDistance that will be used for rendering. More...


virtual void	SetZBufferSize (int, int)
	Set / Get the size of the ZBuffer in pixels. More...

void	SetZBufferSize (int[2])
	Set / Get the size of the ZBuffer in pixels. More...

virtual int *	GetZBufferSize ()
	Set / Get the size of the ZBuffer in pixels. More...

virtual void	GetZBufferSize (int data[2])
	Set / Get the size of the ZBuffer in pixels. More...


virtual void	SetZBufferOrigin (int, int)
	Set / Get the origin of the ZBuffer. More...

void	SetZBufferOrigin (int[2])
	Set / Get the origin of the ZBuffer. More...

virtual int *	GetZBufferOrigin ()
	Set / Get the origin of the ZBuffer. More...

virtual void	GetZBufferOrigin (int data[2])
	Set / Get the origin of the ZBuffer. More...


virtual void	SetUseZBuffer (vtkTypeBool)
	The UseZBuffer flag indicates whether the ZBuffer is in use. More...

virtual vtkTypeBool	GetUseZBuffer ()
	The UseZBuffer flag indicates whether the ZBuffer is in use. More...

virtual void	UseZBufferOn ()
	The UseZBuffer flag indicates whether the ZBuffer is in use. More...

virtual void	UseZBufferOff ()
	The UseZBuffer flag indicates whether the ZBuffer is in use. 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...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. 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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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)
	This method invokes an event and return whether the event was aborted or not. More...

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

void	PrintRevisions (ostream &)
	Legacy. 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 vtkFixedPointRayCastImage *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkFixedPointRayCastImage *	SafeDownCast (vtkObjectBase *o)

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 (int 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 int	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkFixedPointRayCastImage ()

	~vtkFixedPointRayCastImage () override

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 ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	ImageViewportSize [2]

int	ImageMemorySize [2]

int	ImageInUseSize [2]

int	ImageOrigin [2]

float	ImageSampleDistance

unsigned short *	Image

int	ZBufferSize [2]

int	ZBufferMemorySize

int	ZBufferOrigin [2]

vtkTypeBool	UseZBuffer

float *	ZBuffer

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

helper class for a ray cast image

This is a helper class for storing the ray cast image including the underlying data and the size of the image. This class is not intended to be used directly - just as an internal class in the vtkFixedPointVolumeRayCastMapper so that multiple mappers can share the same image. This class also stored the ZBuffer (if necessary due to intermixed geometry). Perhaps this class could be generalized in the future to be used for other ray cast methods other than the fixed point method.

See also: vtkFixedPointVolumeRayCastMapper

Definition at line 39 of file vtkFixedPointRayCastImage.h.

Member Typedef Documentation

typedef vtkObject vtkFixedPointRayCastImage::Superclass

Definition at line 43 of file vtkFixedPointRayCastImage.h.

Constructor & Destructor Documentation

vtkFixedPointRayCastImage::vtkFixedPointRayCastImage ( )

protected

vtkFixedPointRayCastImage::~vtkFixedPointRayCastImage ( )

overrideprotected

Member Function Documentation

static vtkFixedPointRayCastImage* vtkFixedPointRayCastImage::New ( )

static

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

static

virtual vtkTypeBool vtkFixedPointRayCastImage::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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkFixedPointRayCastImage::NewInstanceInternal ( ) const

protectedvirtual

vtkFixedPointRayCastImage* vtkFixedPointRayCastImage::NewInstance ( ) const

void vtkFixedPointRayCastImage::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 vtkObject.

unsigned short* vtkFixedPointRayCastImage::GetImage ( )

inline

Get the internal storage for the image.

It is a pointer to unsigned short with four components (RGBA) per pixel. This memory is allocated when the AllocateImage method is called.

Definition at line 51 of file vtkFixedPointRayCastImage.h.

virtual void vtkFixedPointRayCastImage::SetImageViewportSize	(	int	,
		int
	)

virtual

Set / Get the ImageViewportSize.

This is the size of the whole viewport in pixels.

void vtkFixedPointRayCastImage::SetImageViewportSize ( int [2] )

Set / Get the ImageViewportSize.

This is the size of the whole viewport in pixels.

virtual int* vtkFixedPointRayCastImage::GetImageViewportSize ( )

virtual

Set / Get the ImageViewportSize.

This is the size of the whole viewport in pixels.

virtual void vtkFixedPointRayCastImage::GetImageViewportSize ( int data[2] )

virtual

Set / Get the ImageViewportSize.

This is the size of the whole viewport in pixels.

virtual void vtkFixedPointRayCastImage::SetImageMemorySize	(	int	,
		int
	)

virtual

Set / Get the ImageMemorySize.

This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.

void vtkFixedPointRayCastImage::SetImageMemorySize ( int [2] )

Set / Get the ImageMemorySize.

This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.

virtual int* vtkFixedPointRayCastImage::GetImageMemorySize ( )

virtual

Set / Get the ImageMemorySize.

This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.

virtual void vtkFixedPointRayCastImage::GetImageMemorySize ( int data[2] )

virtual

Set / Get the ImageMemorySize.

This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.

virtual void vtkFixedPointRayCastImage::SetImageInUseSize	(	int	,
		int
	)

virtual

Set / Get the size of the image we are actually using.

As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.

void vtkFixedPointRayCastImage::SetImageInUseSize ( int [2] )

Set / Get the size of the image we are actually using.

As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.

virtual int* vtkFixedPointRayCastImage::GetImageInUseSize ( )

virtual

Set / Get the size of the image we are actually using.

As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.

virtual void vtkFixedPointRayCastImage::GetImageInUseSize ( int data[2] )

virtual

Set / Get the size of the image we are actually using.

As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.

virtual void vtkFixedPointRayCastImage::SetImageOrigin	(	int	,
		int
	)

virtual

Set / Get the origin of the image.

This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.

void vtkFixedPointRayCastImage::SetImageOrigin ( int [2] )

Set / Get the origin of the image.

This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.

virtual int* vtkFixedPointRayCastImage::GetImageOrigin ( )

virtual

Set / Get the origin of the image.

This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.

virtual void vtkFixedPointRayCastImage::GetImageOrigin ( int data[2] )

virtual

Set / Get the origin of the image.

This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.

virtual void vtkFixedPointRayCastImage::SetImageSampleDistance ( float )

virtual

Set / Get the ImageSampleDistance that will be used for rendering.

This is a copy of the value stored in the mapper. It is stored here for sharing between all mappers that are participating in the creation of this image.

virtual float vtkFixedPointRayCastImage::GetImageSampleDistance ( )

virtual

Set / Get the ImageSampleDistance that will be used for rendering.

This is a copy of the value stored in the mapper. It is stored here for sharing between all mappers that are participating in the creation of this image.

void vtkFixedPointRayCastImage::AllocateImage ( )

Call this method once the ImageMemorySize has been set the allocate the image.

If an image already exists, it will be deleted first.

void vtkFixedPointRayCastImage::ClearImage ( )

Clear the image to (0,0,0,0) for each pixel.

virtual void vtkFixedPointRayCastImage::SetZBufferSize	(	int	,
		int
	)

virtual

Set / Get the size of the ZBuffer in pixels.

The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.

void vtkFixedPointRayCastImage::SetZBufferSize ( int [2] )

Set / Get the size of the ZBuffer in pixels.

The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.

virtual int* vtkFixedPointRayCastImage::GetZBufferSize ( )

virtual

Set / Get the size of the ZBuffer in pixels.

The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.

virtual void vtkFixedPointRayCastImage::GetZBufferSize ( int data[2] )

virtual

Set / Get the size of the ZBuffer in pixels.

The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.

virtual void vtkFixedPointRayCastImage::SetZBufferOrigin	(	int	,
		int
	)

virtual

Set / Get the origin of the ZBuffer.

This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.

void vtkFixedPointRayCastImage::SetZBufferOrigin ( int [2] )

Set / Get the origin of the ZBuffer.

This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.

virtual int* vtkFixedPointRayCastImage::GetZBufferOrigin ( )

virtual

Set / Get the origin of the ZBuffer.

This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.

virtual void vtkFixedPointRayCastImage::GetZBufferOrigin ( int data[2] )

virtual

Set / Get the origin of the ZBuffer.

This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.

virtual void vtkFixedPointRayCastImage::SetUseZBuffer ( vtkTypeBool )

virtual

The UseZBuffer flag indicates whether the ZBuffer is in use.

The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.

virtual vtkTypeBool vtkFixedPointRayCastImage::GetUseZBuffer ( )

virtual

The UseZBuffer flag indicates whether the ZBuffer is in use.

The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.

virtual void vtkFixedPointRayCastImage::UseZBufferOn ( )

virtual

The UseZBuffer flag indicates whether the ZBuffer is in use.

The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.

virtual void vtkFixedPointRayCastImage::UseZBufferOff ( )

virtual

The UseZBuffer flag indicates whether the ZBuffer is in use.

The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.