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

Implicit function that is generated by extrusion of a polyline along the Z axis. More...

#include <vtkPolyPlane.h>

Inheritance diagram for vtkPolyPlane:
[legend]
Collaboration diagram for vtkPolyPlane:
[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.
 
vtkPolyPlaneNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void EvaluateGradient (double x[3], double g[3]) override
 Evaluate function gradient at point x[3].
 
vtkMTimeType GetMTime () override
 Override GetMTime to include the polyline.
 
double EvaluateFunction (double x[3]) override
 Evaluate plane equation for point x[3].
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate plane equation for point x[3].
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate plane equation for point x[3].
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate plane equation for point x[3].
 
virtual void SetPolyLine (vtkPolyLine *)
 Set/get point through which plane passes.
 
virtual vtkPolyLineGetPolyLine ()
 Set/get point through which plane passes.
 
- Public Member Functions inherited from vtkImplicitFunction
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkImplicitFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Overload standard modified time function.
 
virtual void EvaluateGradient (double x[3], double g[3])=0
 Evaluate function gradient at position x-y-z and pass back vector.
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value.
 
double FunctionValue (const double x[3])
 Evaluate function at position x-y-z and return value.
 
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value.
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector.
 
double * FunctionGradient (const double x[3])
 Evaluate function gradient at position x-y-z and pass back vector.
 
double * FunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector.
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function.
 
virtual void SetTransform (const double elements[16])
 Set/Get a transformation to apply to input points before executing the implicit function.
 
virtual vtkAbstractTransformGetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkPolyPlaneNew ()
 Construct plane passing through origin and normal to z-axis.
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyPlaneSafeDownCast (vtkObjectBase *o)
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPolyPlane ()
 
 ~vtkPolyPlane () override
 
void ComputeNormals ()
 
- Protected Member Functions inherited from vtkImplicitFunction
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double ExtrusionDirection [3]
 
vtkPolyLinePolyLine
 
vtkTimeStamp NormalComputeTime
 
vtkDoubleArrayNormals
 
vtkIdType ClosestPlaneIdx
 
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
 
double ReturnValue [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- 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 that is generated by extrusion of a polyline along the Z axis.

vtkPolyPlane is, as the name suggests, an extrusion of a vtkPolyLine. The extrusion direction is assumed to be the Z vector. It can be used in combination with a vtkCutter to cut a dataset with a polyplane. vtkPolyPlane is a concrete implementation of the abstract class vtkImplicitFunction.

Todo:
Generalize to extrusions along arbitrary directions.
Tests:
vtkPolyPlane (Tests)

Definition at line 30 of file vtkPolyPlane.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkPolyPlane.h.

Constructor & Destructor Documentation

◆ vtkPolyPlane()

vtkPolyPlane::vtkPolyPlane ( )
protected

◆ ~vtkPolyPlane()

vtkPolyPlane::~vtkPolyPlane ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPolyPlane * vtkPolyPlane::New ( )
static

Construct plane passing through origin and normal to z-axis.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPolyPlane::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 vtkPolyPlane * vtkPolyPlane::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPolyPlane::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkPolyPlane * vtkPolyPlane::NewInstance ( ) const

◆ PrintSelf()

void vtkPolyPlane::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.

◆ EvaluateFunction() [1/4]

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

Evaluate plane equation for point x[3].

Implements vtkImplicitFunction.

◆ EvaluateGradient()

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

Evaluate function gradient at point x[3].

Implements vtkImplicitFunction.

◆ SetPolyLine()

virtual void vtkPolyPlane::SetPolyLine ( vtkPolyLine )
virtual

Set/get point through which plane passes.

Plane is defined by point and normal.

◆ GetPolyLine()

virtual vtkPolyLine * vtkPolyPlane::GetPolyLine ( )
virtual

Set/get point through which plane passes.

Plane is defined by point and normal.

◆ GetMTime()

vtkMTimeType vtkPolyPlane::GetMTime ( )
overridevirtual

Override GetMTime to include the polyline.

Reimplemented from vtkImplicitFunction.

◆ ComputeNormals()

void vtkPolyPlane::ComputeNormals ( )
protected

◆ EvaluateFunction() [2/4]

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

Evaluate plane equation for point x[3].

Implements vtkImplicitFunction.

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction ( vtkDataArray input,
vtkDataArray output 
)
virtual

Evaluate plane equation for point x[3].

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x,
double  y,
double  z 
)
inlinevirtual

Evaluate plane equation for point x[3].

Reimplemented from vtkImplicitFunction.

Definition at line 131 of file vtkImplicitFunction.h.

Member Data Documentation

◆ ExtrusionDirection

double vtkPolyPlane::ExtrusionDirection[3]
protected

Definition at line 74 of file vtkPolyPlane.h.

◆ PolyLine

vtkPolyLine* vtkPolyPlane::PolyLine
protected

Definition at line 75 of file vtkPolyPlane.h.

◆ NormalComputeTime

vtkTimeStamp vtkPolyPlane::NormalComputeTime
protected

Definition at line 76 of file vtkPolyPlane.h.

◆ Normals

vtkDoubleArray* vtkPolyPlane::Normals
protected

Definition at line 77 of file vtkPolyPlane.h.

◆ ClosestPlaneIdx

vtkIdType vtkPolyPlane::ClosestPlaneIdx
protected

Definition at line 78 of file vtkPolyPlane.h.


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