VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkPlanesIntersection Class Reference

A vtkPlanesIntersection object is a vtkPlanes object that can compute whether the arbitrary convex region bounded by it's planes intersects an axis-aligned box. More...

#include <vtkPlanesIntersection.h>

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

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...
 
vtkPlanesIntersectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetRegionVertices (vtkPoints *pts)
 It helps if you know the vertices of the convex region. More...
 
void SetRegionVertices (double *v, int nvertices)
 
int GetNumberOfRegionVertices ()
 
int GetNumRegionVertices ()
 
int GetRegionVertices (double *v, int nvertices)
 
int IntersectsRegion (vtkPoints *R)
 Return 1 if the axis aligned box defined by R intersects the region defined by the planes, or 0 otherwise. More...
 
- Public Member Functions inherited from vtkPlanes
vtkPlanesNewInstance () const
 
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 planes gradient. More...
 
virtual void SetPoints (vtkPoints *)
 Specify a list of points defining points through which the planes pass. More...
 
virtual vtkPointsGetPoints ()
 
void SetNormals (vtkDataArray *normals)
 Specify a list of normal vectors for the planes. More...
 
virtual vtkDataArrayGetNormals ()
 
void SetFrustumPlanes (double planes[24])
 An alternative method to specify six planes defined by the camera view frustrum. More...
 
void SetBounds (const double bounds[6])
 An alternative method to specify six planes defined by a bounding box. More...
 
void SetBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 
int GetNumberOfPlanes ()
 Return the number of planes in the set of planes. More...
 
vtkPlaneGetPlane (int i)
 Create and return a pointer to a vtkPlane object at the ith position. More...
 
void GetPlane (int i, vtkPlane *plane)
 If i is within the allowable range, mutates the given plane's Normal and Origin to match the vtkPlane object at the ith position. More...
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate plane equations. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate plane equations. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate plane equations. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
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])
 
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 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)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlanesIntersectionSafeDownCast (vtkObjectBase *o)
 
static vtkPlanesIntersectionNew ()
 
static int PolygonIntersectsBBox (double bounds[6], vtkPoints *pts)
 A convenience function provided by this class, returns 1 if the polygon defined in pts intersects the bounding box defined in bounds, 0 otherwise. More...
 
static vtkPlanesIntersectionConvert3DCell (vtkCell *cell)
 Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell. More...
 
- Static Public Member Functions inherited from vtkPlanes
static vtkPlanesNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlanesSafeDownCast (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. 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlanesIntersection ()
 
 ~vtkPlanesIntersection () override
 
- Protected Member Functions inherited from vtkPlanes
 vtkPlanes ()
 
 ~vtkPlanes () 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 ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void ComputeNormal (double *p1, double *p2, double *p3, double normal[3])
 
static double EvaluatePlaneEquation (double *x, double *p)
 
static void PlaneEquation (double *n, double *x, double *p)
 
static int GoodNormal (double *n)
 
static int Invert3x3 (double M[3][3])
 

Additional Inherited Members

- Public Types inherited from vtkPlanes
typedef vtkImplicitFunction Superclass
 
- Public Types inherited from vtkImplicitFunction
typedef vtkObject Superclass
 
- Protected Attributes inherited from vtkPlanes
vtkPointsPoints
 
vtkDataArrayNormals
 
vtkPlanePlane
 
- 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
 

Detailed Description

A vtkPlanesIntersection object is a vtkPlanes object that can compute whether the arbitrary convex region bounded by it's planes intersects an axis-aligned box.

A subclass of vtkPlanes, this class determines whether it intersects an axis aligned box. This is motivated by the need to intersect the axis aligned region of a spacial decomposition of volume data with various other regions. It uses the algorithm from Graphics Gems IV, page 81.

Caveat:
An instance of vtkPlanes can be redefined by changing the planes, but this subclass then will not know if the region vertices are up to date. (Region vertices can be specified in SetRegionVertices or computed by the subclass.) So Delete and recreate if you want to change the set of planes.

Definition at line 52 of file vtkPlanesIntersection.h.

Constructor & Destructor Documentation

◆ vtkPlanesIntersection()

vtkPlanesIntersection::vtkPlanesIntersection ( )
protected

◆ ~vtkPlanesIntersection()

vtkPlanesIntersection::~vtkPlanesIntersection ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPlanesIntersection::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 vtkPlanes.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPlanesIntersection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlanes.

◆ NewInstance()

vtkPlanesIntersection* vtkPlanesIntersection::NewInstance ( ) const

◆ PrintSelf()

void vtkPlanesIntersection::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 vtkPlanes.

◆ New()

static vtkPlanesIntersection* vtkPlanesIntersection::New ( )
static

◆ SetRegionVertices() [1/2]

void vtkPlanesIntersection::SetRegionVertices ( vtkPoints pts)

It helps if you know the vertices of the convex region.

If you don't, we will calculate them. Region vertices are 3-tuples.

◆ SetRegionVertices() [2/2]

void vtkPlanesIntersection::SetRegionVertices ( double *  v,
int  nvertices 
)

◆ GetNumberOfRegionVertices()

int vtkPlanesIntersection::GetNumberOfRegionVertices ( )

◆ GetNumRegionVertices()

int vtkPlanesIntersection::GetNumRegionVertices ( )
inline

Definition at line 71 of file vtkPlanesIntersection.h.

◆ GetRegionVertices()

int vtkPlanesIntersection::GetRegionVertices ( double *  v,
int  nvertices 
)

◆ IntersectsRegion()

int vtkPlanesIntersection::IntersectsRegion ( vtkPoints R)

Return 1 if the axis aligned box defined by R intersects the region defined by the planes, or 0 otherwise.

◆ PolygonIntersectsBBox()

static int vtkPlanesIntersection::PolygonIntersectsBBox ( double  bounds[6],
vtkPoints pts 
)
static

A convenience function provided by this class, returns 1 if the polygon defined in pts intersects the bounding box defined in bounds, 0 otherwise.

The points must define a planar polygon.

◆ Convert3DCell()

static vtkPlanesIntersection* vtkPlanesIntersection::Convert3DCell ( vtkCell cell)
static

Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell.

The point IDs for each face must be given in counter-clockwise order from the outside of the cell.

◆ ComputeNormal()

static void vtkPlanesIntersection::ComputeNormal ( double *  p1,
double *  p2,
double *  p3,
double  normal[3] 
)
staticprotected

◆ EvaluatePlaneEquation()

static double vtkPlanesIntersection::EvaluatePlaneEquation ( double *  x,
double *  p 
)
staticprotected

◆ PlaneEquation()

static void vtkPlanesIntersection::PlaneEquation ( double *  n,
double *  x,
double *  p 
)
staticprotected

◆ GoodNormal()

static int vtkPlanesIntersection::GoodNormal ( double *  n)
staticprotected

◆ Invert3x3()

static int vtkPlanesIntersection::Invert3x3 ( double  M[3][3])
staticprotected

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