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

a ray function for compositing More...

#include <vtkVolumeRayCastCompositeFunction.h>

Inheritance diagram for vtkVolumeRayCastCompositeFunction:
[legend]
Collaboration diagram for vtkVolumeRayCastCompositeFunction:
[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...
 
vtkVolumeRayCastCompositeFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void CastRay (vtkVolumeRayCastDynamicInfo *dynamicInfo, vtkVolumeRayCastStaticInfo *staticInfo)
 
float GetZeroOpacityThreshold (vtkVolume *vol)
 Get the value below which all scalar values are considered to have 0 opacity. More...
 
virtual void SetCompositeMethod (int)
 Set the CompositeMethod to either Classify First or Interpolate First. More...
 
virtual int GetCompositeMethod ()
 Set the CompositeMethod to either Classify First or Interpolate First. More...
 
void SetCompositeMethodToInterpolateFirst ()
 Set the CompositeMethod to either Classify First or Interpolate First. More...
 
void SetCompositeMethodToClassifyFirst ()
 Set the CompositeMethod to either Classify First or Interpolate First. More...
 
const char * GetCompositeMethodAsString (void)
 Set the CompositeMethod to either Classify First or Interpolate First. More...
 
- Public Member Functions inherited from vtkVolumeRayCastFunction
vtkVolumeRayCastFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 vtkVolumeRayCastCompositeFunctionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkVolumeRayCastCompositeFunctionSafeDownCast (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
 
 vtkVolumeRayCastCompositeFunction ()
 
 ~vtkVolumeRayCastCompositeFunction ()
 
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 CompositeMethod
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a ray function for compositing

vtkVolumeRayCastCompositeFunction is a ray function that can be used within a vtkVolumeRayCastMapper. This function performs compositing along the ray according to the properties stored in the vtkVolumeProperty for the volume.

See also
vtkVolumeRayCastMapper vtkVolumeProperty vtkVolume
Deprecated:
Examples:
vtkVolumeRayCastCompositeFunction (Examples)
Tests:
vtkVolumeRayCastCompositeFunction (Tests)

Definition at line 46 of file vtkVolumeRayCastCompositeFunction.h.

Member Typedef Documentation

Definition at line 50 of file vtkVolumeRayCastCompositeFunction.h.

Constructor & Destructor Documentation

vtkVolumeRayCastCompositeFunction::vtkVolumeRayCastCompositeFunction ( )
protected
vtkVolumeRayCastCompositeFunction::~vtkVolumeRayCastCompositeFunction ( )
protected

Member Function Documentation

static vtkVolumeRayCastCompositeFunction* vtkVolumeRayCastCompositeFunction::New ( )
static
static int vtkVolumeRayCastCompositeFunction::IsTypeOf ( const char *  type)
static
virtual int vtkVolumeRayCastCompositeFunction::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 vtkVolumeRayCastCompositeFunction* vtkVolumeRayCastCompositeFunction::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkVolumeRayCastCompositeFunction::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkVolumeRayCastFunction.

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

virtual void vtkVolumeRayCastCompositeFunction::SetCompositeMethod ( int  )
virtual

Set the CompositeMethod to either Classify First or Interpolate First.

virtual int vtkVolumeRayCastCompositeFunction::GetCompositeMethod ( )
virtual

Set the CompositeMethod to either Classify First or Interpolate First.

void vtkVolumeRayCastCompositeFunction::SetCompositeMethodToInterpolateFirst ( )
inline

Set the CompositeMethod to either Classify First or Interpolate First.

Definition at line 60 of file vtkVolumeRayCastCompositeFunction.h.

void vtkVolumeRayCastCompositeFunction::SetCompositeMethodToClassifyFirst ( )
inline

Set the CompositeMethod to either Classify First or Interpolate First.

Definition at line 62 of file vtkVolumeRayCastCompositeFunction.h.

const char* vtkVolumeRayCastCompositeFunction::GetCompositeMethodAsString ( void  )

Set the CompositeMethod to either Classify First or Interpolate First.

void vtkVolumeRayCastCompositeFunction::CastRay ( vtkVolumeRayCastDynamicInfo dynamicInfo,
vtkVolumeRayCastStaticInfo staticInfo 
)
virtual
float vtkVolumeRayCastCompositeFunction::GetZeroOpacityThreshold ( vtkVolume vol)
virtual

Get the value below which all scalar values are considered to have 0 opacity.

Implements vtkVolumeRayCastFunction.

void vtkVolumeRayCastCompositeFunction::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 vtkVolumeRayCastCompositeFunction::CompositeMethod
protected

Definition at line 81 of file vtkVolumeRayCastCompositeFunction.h.


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