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:

Collaboration diagram for vtkPolyPlane:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkPolyPlane *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	EvaluateGradient (double x[3], double g[3])
virtual unsigned long	GetMTime ()
double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)
virtual void	SetPolyLine (vtkPolyLine *)
virtual vtkPolyLine *	GetPolyLine ()
Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const
double	FunctionValue (const double x[3])
double	FunctionValue (double x, double y, double z)
void	FunctionGradient (const double x[3], double g[3])
double *	FunctionGradient (const double x[3])
double *	FunctionGradient (double x, double y, double z)
virtual void	SetTransform (vtkAbstractTransform *)
virtual void	SetTransform (const double elements[16])
virtual vtkAbstractTransform *	GetTransform ()
double	EvaluateFunction (double x, double y, double z)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkPolyPlane *	New ()
static int	IsTypeOf (const char *type)
static vtkPolyPlane *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)
static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPolyPlane ()
	~vtkPolyPlane ()
void	ComputeNormals ()
Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()
	~vtkImplicitFunction ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
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 &)

Protected Attributes
double	ExtrusionDirection [3]
vtkPolyLine *	PolyLine
vtkTimeStamp	NormalComputeTime
vtkDoubleArray *	Normals
vtkIdType	ClosestPlaneIdx
Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform
double	ReturnValue [3]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 40 of file vtkPolyPlane.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkPolyPlane::Superclass

Definition at line 46 of file vtkPolyPlane.h.

Constructor & Destructor Documentation

vtkPolyPlane::vtkPolyPlane ( )

protected

vtkPolyPlane::~vtkPolyPlane ( )

protected

Member Function Documentation

static vtkPolyPlane* vtkPolyPlane::New ( )

static

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

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

static

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

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

static

virtual vtkObjectBase* vtkPolyPlane::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkPolyPlane* vtkPolyPlane::NewInstance

(

)

const

void vtkPolyPlane::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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.

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

virtual

Evaluate plane equation for point x[3].

Implements vtkImplicitFunction.

double vtkPolyPlane::EvaluateFunction ( double  x, double  y, double  z  )

inline

Evaluate plane equation for point x[3].

Definition at line 52 of file vtkPolyPlane.h.

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

virtual

Evaluate function gradient at point x[3].

Implements vtkImplicitFunction.

virtual void vtkPolyPlane::SetPolyLine ( vtkPolyLine *  )

virtual

Set/get point through which plane passes. Plane is defined by point and normal.

virtual vtkPolyLine* vtkPolyPlane::GetPolyLine ( )

virtual

Set/get point through which plane passes. Plane is defined by point and normal.

virtual unsigned long vtkPolyPlane::GetMTime ( )

virtual

Override GetMTime to include the polyline

Reimplemented from vtkImplicitFunction.

void vtkPolyPlane::ComputeNormals ( )

protected

Member Data Documentation

double vtkPolyPlane::ExtrusionDirection[3]

protected

Definition at line 75 of file vtkPolyPlane.h.

vtkPolyLine* vtkPolyPlane::PolyLine

protected

Definition at line 76 of file vtkPolyPlane.h.

vtkTimeStamp vtkPolyPlane::NormalComputeTime

protected

Definition at line 77 of file vtkPolyPlane.h.

vtkDoubleArray* vtkPolyPlane::Normals

protected

Definition at line 78 of file vtkPolyPlane.h.

vtkIdType vtkPolyPlane::ClosestPlaneIdx

protected

Definition at line 79 of file vtkPolyPlane.h.

---

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

• dox/Common/DataModel/vtkPolyPlane.h