extends vtkPlane to add Offset parameter. More...

#include <vtkPVPlane.h>

Inheritance diagram for vtkPVPlane:

Collaboration diagram for vtkPVPlane:

[legend]

Public Types
typedef vtkPlane	Superclass

Public Types inherited from vtkPlane
typedef vtkImplicitFunction	Superclass

Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	EvaluateGradient (double x[3], double g[3]) override
	Evaluate function gradient at position x-y-z and pass back vector. More...


void	SetOffset (double offset)
	The origin is shifted in the direction of the normal by the offset. More...

virtual double	GetOffset ()
	The origin is shifted in the direction of the normal by the offset. More...


void	SetOrigin (double x, double y, double z) override
	sets axis to the nearest canonical axis. More...

void	SetOrigin (const double origin[3]) override
	sets axis to the nearest canonical axis. More...


void	SetNormal (double x, double y, double z) override
	If AxisAligned is true, sets axis to the nearest canonical axis. More...

void	SetNormal (const double normal[3]) override
	If AxisAligned is true, sets axis to the nearest canonical axis. More...


void	SetAxisAligned (bool axisAligned)
	Accessors for AxisAligned, which locks normal to plane to be aligned with x, y, or z axis. More...

virtual bool	GetAxisAligned ()
	Accessors for AxisAligned, which locks normal to plane to be aligned with x, y, or z axis. More...


void	SetTransform (vtkAbstractTransform *) override
	Set/Get a transformation to apply to input points before executing the implicit function. More...

void	SetTransform (const double elements[16]) override
	Set/Get a transformation to apply to input points before executing the implicit function. More...


void	EvaluateFunction (vtkDataArray input, vtkDataArray output) override

double	EvaluateFunction (double x[3]) override

Public Member Functions inherited from vtkPlane
vtkPlane *	NewInstance () const

void	Push (double distance)

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

virtual double *	GetNormal ()

virtual void	GetNormal (double data[3])

virtual double *	GetOrigin ()

virtual void	GetOrigin (double data[3])

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

virtual double *	GetNormal ()

virtual void	GetNormal (double data[3])

virtual double *	GetOrigin ()

virtual void	GetOrigin (double data[3])

void	ProjectPoint (double x[3], double xproj[3])

void	ProjectVector (double v[3], double vproj[3])

void	GeneralizedProjectPoint (double x[3], double xproj[3])

double	DistanceToPlane (double x[3])

int	IntersectWithLine (double p1[3], double p2[3], double &t, double x[3])

Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const

vtkMTimeType	GetMTime ()

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 vtkAbstractTransform *	GetTransform ()

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

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 vtkAbstractTransform *	GetTransform ()

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

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVPlane *	New ()

static int	IsTypeOf (const char *type)

static vtkPVPlane *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPlane
static vtkPlane *	New ()

static int	IsTypeOf (const char *type)

static vtkPlane *	SafeDownCast (vtkObjectBase *o)

static double	Evaluate (double normal[3], double origin[3], double x[3])

static void	ProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])

static void	ProjectVector (double v[3], double origin[3], double normal[3], double vproj[3])

static void	GeneralizedProjectPoint (double x[3], double origin[3], double normal[3], double xproj[3])

static double	DistanceToPlane (double x[3], double n[3], double p0[3])

static int	IntersectWithLine (double p1[3], double p2[3], double n[3], double p0[3], double &t, double x[3])

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 vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVPlane ()

	~vtkPVPlane () override

void	InternalPlaneUpdate ()

Protected Member Functions inherited from vtkPlane
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlane ()

	~vtkPlane ()

Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()

	~vtkImplicitFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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	Offset

bool	AxisAligned

vtkNew< vtkPlane >	Plane

Protected Attributes inherited from vtkPlane
double	Normal [3]

double	Origin [3]

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

extends vtkPlane to add Offset parameter.

vtkPVPlane adds an offset setting to vtkPlane. This offset is used together with normal and origin when setting parameters on the represented object.

Definition at line 19 of file vtkPVPlane.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlane vtkPVPlane::Superclass

Definition at line 23 of file vtkPVPlane.h.

Constructor & Destructor Documentation

◆ vtkPVPlane()

vtkPVPlane::vtkPVPlane ( )

protected

◆ ~vtkPVPlane()

vtkPVPlane::~vtkPVPlane ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVPlane* vtkPVPlane::New ( )

static

◆ GetClassName()

virtual const char* vtkPVPlane::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkPVPlane::IsA ( const char * type )

virtual

Reimplemented from vtkPlane.

◆ SafeDownCast()

static vtkPVPlane* vtkPVPlane::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPlane.

◆ SetOffset()

void vtkPVPlane::SetOffset ( double offset )

The origin is shifted in the direction of the normal by the offset.

◆ GetOffset()

virtual double vtkPVPlane::GetOffset ( )

virtual

The origin is shifted in the direction of the normal by the offset.

◆ SetOrigin() [1/2]

void vtkPVPlane::SetOrigin	(	double	x,
		double	y,
		double	z
	)

overridevirtual

sets axis to the nearest canonical axis.

Reimplemented from vtkPlane.

◆ SetOrigin() [2/2]

void vtkPVPlane::SetOrigin ( const double origin[3] )

inlineoverridevirtual

sets axis to the nearest canonical axis.

Reimplemented from vtkPlane.

Definition at line 40 of file vtkPVPlane.h.

◆ SetNormal() [1/2]

void vtkPVPlane::SetNormal	(	double	x,
		double	y,
		double	z
	)

overridevirtual

If AxisAligned is true, sets axis to the nearest canonical axis.

Reimplemented from vtkPlane.

◆ SetNormal() [2/2]

void vtkPVPlane::SetNormal ( const double normal[3] )

inlineoverridevirtual

If AxisAligned is true, sets axis to the nearest canonical axis.

Reimplemented from vtkPlane.

Definition at line 51 of file vtkPVPlane.h.

◆ SetAxisAligned()

void vtkPVPlane::SetAxisAligned ( bool axisAligned )

Accessors for AxisAligned, which locks normal to plane to be aligned with x, y, or z axis.

◆ GetAxisAligned()

virtual bool vtkPVPlane::GetAxisAligned ( )

virtual

Accessors for AxisAligned, which locks normal to plane to be aligned with x, y, or z axis.

◆ SetTransform() [1/2]

void vtkPVPlane::SetTransform ( vtkAbstractTransform * )

overridevirtual

Set/Get a transformation to apply to input points before executing the implicit function.

Reimplemented from vtkImplicitFunction.

◆ SetTransform() [2/2]

void vtkPVPlane::SetTransform ( const double elements[16] )

overridevirtual

Set/Get a transformation to apply to input points before executing the implicit function.

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [1/2]

void vtkPVPlane::EvaluateFunction	(	vtkDataArray *	input,
		vtkDataArray *	output
	)

override

◆ EvaluateFunction() [2/2]

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

overridevirtual

Reimplemented from vtkPlane.

◆ EvaluateGradient()

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

overridevirtual

Evaluate function gradient at position x-y-z and pass back vector.

You should generally not call this method directly, you should use FunctionGradient() instead. This method must be implemented by any derived class.

Reimplemented from vtkPlane.

◆ InternalPlaneUpdate()

void vtkPVPlane::InternalPlaneUpdate ( )

protected

Member Data Documentation

◆ Offset

double vtkPVPlane::Offset

protected

Definition at line 100 of file vtkPVPlane.h.

◆ AxisAligned

bool vtkPVPlane::AxisAligned

protected

Definition at line 101 of file vtkPVPlane.h.

◆ Plane

vtkNew<vtkPlane> vtkPVPlane::Plane

protected

Definition at line 103 of file vtkPVPlane.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/Misc/vtkPVPlane.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVPlane()

◆ ~vtkPVPlane()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetOffset()

◆ GetOffset()

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

◆ SetNormal() [1/2]

◆ SetNormal() [2/2]

◆ SetAxisAligned()

◆ GetAxisAligned()

◆ SetTransform() [1/2]

◆ SetTransform() [2/2]

◆ EvaluateFunction() [1/2]

◆ EvaluateFunction() [2/2]

◆ EvaluateGradient()

◆ InternalPlaneUpdate()

Member Data Documentation

◆ Offset

◆ AxisAligned

◆ Plane