VTK  9.0.20200806
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>

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

Public Types

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

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImplicitWindowFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate function at position x-y-z and return value. More...
 
void EvaluateGradient (double x[3], double n[3]) override
 Evaluate window function gradient. More...
 
virtual void SetImplicitFunction (vtkImplicitFunction *)
 Specify an implicit function to operate on. More...
 
virtual vtkImplicitFunctionGetImplicitFunction ()
 
virtual void SetWindowRange (double, double)
 Specify the range of function values which are considered to lie within the window. More...
 
void SetWindowRange (double[2])
 
virtual double * GetWindowRange ()
 
virtual void GetWindowRange (double data[2])
 
virtual void SetWindowValues (double, double)
 Specify the range of output values that the window range is mapped into. More...
 
void SetWindowValues (double[2])
 
virtual double * GetWindowValues ()
 
virtual void GetWindowValues (double data[2])
 
vtkMTimeType GetMTime () override
 Override modified time retrieval because of object dependencies. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate window function. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate window function. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate window function. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (const double x[3])
 
double FunctionValue (double x, double y, double z)
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
double * FunctionGradient (const double x[3])
 
double * FunctionGradient (double x, double y, double z)
 
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])
 
virtual vtkAbstractTransformGetTransform ()
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 
virtual double EvaluateFunction (double x, double y, double z)
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitWindowFunctionSafeDownCast (vtkObjectBase *o)
 
static vtkImplicitWindowFunctionNew ()
 Construct object with window range (0,1) and window values (0,1). More...
 
- Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitWindowFunction ()
 
 ~vtkImplicitWindowFunction () override
 
void ReportReferences (vtkGarbageCollector *) 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 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
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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

Definition at line 39 of file vtkImplicitWindowFunction.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkImplicitWindowFunction.h.

Constructor & Destructor Documentation

◆ vtkImplicitWindowFunction()

vtkImplicitWindowFunction::vtkImplicitWindowFunction ( )
protected

◆ ~vtkImplicitWindowFunction()

vtkImplicitWindowFunction::~vtkImplicitWindowFunction ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkImplicitWindowFunction::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitWindowFunction::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkImplicitWindowFunction* vtkImplicitWindowFunction::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkImplicitWindowFunction* vtkImplicitWindowFunction::New ( )
static

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

◆ EvaluateFunction() [1/4]

double vtkImplicitWindowFunction::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.

◆ EvaluateGradient()

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

Evaluate window function gradient.

Just return implicit function gradient.

Implements vtkImplicitFunction.

◆ SetImplicitFunction()

virtual void vtkImplicitWindowFunction::SetImplicitFunction ( vtkImplicitFunction )
virtual

Specify an implicit function to operate on.

◆ GetImplicitFunction()

virtual vtkImplicitFunction* vtkImplicitWindowFunction::GetImplicitFunction ( )
virtual

◆ SetWindowRange() [1/2]

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

◆ SetWindowRange() [2/2]

void vtkImplicitWindowFunction::SetWindowRange ( double  [2])

◆ GetWindowRange() [1/2]

virtual double* vtkImplicitWindowFunction::GetWindowRange ( )
virtual

◆ GetWindowRange() [2/2]

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

◆ SetWindowValues() [1/2]

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.

◆ SetWindowValues() [2/2]

void vtkImplicitWindowFunction::SetWindowValues ( double  [2])

◆ GetWindowValues() [1/2]

virtual double* vtkImplicitWindowFunction::GetWindowValues ( )
virtual

◆ GetWindowValues() [2/2]

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

◆ GetMTime()

vtkMTimeType vtkImplicitWindowFunction::GetMTime ( )
overridevirtual

Override modified time retrieval because of object dependencies.

Reimplemented from vtkImplicitFunction.

◆ Register()

void vtkImplicitWindowFunction::Register ( vtkObjectBase o)
overridevirtual

Participate in garbage collection.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkImplicitWindowFunction::UnRegister ( vtkObjectBase o)
overridevirtual

Decrease the reference count (release by another object).

This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented from vtkObjectBase.

◆ ReportReferences()

void vtkImplicitWindowFunction::ReportReferences ( vtkGarbageCollector )
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate window function.

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate window function.

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

Evaluate window function.

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ ImplicitFunction

vtkImplicitFunction* vtkImplicitWindowFunction::ImplicitFunction
protected

Definition at line 109 of file vtkImplicitWindowFunction.h.

◆ WindowRange

double vtkImplicitWindowFunction::WindowRange[2]
protected

Definition at line 110 of file vtkImplicitWindowFunction.h.

◆ WindowValues

double vtkImplicitWindowFunction::WindowValues[2]
protected

Definition at line 111 of file vtkImplicitWindowFunction.h.


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