VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImplicitWindowFunction Class Reference

implicit function maps another implicit function to lie within a specified range More...

#include <vtkImplicitWindowFunction.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void EvaluateGradient (double x[3], double n[3])
unsigned long GetMTime ()
double EvaluateFunction (double x[3])
double EvaluateFunction (double x, double y, double z)
virtual void SetImplicitFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetImplicitFunction ()
virtual void SetWindowRange (double, double)
void SetWindowRange (double[2])
virtual double * GetWindowRange ()
virtual void GetWindowRange (double data[2])
virtual void SetWindowValues (double, double)
void SetWindowValues (double[2])
virtual double * GetWindowValues ()
virtual void GetWindowValues (double data[2])
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
- Public Member Functions inherited from vtkImplicitFunction
double FunctionValue (const double x[3])
double FunctionValue (double x, double y, double z)
void FunctionGradient (const double x[3], double g[3])
double * FunctionGradient (const double x[3])
double * FunctionGradient (double x, double y, double z)
virtual void SetTransform (vtkAbstractTransform *)
virtual void SetTransform (const double elements[16])
virtual vtkAbstractTransformGetTransform ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImplicitWindowFunctionSafeDownCast (vtkObject *o)
static vtkImplicitWindowFunctionNew ()

Protected Member Functions

 vtkImplicitWindowFunction ()
 ~vtkImplicitWindowFunction ()
virtual void ReportReferences (vtkGarbageCollector *)
- Protected Member Functions inherited from vtkImplicitFunction
 vtkImplicitFunction ()
 ~vtkImplicitFunction ()
- 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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkImplicitFunctionImplicitFunction
double WindowRange [2]
double WindowValues [2]
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
double ReturnValue [3]
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

implicit function maps another implicit function to lie within a specified range

vtkImplicitWindowFunction is used to modify the output of another implicit function to lie within a specified "window", or function range. This can be used to add "thickness" to cutting or clipping functions.

This class works as follows. First, it evaluates the function value of the user-specified implicit function. Then, based on the window range specified, it maps the function value into the window values specified.

See also:
vtkImplicitFunction
Tests:
vtkImplicitWindowFunction (Tests)

Definition at line 40 of file vtkImplicitWindowFunction.h.


Member Typedef Documentation

Reimplemented from vtkImplicitFunction.

Definition at line 43 of file vtkImplicitWindowFunction.h.


Constructor & Destructor Documentation

vtkImplicitWindowFunction::vtkImplicitWindowFunction ( )
protected
vtkImplicitWindowFunction::~vtkImplicitWindowFunction ( )
protected

Member Function Documentation

virtual const char* vtkImplicitWindowFunction::GetClassName ( )
virtual

Reimplemented from vtkImplicitFunction.

static int vtkImplicitWindowFunction::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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 vtkImplicitFunction.

virtual int vtkImplicitWindowFunction::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 vtkImplicitFunction.

static vtkImplicitWindowFunction* vtkImplicitWindowFunction::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkImplicitFunction.

void vtkImplicitWindowFunction::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 vtkImplicitFunction.

static vtkImplicitWindowFunction* vtkImplicitWindowFunction::New ( )
static

Construct object with window range (0,1) and window values (0,1).

Reimplemented from vtkObject.

double vtkImplicitWindowFunction::EvaluateFunction ( double  x[3])
virtual

Evaluate window function.

Implements vtkImplicitFunction.

double vtkImplicitWindowFunction::EvaluateFunction ( double  x,
double  y,
double  z 
)
inline

Evaluate window function.

Reimplemented from vtkImplicitFunction.

Definition at line 52 of file vtkImplicitWindowFunction.h.

void vtkImplicitWindowFunction::EvaluateGradient ( double  x[3],
double  n[3] 
)
virtual

Evaluate window function gradient. Just return implicit function gradient.

Implements vtkImplicitFunction.

virtual void vtkImplicitWindowFunction::SetImplicitFunction ( vtkImplicitFunction )
virtual

Specify an implicit function to operate on.

virtual vtkImplicitFunction* vtkImplicitWindowFunction::GetImplicitFunction ( )
virtual

Specify an implicit function to operate on.

virtual void vtkImplicitWindowFunction::SetWindowRange ( double  ,
double   
)
virtual

Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1].

void vtkImplicitWindowFunction::SetWindowRange ( double  [2])

Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1].

virtual double* vtkImplicitWindowFunction::GetWindowRange ( )
virtual

Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1].

virtual void vtkImplicitWindowFunction::GetWindowRange ( double  data[2])
virtual

Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1].

virtual void vtkImplicitWindowFunction::SetWindowValues ( double  ,
double   
)
virtual

Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values.

void vtkImplicitWindowFunction::SetWindowValues ( double  [2])

Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values.

virtual double* vtkImplicitWindowFunction::GetWindowValues ( )
virtual

Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values.

virtual void vtkImplicitWindowFunction::GetWindowValues ( double  data[2])
virtual

Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values.

unsigned long vtkImplicitWindowFunction::GetMTime ( )
virtual

Override modified time retrieval because of object dependencies.

Reimplemented from vtkImplicitFunction.

virtual void vtkImplicitWindowFunction::Register ( vtkObjectBase o)
virtual

Participate in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkImplicitWindowFunction::UnRegister ( vtkObjectBase o)
virtual

Participate in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkImplicitWindowFunction::ReportReferences ( vtkGarbageCollector )
protectedvirtual

Reimplemented from vtkObjectBase.


Member Data Documentation

vtkImplicitFunction* vtkImplicitWindowFunction::ImplicitFunction
protected

Definition at line 97 of file vtkImplicitWindowFunction.h.

double vtkImplicitWindowFunction::WindowRange[2]
protected

Definition at line 98 of file vtkImplicitWindowFunction.h.

double vtkImplicitWindowFunction::WindowValues[2]
protected

Definition at line 99 of file vtkImplicitWindowFunction.h.


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