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

implicit function consisting of boolean combinations of implicit functions More...

#include <vtkImplicitBoolean.h>

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

Public Types

enum  OperationType { VTK_UNION =0, VTK_INTERSECTION, VTK_DIFFERENCE, VTK_UNION_OF_MAGNITUDES }
 
typedef vtkImplicitFunction Superclass
 
- Public Types inherited from vtkImplicitFunction
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...
 
vtkImplicitBooleanNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void EvaluateGradient (double x[3], double g[3]) override
 Evaluate gradient of boolean combination. More...
 
vtkMTimeType GetMTime () override
 Override modified time retrieval because of object dependencies. More...
 
void AddFunction (vtkImplicitFunction *in)
 Add another implicit function to the list of functions. More...
 
void RemoveFunction (vtkImplicitFunction *in)
 Remove a function from the list of implicit functions to boolean. More...
 
vtkImplicitFunctionCollectionGetFunction ()
 Return the collection of implicit functions. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate function at position x-y-z and return value. More...
 
virtual void SetOperationType (int)
 Specify the type of boolean operation. More...
 
virtual int GetOperationType ()
 Specify the type of boolean operation. More...
 
void SetOperationTypeToUnion ()
 Specify the type of boolean operation. More...
 
void SetOperationTypeToIntersection ()
 Specify the type of boolean operation. More...
 
void SetOperationTypeToDifference ()
 Specify the type of boolean operation. More...
 
void SetOperationTypeToUnionOfMagnitudes ()
 Specify the type of boolean operation. More...
 
const char * GetOperationTypeAsString ()
 Return the boolean operation type as a descriptive character string. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Overload standard modified time function. More...
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (const double x[3])
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value. More...
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
doubleFunctionGradient (const double x[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
doubleFunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void SetTransform (const double elements[16])
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual vtkAbstractTransformGetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate function at position x-y-z and return value. 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...
 
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 int IsTypeOf (const char *type)
 
static vtkImplicitBooleanSafeDownCast (vtkObjectBase *o)
 
static vtkImplicitBooleanNew ()
 Default boolean method is union. More...
 
- Static Public Member Functions inherited from vtkImplicitFunction
static int IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (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
 
 vtkImplicitBoolean ()
 
 ~vtkImplicitBoolean () override
 
- Protected Member Functions inherited from vtkImplicitFunction
 vtkImplicitFunction ()
 
 ~vtkImplicitFunction () override
 
- 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=nullptr)
 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

vtkImplicitFunctionCollectionFunctionList
 
int OperationType
 
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
 
double ReturnValue [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 49 of file vtkImplicitBoolean.h.

Member Typedef Documentation

Definition at line 52 of file vtkImplicitBoolean.h.

Member Enumeration Documentation

Enumerator
VTK_UNION 
VTK_INTERSECTION 
VTK_DIFFERENCE 
VTK_UNION_OF_MAGNITUDES 

Definition at line 55 of file vtkImplicitBoolean.h.

Constructor & Destructor Documentation

vtkImplicitBoolean::vtkImplicitBoolean ( )
protected
vtkImplicitBoolean::~vtkImplicitBoolean ( )
overrideprotected

Member Function Documentation

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

Reimplemented from vtkImplicitFunction.

vtkImplicitBoolean* vtkImplicitBoolean::NewInstance ( ) const
void vtkImplicitBoolean::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

static vtkImplicitBoolean* vtkImplicitBoolean::New ( )
static

Default boolean method is union.

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

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Implements vtkImplicitFunction.

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

Evaluate gradient of boolean combination.

Implements vtkImplicitFunction.

vtkMTimeType vtkImplicitBoolean::GetMTime ( )
overridevirtual

Override modified time retrieval because of object dependencies.

Reimplemented from vtkObject.

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 99 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 107 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::SetOperationTypeToIntersection ( )
inline

Specify the type of boolean operation.

Definition at line 109 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::SetOperationTypeToDifference ( )
inline

Specify the type of boolean operation.

Definition at line 111 of file vtkImplicitBoolean.h.

void vtkImplicitBoolean::SetOperationTypeToUnionOfMagnitudes ( )
inline

Specify the type of boolean operation.

Definition at line 113 of file vtkImplicitBoolean.h.

const char * vtkImplicitBoolean::GetOperationTypeAsString ( void  )
inline

Return the boolean operation type as a descriptive character string.

Definition at line 135 of file vtkImplicitBoolean.h.

Member Data Documentation

vtkImplicitFunctionCollection* vtkImplicitBoolean::FunctionList
protected

Definition at line 122 of file vtkImplicitBoolean.h.

Definition at line 124 of file vtkImplicitBoolean.h.


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