VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImplicitWindowFunction Class Reference

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

#include <vtkImplicitWindowFunction.h>

Inherits vtkImplicitFunction.

Public Types

typedef vtkImplicitFunction Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImplicitWindowFunctionNewInstance () const
 
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 vtkImplicitFunction * GetImplicitFunction ()
 
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)
 

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitWindowFunction ()
 
 ~vtkImplicitWindowFunction ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 

Protected Attributes

vtkImplicitFunction * ImplicitFunction
 
double WindowRange [2]
 
double WindowValues [2]
 

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 41 of file vtkImplicitWindowFunction.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkImplicitWindowFunction::Superclass

Definition at line 44 of file vtkImplicitWindowFunction.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static int vtkImplicitWindowFunction::IsTypeOf ( const char *  type)
static
virtual int vtkImplicitWindowFunction::IsA ( const char *  type)
virtual
static vtkImplicitWindowFunction* vtkImplicitWindowFunction::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkImplicitWindowFunction::NewInstanceInternal ( ) const
protectedvirtual
vtkImplicitWindowFunction* vtkImplicitWindowFunction::NewInstance ( ) const
void vtkImplicitWindowFunction::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkImplicitWindowFunction* vtkImplicitWindowFunction::New ( )
static

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

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

Evaluate window function.

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

Evaluate window function.

Definition at line 53 of file vtkImplicitWindowFunction.h.

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

Evaluate window function gradient. Just return implicit function gradient.

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

Override modified time retrieval because of object dependencies.

virtual void vtkImplicitWindowFunction::Register ( vtkObjectBase o)
virtual

Participate in garbage collection.

virtual void vtkImplicitWindowFunction::UnRegister ( vtkObjectBase o)
virtual

Participate in garbage collection.

virtual void vtkImplicitWindowFunction::ReportReferences ( vtkGarbageCollector )
protectedvirtual

Member Data Documentation

vtkImplicitFunction* vtkImplicitWindowFunction::ImplicitFunction
protected

Definition at line 98 of file vtkImplicitWindowFunction.h.

double vtkImplicitWindowFunction::WindowRange[2]
protected

Definition at line 99 of file vtkImplicitWindowFunction.h.

double vtkImplicitWindowFunction::WindowValues[2]
protected

Definition at line 100 of file vtkImplicitWindowFunction.h.


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