VTK
9.4.20241107
|
implicit function for convex set of planes More...
#include <vtkPlanes.h>
Public Member Functions | |
void | EvaluateGradient (double x[3], double n[3]) override |
Evaluate planes gradient. | |
void | SetFrustumPlanes (double planes[24]) |
An alternative method to specify six planes defined by the camera view frustrum. | |
int | GetNumberOfPlanes () |
Return the number of planes in the set of planes. | |
vtkPlane * | GetPlane (int i) |
Create and return a pointer to a vtkPlane object at the ith position. | |
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. | |
double | EvaluateFunction (double x[3]) override |
Evaluate plane equations. | |
virtual double | EvaluateFunction (double x[3])=0 |
Evaluate plane equations. | |
virtual void | EvaluateFunction (vtkDataArray *input, vtkDataArray *output) |
Evaluate plane equations. | |
virtual double | EvaluateFunction (double x, double y, double z) |
Evaluate plane equations. | |
virtual void | SetPoints (vtkPoints *) |
Specify a list of points defining points through which the planes pass. | |
virtual vtkPoints * | GetPoints () |
Specify a list of points defining points through which the planes pass. | |
void | SetNormals (vtkDataArray *normals) |
Specify a list of normal vectors for the planes. | |
virtual vtkDataArray * | GetNormals () |
Specify a list of normal vectors for the planes. | |
void | SetBounds (const double bounds[6]) |
An alternative method to specify six planes defined by a bounding box. | |
void | SetBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) |
An alternative method to specify six planes defined by a bounding box. | |
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. | |
vtkImplicitFunction * | NewInstance () 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 vtkAbstractTransform * | GetTransform () |
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. | |
vtkCommand * | GetCommand (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. | |
Protected Member Functions | |
vtkPlanes () | |
~vtkPlanes () override | |
Protected Member Functions inherited from vtkImplicitFunction | |
virtual vtkObjectBase * | NewInstanceInternal () 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 | |
vtkPoints * | Points |
vtkDataArray * | Normals |
vtkPlane * | Plane |
Protected Attributes inherited from vtkImplicitFunction | |
vtkAbstractTransform * | Transform |
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 |
typedef vtkImplicitFunction | Superclass |
Standard methods for instantiation, type information, and printing. | |
static vtkPlanes * | New () |
Standard methods for instantiation, type information, and printing. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for instantiation, type information, and printing. | |
static vtkPlanes * | SafeDownCast (vtkObjectBase *o) |
Standard methods for instantiation, type information, and printing. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for instantiation, type information, and printing. | |
vtkPlanes * | NewInstance () const |
Standard methods for instantiation, type information, and printing. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for instantiation, type information, and printing. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for instantiation, type information, and printing. | |
Additional Inherited Members | |
Public Types inherited from vtkImplicitFunction | |
typedef vtkObject | Superclass |
Static Public Member Functions inherited from vtkImplicitFunction | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImplicitFunction * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 vtkObjectBase * | New () |
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. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
implicit function for convex set of planes
vtkPlanes computes the implicit function and function gradient for a set of planes. The planes must define a convex space.
The function value is the intersection (i.e., maximum value) obtained by evaluating the each of the supplied planes. Hence the value is the maximum distance of a point to the convex region defined by the planes. The function gradient is the plane normal at the function value. Note that the normals must point outside of the convex region. Thus, a negative function value means that a point is inside the convex region.
There are several methods to define the set of planes. The most general is to supply an instance of vtkPoints and an instance of vtkDataArray. (The points define a point on the plane, and the normals corresponding plane normals.) Two other specialized ways are to 1) supply six planes defining the view frustrum of a camera, and 2) provide a bounding box.
Definition at line 150 of file vtkPlanes.h.
Standard methods for instantiation, type information, and printing.
Definition at line 158 of file vtkPlanes.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for instantiation, type information, and printing.
|
static |
Standard methods for instantiation, type information, and printing.
|
virtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkImplicitFunction.
Reimplemented in vtkPlanesIntersection.
|
static |
Standard methods for instantiation, type information, and printing.
|
protectedvirtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkImplicitFunction.
Reimplemented in vtkPlanesIntersection.
vtkPlanes * vtkPlanes::NewInstance | ( | ) | const |
Standard methods for instantiation, type information, and printing.
|
overridevirtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkImplicitFunction.
Reimplemented in vtkPlanesIntersection.
|
overridevirtual |
Evaluate plane equations.
Return largest value (i.e., an intersection operation between all planes).
Implements vtkImplicitFunction.
|
overridevirtual |
Evaluate planes gradient.
Implements vtkImplicitFunction.
|
virtual |
Specify a list of points defining points through which the planes pass.
|
virtual |
Specify a list of points defining points through which the planes pass.
void vtkPlanes::SetNormals | ( | vtkDataArray * | normals | ) |
Specify a list of normal vectors for the planes.
There is a one-to-one correspondence between plane points and plane normals.
|
virtual |
Specify a list of normal vectors for the planes.
There is a one-to-one correspondence between plane points and plane normals.
void vtkPlanes::SetFrustumPlanes | ( | double | planes[24] | ) |
An alternative method to specify six planes defined by the camera view frustrum.
See vtkCamera::GetFrustumPlanes() documentation.
void vtkPlanes::SetBounds | ( | const double | bounds[6] | ) |
An alternative method to specify six planes defined by a bounding box.
The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.
void vtkPlanes::SetBounds | ( | double | xmin, |
double | xmax, | ||
double | ymin, | ||
double | ymax, | ||
double | zmin, | ||
double | zmax | ||
) |
An alternative method to specify six planes defined by a bounding box.
The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.
int vtkPlanes::GetNumberOfPlanes | ( | ) |
Return the number of planes in the set of planes.
vtkPlane * vtkPlanes::GetPlane | ( | int | i | ) |
Create and return a pointer to a vtkPlane object at the ith position.
Asking for a plane outside the allowable range returns nullptr. This method always returns the same object. Use GetPlane(int i, vtkPlane *plane) instead.
void vtkPlanes::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.
Does nothing if i is outside the allowable range.
|
virtual |
Evaluate plane equations.
Return largest value (i.e., an intersection operation between all planes).
Implements vtkImplicitFunction.
|
virtual |
Evaluate plane equations.
Return largest value (i.e., an intersection operation between all planes).
Reimplemented from vtkImplicitFunction.
|
inlinevirtual |
Evaluate plane equations.
Return largest value (i.e., an intersection operation between all planes).
Reimplemented from vtkImplicitFunction.
Definition at line 131 of file vtkImplicitFunction.h.
|
protected |
Definition at line 233 of file vtkPlanes.h.
|
protected |
Definition at line 234 of file vtkPlanes.h.
|
protected |
Definition at line 235 of file vtkPlanes.h.