vtkImplicitBoolean Class Reference

#include <vtkImplicitBoolean.h>

Inheritance diagram for vtkImplicitBoolean:

Inheritance graph
[legend]
Collaboration diagram for vtkImplicitBoolean:

Collaboration graph
[legend]

List of all members.


Detailed Description

implicit function consisting of boolean combinations of implicit functions

vtkImplicitBoolean is an implicit function consisting of boolean combinations of implicit functions. The class has a list of functions (FunctionList) that are combined according to a specified operator (VTK_UNION or VTK_INTERSECTION or VTK_DIFFERENCE). You can use nested combinations of vtkImplicitFunction's (and/or vtkImplicitBoolean) to create elaborate implicit functions. vtkImplicitBoolean is a concrete implementation of vtkImplicitFunction.

The operators work as follows. The VTK_UNION operator takes the minimum value of all implicit functions. The VTK_INTERSECTION operator takes the maximum value of all implicit functions. The VTK_DIFFERENCE operator subtracts the 2nd through last implicit functions from the first. The VTK_UNION_OF_MAGNITUDES takes the minimum absolute value of the implicit functions.

Examples:
vtkImplicitBoolean (Examples)
Tests:
vtkImplicitBoolean (Tests)

Definition at line 52 of file vtkImplicitBoolean.h.


Public Types

typedef vtkImplicitFunction Superclass

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 g[3])
unsigned long GetMTime ()
void AddFunction (vtkImplicitFunction *in)
void RemoveFunction (vtkImplicitFunction *in)
vtkImplicitFunctionCollectionGetFunction ()
double EvaluateFunction (double x[3])
double EvaluateFunction (double x, double y, double z)
virtual void SetOperationType (int)
virtual int GetOperationType ()
void SetOperationTypeToUnion ()
void SetOperationTypeToIntersection ()
void SetOperationTypeToDifference ()
void SetOperationTypeToUnionOfMagnitudes ()
const char * GetOperationTypeAsString ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImplicitBooleanSafeDownCast (vtkObject *o)
static vtkImplicitBooleanNew ()

Protected Member Functions

 vtkImplicitBoolean ()
 ~vtkImplicitBoolean ()

Protected Attributes

vtkImplicitFunctionCollectionFunctionList
int OperationType

Member Typedef Documentation

Reimplemented from vtkImplicitFunction.

Definition at line 55 of file vtkImplicitBoolean.h.


Constructor & Destructor Documentation

vtkImplicitBoolean::vtkImplicitBoolean (  )  [protected]

vtkImplicitBoolean::~vtkImplicitBoolean (  )  [protected]


Member Function Documentation

virtual const char* vtkImplicitBoolean::GetClassName (  )  [virtual]

Reimplemented from vtkImplicitFunction.

static int vtkImplicitBoolean::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 vtkImplicitBoolean::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 vtkImplicitBoolean* vtkImplicitBoolean::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImplicitFunction.

void vtkImplicitBoolean::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 vtkImplicitBoolean* vtkImplicitBoolean::New (  )  [static]

Default boolean method is union.

Reimplemented from vtkObject.

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

Evaluate boolean combinations of implicit function using current operator.

Implements vtkImplicitFunction.

double vtkImplicitBoolean::EvaluateFunction ( double  x,
double  y,
double  z 
) [inline]

Evaluate boolean combinations of implicit function using current operator.

Reimplemented from vtkImplicitFunction.

Definition at line 65 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::EvaluateGradient ( double  x[3],
double  g[3] 
) [virtual]

Evaluate gradient of boolean combination.

Implements vtkImplicitFunction.

unsigned long vtkImplicitBoolean::GetMTime (  )  [virtual]

Override modified time retrieval because of object dependencies.

Reimplemented from vtkImplicitFunction.

void vtkImplicitBoolean::AddFunction ( vtkImplicitFunction in  ) 

Add another implicit function to the list of functions.

void vtkImplicitBoolean::RemoveFunction ( vtkImplicitFunction in  ) 

Remove a function from the list of implicit functions to boolean.

vtkImplicitFunctionCollection* vtkImplicitBoolean::GetFunction (  )  [inline]

Return the collection of implicit functions.

Definition at line 82 of file vtkImplicitBoolean.h.

virtual void vtkImplicitBoolean::SetOperationType ( int   )  [virtual]

Specify the type of boolean operation.

virtual int vtkImplicitBoolean::GetOperationType (  )  [virtual]

Specify the type of boolean operation.

void vtkImplicitBoolean::SetOperationTypeToUnion (  )  [inline]

Specify the type of boolean operation.

Definition at line 88 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::SetOperationTypeToIntersection (  )  [inline]

Specify the type of boolean operation.

Definition at line 90 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::SetOperationTypeToDifference (  )  [inline]

Specify the type of boolean operation.

Definition at line 92 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::SetOperationTypeToUnionOfMagnitudes (  )  [inline]

Specify the type of boolean operation.

Definition at line 94 of file vtkImplicitBoolean.h.

const char * vtkImplicitBoolean::GetOperationTypeAsString ( void   )  [inline]

Return the boolean operation type as a descriptive character string.

Definition at line 114 of file vtkImplicitBoolean.h.


Member Data Documentation

Definition at line 103 of file vtkImplicitBoolean.h.

Definition at line 105 of file vtkImplicitBoolean.h.


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

Generated on Wed Aug 24 11:42:55 2011 for VTK by  doxygen 1.5.6