implicit function for a cylinder More...

#include <vtkCylinder.h>

Inheritance diagram for vtkCylinder:

Collaboration diagram for vtkCylinder:

Public Types
typedef vtkImplicitFunction	Superclass

Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCylinder *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	EvaluateGradient (double x[3], double g[3]) override
	Evaluate cylinder function gradient. More...


double	EvaluateFunction (double x[3]) override
	Evaluate cylinder equation F(r) = r^2 - Radius^2. More...

double	EvaluateFunction (double x, double y, double z)
	Evaluate cylinder equation F(r) = r^2 - Radius^2. More...


virtual void	SetRadius (double)
	Set/Get the cylinder radius. More...

virtual double	GetRadius ()
	Set/Get the cylinder radius. More...


virtual void	SetCenter (double, double, double)
	Set/Get the cylinder center. More...

virtual void	SetCenter (double[3])
	Set/Get the cylinder center. More...

virtual double *	GetCenter ()
	Set/Get the cylinder center. More...

virtual void	GetCenter (double &, double &, double &)
	Set/Get the cylinder center. More...

virtual void	GetCenter (double[3])
	Set/Get the cylinder center. More...


void	SetAxis (double ax, double ay, double az)
	Set/Get the axis of the cylinder. More...

void	SetAxis (double a[3])
	Set/Get the axis of the cylinder. More...

virtual double *	GetAxis ()
	Set/Get the axis of the cylinder. More...

virtual void	GetAxis (double &, double &, double &)
	Set/Get the axis of the cylinder. More...

virtual void	GetAxis (double[3])
	Set/Get the axis of the cylinder. More...

Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () 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...

double	FunctionValue (const double x[3])
	Evaluate function at position x-y-z and return value. More...

double	FunctionValue (double x, double y, double z)
	Evaluate function at position x-y-z and return value. More...

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])
	Evaluate function gradient at position x-y-z and pass back vector. More...

double *	FunctionGradient (double x, double y, double z)
	Evaluate function gradient at position x-y-z and pass back vector. More...

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])
	Set/Get a transformation to apply to input points before executing the implicit function. More...

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

double	EvaluateFunction (double x, double y, double z)
	Evaluate function at position x-y-z and return value. More...

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

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkCylinder *	SafeDownCast (vtkObjectBase *o)

static vtkCylinder *	New ()
	Construct cylinder radius of 0.5; centered at origin with axis along y coordinate axis. More...

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 ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCylinder ()

	~vtkCylinder () 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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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	Radius

double	Center [3]

double	Axis [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

implicit function for a cylinder

vtkCylinder computes the implicit function and function gradient for a cylinder using F(r)=r^2-Radius^2. vtkCylinder is a concrete implementation of vtkImplicitFunction. By default the Cylinder is centered at the origin and the axis of rotation is along the y-axis. You can redefine the center and axis of rotation by setting the Center and Axis data members. (Note that it is also possible to use the superclass' vtkImplicitFunction transformation matrix if necessary to reposition by using FunctionValue() and FunctionGradient().)

Warning: The cylinder is infinite in extent. To truncate the cylinder in modeling operations use the vtkImplicitBoolean in combination with clipping planes.

Tests:: vtkCylinder (Tests)

Definition at line 44 of file vtkCylinder.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkCylinder::Superclass

Definition at line 47 of file vtkCylinder.h.

Constructor & Destructor Documentation

vtkCylinder::vtkCylinder ( )

protected

vtkCylinder::~vtkCylinder ( )

inlineoverrideprotected

Definition at line 99 of file vtkCylinder.h.

Member Function Documentation

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

static

virtual int vtkCylinder::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 vtkCylinder* vtkCylinder::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkCylinder::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkCylinder* vtkCylinder::NewInstance ( ) const

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

static vtkCylinder* vtkCylinder::New ( )

static

Construct cylinder radius of 0.5; centered at origin with axis along y coordinate axis.

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

overridevirtual

Evaluate cylinder equation F(r) = r^2 - Radius^2.

Implements vtkImplicitFunction.

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

inline

Evaluate cylinder equation F(r) = r^2 - Radius^2.

Definition at line 61 of file vtkCylinder.h.

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

overridevirtual

Evaluate cylinder function gradient.

Implements vtkImplicitFunction.

virtual void vtkCylinder::SetRadius ( double )

virtual

Set/Get the cylinder radius.

virtual double vtkCylinder::GetRadius ( )

virtual

Set/Get the cylinder radius.

virtual void vtkCylinder::SetCenter	(	double	,
		double	,
		double
	)

virtual

Set/Get the cylinder center.

virtual void vtkCylinder::SetCenter ( double [3] )

virtual

Set/Get the cylinder center.

virtual double* vtkCylinder::GetCenter ( )

virtual

Set/Get the cylinder center.

virtual void vtkCylinder::GetCenter	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the cylinder center.

virtual void vtkCylinder::GetCenter ( double [3] )

virtual

Set/Get the cylinder center.

void vtkCylinder::SetAxis	(	double	ax,
		double	ay,
		double	az
	)

Set/Get the axis of the cylinder.