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

implicit function for a bounding box More...

#include <vtkBox.h>

Inheritance diagram for vtkBox:
[legend]
Collaboration diagram for vtkBox:
[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...
 
vtkBoxNewInstance () 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 the gradient of the box. More...
 
void SetXMin (double p[3])
 Set / get the bounding box using various methods. More...
 
void SetXMin (double x, double y, double z)
 
void GetXMin (double p[3])
 
void GetXMin (double &x, double &y, double &z)
 
void SetXMax (double p[3])
 
void SetXMax (double x, double y, double z)
 
void GetXMax (double p[3])
 
void GetXMax (double &x, double &y, double &z)
 
void SetBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
 
void SetBounds (const double bounds[6])
 
void GetBounds (double &xMin, double &xMax, double &yMin, double &yMax, double &zMin, double &zMax)
 
void GetBounds (double bounds[6])
 
double * GetBounds ()
 
void AddBounds (const double bounds[6])
 A special method that allows union set operation on bounding boxes. More...
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate box defined by the two points (pMin,pMax). More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate box defined by the two points (pMin,pMax). More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate box defined by the two points (pMin,pMax). 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])
 
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)
 
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...
 
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 vtkBoxSafeDownCast (vtkObjectBase *o)
 
static vtkBoxNew ()
 Construct box with center at (0,0,0) and each side of length 1.0. More...
 
static char IntersectBox (const double bounds[6], const double origin[3], const double dir[3], double coord[3], double &t)
 Bounding box intersection with line modified from Graphics Gems Vol I. More...
 
static int IntersectWithLine (const double bounds[6], const double p1[3], const double p2[3], double &t1, double &t2, double x1[3], double x2[3], int &plane1, int &plane2)
 Intersect a line with the box. More...
 
static bool IntersectWithInfiniteLine (const double bounds[6], const double p1[3], const double p2[3], double &t1, double &t2, double x1[3], double x2[3], int &plane1, int &plane2)
 Same method as vtkBox::IntersectWithLine, except that t1 and t2 can be outside of [0,1]. More...
 
static vtkTypeBool IntersectWithPlane (double bounds[6], double origin[3], double normal[3])
 Plane intersection with the box. More...
 
static vtkTypeBool IntersectWithPlane (double bounds[6], double origin[3], double normal[3], double xout[18])
 Plane intersection with the box. More...
 
static vtkTypeBool IsBoxInFrustum (double planes[24], double bounds[6])
 Is a box in a frustum. 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
 
 vtkBox ()
 
 ~vtkBox () 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkBoundingBoxBBox
 
double Bounds [6]
 
- 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 for a bounding box

vtkBox computes the implicit function and/or gradient for a axis-aligned bounding box. (The superclasses transform can be used to modify this orientation.) Each side of the box is orthogonal to all other sides meeting along shared edges and all faces are orthogonal to the x-y-z coordinate axes. (If you wish to orient this box differently, recall that the superclass vtkImplicitFunction supports a transformation matrix.) vtkBox is a concrete implementation of vtkImplicitFunction.

See also
vtkCubeSource vtkImplicitFunction

Definition at line 38 of file vtkBox.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkBox.h.

Constructor & Destructor Documentation

◆ vtkBox()

vtkBox::vtkBox ( )
protected

◆ ~vtkBox()

vtkBox::~vtkBox ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBox::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkBox* vtkBox::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkBox* vtkBox::New ( )
static

Construct box with center at (0,0,0) and each side of length 1.0.

◆ EvaluateFunction() [1/4]

double vtkBox::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 vtkBox::EvaluateGradient ( double  x[3],
double  n[3] 
)
overridevirtual

Evaluate the gradient of the box.

Implements vtkImplicitFunction.

◆ SetXMin() [1/2]

void vtkBox::SetXMin ( double  p[3])
inline

Set / get the bounding box using various methods.

Definition at line 174 of file vtkBox.h.

◆ SetXMin() [2/2]

void vtkBox::SetXMin ( double  x,
double  y,
double  z 
)

◆ GetXMin() [1/2]

void vtkBox::GetXMin ( double  p[3])

◆ GetXMin() [2/2]

void vtkBox::GetXMin ( double &  x,
double &  y,
double &  z 
)

◆ SetXMax() [1/2]

void vtkBox::SetXMax ( double  p[3])
inline

Definition at line 179 of file vtkBox.h.

◆ SetXMax() [2/2]

void vtkBox::SetXMax ( double  x,
double  y,
double  z 
)

◆ GetXMax() [1/2]

void vtkBox::GetXMax ( double  p[3])

◆ GetXMax() [2/2]

void vtkBox::GetXMax ( double &  x,
double &  y,
double &  z 
)

◆ SetBounds() [1/2]

void vtkBox::SetBounds ( double  xMin,
double  xMax,
double  yMin,
double  yMax,
double  zMin,
double  zMax 
)

◆ SetBounds() [2/2]

void vtkBox::SetBounds ( const double  bounds[6])

◆ GetBounds() [1/3]

void vtkBox::GetBounds ( double &  xMin,
double &  xMax,
double &  yMin,
double &  yMax,
double &  zMin,
double &  zMax 
)

◆ GetBounds() [2/3]

void vtkBox::GetBounds ( double  bounds[6])

◆ GetBounds() [3/3]

double* vtkBox::GetBounds ( )

◆ AddBounds()

void vtkBox::AddBounds ( const double  bounds[6])

A special method that allows union set operation on bounding boxes.

Start with a SetBounds(). Subsequent AddBounds() methods are union set operations on the original bounds. Retrieve the final bounds with a GetBounds() method.

◆ IntersectBox()

static char vtkBox::IntersectBox ( const double  bounds[6],
const double  origin[3],
const double  dir[3],
double  coord[3],
double &  t 
)
static

Bounding box intersection with line modified from Graphics Gems Vol I.

The method returns a non-zero value if the bounding box is hit. Origin[3] starts the ray, dir[3] is the vector components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line. (Notes: the intersection ray dir[3] is NOT normalized. Valid intersections will only occur between 0<=t<=1.)

◆ IntersectWithLine()

static int vtkBox::IntersectWithLine ( const double  bounds[6],
const double  p1[3],
const double  p2[3],
double &  t1,
double &  t2,
double  x1[3],
double  x2[3],
int &  plane1,
int &  plane2 
)
static

Intersect a line with the box.

Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to nullptr of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

◆ IntersectWithInfiniteLine()

static bool vtkBox::IntersectWithInfiniteLine ( const double  bounds[6],
const double  p1[3],
const double  p2[3],
double &  t1,
double &  t2,
double  x1[3],
double  x2[3],
int &  plane1,
int &  plane2 
)
static

Same method as vtkBox::IntersectWithLine, except that t1 and t2 can be outside of [0,1].

t1 is the distance of x1 to p1 in parametric coordinates, and t2 is the distance of x2 to p1 in parametric coordinates as well. In vtkBox::IntersectWithInLine, it is assumed that [p1,p2] is a segment, here, it is assumed that it is a line with no ends. t1 <= t2, which means that x1 is always "before" x2 on the line parameterized by [p1,p2]. x1 and x2 can be set to nullptr without crash.

◆ IntersectWithPlane() [1/2]

static vtkTypeBool vtkBox::IntersectWithPlane ( double  bounds[6],
double  origin[3],
double  normal[3] 
)
static

Plane intersection with the box.

The plane is infinite in extent and defined by an origin and normal. The function indicates whether the plane intersects, not the particulars of intersection points and such. The function returns non-zero if the plane and box intersect; zero otherwise.

◆ IntersectWithPlane() [2/2]

static vtkTypeBool vtkBox::IntersectWithPlane ( double  bounds[6],
double  origin[3],
double  normal[3],
double  xout[18] 
)
static

Plane intersection with the box.

The plane is infinite in extent and defined by an origin and normal. The function returns the number of intersection points, and if does, up to six ordered intersection points are provided (i.e., the points are ordered and form a valid polygon). Thus the function returns non-zero if the plane and box intersect; zero otherwise. Note that if there is an intersection, the number of intersections ranges from [3,6]. xout memory layout is consistent with vtkPoints array layout and is organized as (xyz, xyz, xyz, xyz, xyz, xyz).

◆ IsBoxInFrustum()

static vtkTypeBool vtkBox::IsBoxInFrustum ( double  planes[24],
double  bounds[6] 
)
static

Is a box in a frustum.

Returns true if the box is in the frustum even partially. The frustum is defined as 6 planes. This method is not exact may and return true for cases where there is no intersection. It should never return false when there is an intersection though.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate box defined by the two points (pMin,pMax).

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate box defined by the two points (pMin,pMax).

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

Evaluate box defined by the two points (pMin,pMax).

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ BBox

vtkBoundingBox* vtkBox::BBox
protected

Definition at line 166 of file vtkBox.h.

◆ Bounds

double vtkBox::Bounds[6]
protected

Definition at line 167 of file vtkBox.h.


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