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:
Inheritance graph
[legend]
Collaboration diagram for vtkImplicitWindowFunction:
Collaboration graph
[legend]

List of all members.

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 vtkImplicitFunctionGetImplicitFunction ()
virtual void SetWindowRange (double, double)
void SetWindowRange (double[2])
virtual doubleGetWindowRange ()
virtual void GetWindowRange (double data[2])
virtual void SetWindowValues (double, double)
void SetWindowValues (double[2])
virtual doubleGetWindowValues ()
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

vtkImplicitFunctionImplicitFunction
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

Reimplemented from vtkImplicitFunction.

Definition at line 44 of file vtkImplicitWindowFunction.h.


Constructor & Destructor Documentation


Member Function Documentation

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.

Reimplemented from vtkImplicitFunction.

virtual vtkObjectBase* vtkImplicitWindowFunction::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImplicitFunction.

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.

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

Reimplemented from vtkObject.

Evaluate window function.

Implements vtkImplicitFunction.

Evaluate window function.

Reimplemented from vtkImplicitFunction.

Definition at line 53 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.

Specify an implicit function to operate on.

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].

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

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.

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.

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 ) [protected, virtual]

Reimplemented from vtkObjectBase.


Member Data Documentation

Definition at line 98 of file vtkImplicitWindowFunction.h.

Definition at line 99 of file vtkImplicitWindowFunction.h.

Definition at line 100 of file vtkImplicitWindowFunction.h.


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