VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRayCastImageDisplayHelper Class Referenceabstract

helper class that draws the image to the screen More...

#include <vtkRayCastImageDisplayHelper.h>

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

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...
 
vtkRayCastImageDisplayHelperNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void RenderTexture (vtkVolume *vol, vtkRenderer *ren, int imageMemorySize[2], int imageViewportSize[2], int imageInUseSize[2], int imageOrigin[2], float requestedDepth, unsigned char *image)=0
 
virtual void RenderTexture (vtkVolume *vol, vtkRenderer *ren, int imageMemorySize[2], int imageViewportSize[2], int imageInUseSize[2], int imageOrigin[2], float requestedDepth, unsigned short *image)=0
 
virtual void RenderTexture (vtkVolume *vol, vtkRenderer *ren, vtkFixedPointRayCastImage *image, float requestedDepth)=0
 
virtual void SetPreMultipliedColors (vtkTypeBool)
 
virtual vtkTypeBool GetPreMultipliedColors ()
 
virtual void PreMultipliedColorsOn ()
 
virtual void PreMultipliedColorsOff ()
 
virtual void SetPixelScale (float)
 Set / Get the pixel scale to be applied to the image before display. More...
 
virtual float GetPixelScale ()
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Derived class should implement this if needed. 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...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkRayCastImageDisplayHelperNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRayCastImageDisplayHelperSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRayCastImageDisplayHelper ()
 
 ~vtkRayCastImageDisplayHelper () 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 ()
 
- 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

vtkTypeBool PreMultipliedColors
 Have the colors already been multiplied by alpha? More...
 
float PixelScale
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper class that draws the image to the screen

This is a helper class for drawing images created from ray casting on the screen. This is the abstract device-independent superclass.

See also
vtkUnstructuredGridVolumeRayCastMapper vtkOpenGLRayCastImageDisplayHelper

Definition at line 39 of file vtkRayCastImageDisplayHelper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkRayCastImageDisplayHelper.h.

Constructor & Destructor Documentation

◆ vtkRayCastImageDisplayHelper()

vtkRayCastImageDisplayHelper::vtkRayCastImageDisplayHelper ( )
protected

◆ ~vtkRayCastImageDisplayHelper()

vtkRayCastImageDisplayHelper::~vtkRayCastImageDisplayHelper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRayCastImageDisplayHelper* vtkRayCastImageDisplayHelper::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkOpenGLRayCastImageDisplayHelper.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRayCastImageDisplayHelper::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRayCastImageDisplayHelper* vtkRayCastImageDisplayHelper::NewInstance ( ) const

◆ PrintSelf()

void vtkRayCastImageDisplayHelper::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.

Reimplemented in vtkOpenGLRayCastImageDisplayHelper.

◆ RenderTexture() [1/3]

virtual void vtkRayCastImageDisplayHelper::RenderTexture ( vtkVolume vol,
vtkRenderer ren,
int  imageMemorySize[2],
int  imageViewportSize[2],
int  imageInUseSize[2],
int  imageOrigin[2],
float  requestedDepth,
unsigned char *  image 
)
pure virtual

◆ RenderTexture() [2/3]

virtual void vtkRayCastImageDisplayHelper::RenderTexture ( vtkVolume vol,
vtkRenderer ren,
int  imageMemorySize[2],
int  imageViewportSize[2],
int  imageInUseSize[2],
int  imageOrigin[2],
float  requestedDepth,
unsigned short *  image 
)
pure virtual

◆ RenderTexture() [3/3]

virtual void vtkRayCastImageDisplayHelper::RenderTexture ( vtkVolume vol,
vtkRenderer ren,
vtkFixedPointRayCastImage image,
float  requestedDepth 
)
pure virtual

◆ SetPreMultipliedColors()

virtual void vtkRayCastImageDisplayHelper::SetPreMultipliedColors ( vtkTypeBool  )
virtual

◆ GetPreMultipliedColors()

virtual vtkTypeBool vtkRayCastImageDisplayHelper::GetPreMultipliedColors ( )
virtual

◆ PreMultipliedColorsOn()

virtual void vtkRayCastImageDisplayHelper::PreMultipliedColorsOn ( )
virtual

◆ PreMultipliedColorsOff()

virtual void vtkRayCastImageDisplayHelper::PreMultipliedColorsOff ( )
virtual

◆ SetPixelScale()

virtual void vtkRayCastImageDisplayHelper::SetPixelScale ( float  )
virtual

Set / Get the pixel scale to be applied to the image before display.

Can be set to scale the incoming pixel values - for example the fixed point mapper uses the unsigned short API but with 15 bit values so needs a scale of 2.0.

◆ GetPixelScale()

virtual float vtkRayCastImageDisplayHelper::GetPixelScale ( )
virtual

◆ ReleaseGraphicsResources()

virtual void vtkRayCastImageDisplayHelper::ReleaseGraphicsResources ( vtkWindow )
inlinevirtual

Derived class should implement this if needed.

Reimplemented in vtkOpenGLRayCastImageDisplayHelper.

Definition at line 75 of file vtkRayCastImageDisplayHelper.h.

Member Data Documentation

◆ PreMultipliedColors

vtkTypeBool vtkRayCastImageDisplayHelper::PreMultipliedColors
protected

Have the colors already been multiplied by alpha?

Definition at line 84 of file vtkRayCastImageDisplayHelper.h.

◆ PixelScale

float vtkRayCastImageDisplayHelper::PixelScale
protected

Definition at line 86 of file vtkRayCastImageDisplayHelper.h.


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