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

A maximum intensity projection ray caster for volumes. More...

#include <vtkVolumeRayCastMIPFunction.h>

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

Public Types

typedef vtkVolumeRayCastFunction Superclass
 
- Public Types inherited from vtkVolumeRayCastFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkVolumeRayCastMIPFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
float GetZeroOpacityThreshold (vtkVolume *vol)
 Get the scalar value below which all scalar values have zero opacity. More...
 
void CastRay (vtkVolumeRayCastDynamicInfo *dynamicInfo, vtkVolumeRayCastStaticInfo *staticInfo)
 
virtual void SetMaximizeMethod (int)
 Set the MaximizeMethod to either ScalarValue or Opacity. More...
 
virtual int GetMaximizeMethod ()
 Set the MaximizeMethod to either ScalarValue or Opacity. More...
 
void SetMaximizeMethodToScalarValue ()
 Set the MaximizeMethod to either ScalarValue or Opacity. More...
 
void SetMaximizeMethodToOpacity ()
 Set the MaximizeMethod to either ScalarValue or Opacity. More...
 
const char * GetMaximizeMethodAsString (void)
 Set the MaximizeMethod to either ScalarValue or Opacity. More...
 
- Public Member Functions inherited from vtkVolumeRayCastFunction
vtkVolumeRayCastFunctionNewInstance () const
 
void FunctionInitialize (vtkRenderer *ren, vtkVolume *vol, vtkVolumeRayCastStaticInfo *staticInfo)
 Do the basic initialization. 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 vtkVolumeRayCastMIPFunctionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkVolumeRayCastMIPFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkVolumeRayCastFunction
static int IsTypeOf (const char *type)
 
static vtkVolumeRayCastFunctionSafeDownCast (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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVolumeRayCastMIPFunction ()
 
 ~vtkVolumeRayCastMIPFunction ()
 
void SpecificFunctionInitialize (vtkRenderer *ren, vtkVolume *vol, vtkVolumeRayCastStaticInfo *staticInfo, vtkVolumeRayCastMapper *mapper)
 This method gives the subclass a chance to do any special initialization that it may need to do. More...
 
- Protected Member Functions inherited from vtkVolumeRayCastFunction
 vtkVolumeRayCastFunction ()
 
 ~vtkVolumeRayCastFunction ()
 
- 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=NULL)
 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 MaximizeMethod
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A maximum intensity projection ray caster for volumes.

vtkVolumeRayCastMIPFunction is a volume ray cast function that computes the maximum value encountered along the ray. This is either the maximum scalar value, or the maximum opacity, as defined by the MaximizeMethod. The color and opacity returned by this function is based on the color, scalar opacity, and gradient opacity transfer functions defined in the vtkVolumeProperty of the vtkVolume.

See also
vtkVolumeRayCastFunction vtkVolumeRayCastMapper vtkVolumeProperty vtkVolumeRayCastCompositeFunction vtkVolumeRayCastIsosurfaceFunction vtkVolume vtkVolumeProperty
Deprecated:
Tests:
vtkVolumeRayCastMIPFunction (Tests)

Definition at line 49 of file vtkVolumeRayCastMIPFunction.h.

Member Typedef Documentation

Definition at line 53 of file vtkVolumeRayCastMIPFunction.h.

Constructor & Destructor Documentation

vtkVolumeRayCastMIPFunction::vtkVolumeRayCastMIPFunction ( )
protected
vtkVolumeRayCastMIPFunction::~vtkVolumeRayCastMIPFunction ( )
protected

Member Function Documentation

static vtkVolumeRayCastMIPFunction* vtkVolumeRayCastMIPFunction::New ( )
static
static int vtkVolumeRayCastMIPFunction::IsTypeOf ( const char *  type)
static
virtual int vtkVolumeRayCastMIPFunction::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 vtkVolumeRayCastFunction.

static vtkVolumeRayCastMIPFunction* vtkVolumeRayCastMIPFunction::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkVolumeRayCastMIPFunction::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkVolumeRayCastFunction.

vtkVolumeRayCastMIPFunction* vtkVolumeRayCastMIPFunction::NewInstance ( ) const
void vtkVolumeRayCastMIPFunction::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 vtkVolumeRayCastFunction.

float vtkVolumeRayCastMIPFunction::GetZeroOpacityThreshold ( vtkVolume vol)
virtual

Get the scalar value below which all scalar values have zero opacity.

Implements vtkVolumeRayCastFunction.

virtual void vtkVolumeRayCastMIPFunction::SetMaximizeMethod ( int  )
virtual

Set the MaximizeMethod to either ScalarValue or Opacity.

virtual int vtkVolumeRayCastMIPFunction::GetMaximizeMethod ( )
virtual

Set the MaximizeMethod to either ScalarValue or Opacity.

void vtkVolumeRayCastMIPFunction::SetMaximizeMethodToScalarValue ( )
inline

Set the MaximizeMethod to either ScalarValue or Opacity.

Definition at line 70 of file vtkVolumeRayCastMIPFunction.h.

void vtkVolumeRayCastMIPFunction::SetMaximizeMethodToOpacity ( )
inline

Set the MaximizeMethod to either ScalarValue or Opacity.

Definition at line 72 of file vtkVolumeRayCastMIPFunction.h.

const char* vtkVolumeRayCastMIPFunction::GetMaximizeMethodAsString ( void  )

Set the MaximizeMethod to either ScalarValue or Opacity.

void vtkVolumeRayCastMIPFunction::CastRay ( vtkVolumeRayCastDynamicInfo dynamicInfo,
vtkVolumeRayCastStaticInfo staticInfo 
)
virtual
void vtkVolumeRayCastMIPFunction::SpecificFunctionInitialize ( vtkRenderer ren,
vtkVolume vol,
vtkVolumeRayCastStaticInfo staticInfo,
vtkVolumeRayCastMapper mapper 
)
protectedvirtual

This method gives the subclass a chance to do any special initialization that it may need to do.

Implements vtkVolumeRayCastFunction.

Member Data Documentation

int vtkVolumeRayCastMIPFunction::MaximizeMethod
protected

Definition at line 84 of file vtkVolumeRayCastMIPFunction.h.


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