implicit function for a annulus More...

#include <vtkAnnulus.h>

Inheritance diagram for vtkAnnulus:

Collaboration diagram for vtkAnnulus:

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.

vtkAnnulus *	NewInstance () const

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

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


double	EvaluateFunction (double x[3]) override
	Evaluate annulus equation.

virtual double	EvaluateFunction (double x[3])=0
	Evaluate annulus equation.

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)
	Evaluate annulus equation.

virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate annulus equation.


void	SetInnerRadius (double radius)
	Set/Get the inner annulus radius.

double	GetInnerRadius () const
	Set/Get the inner annulus radius.


void	SetOuterRadius (double radius)
	Set/Get the outer annulus radius.

double	GetOuterRadius () const
	Set/Get the outer annulus radius.


void	SetCenter (double x, double y, double z)
	Set/Get the annulus center.

void	SetCenter (const double xyz[3])
	Set/Get the annulus center.

void	SetCenter (const vtkVector3d &xyz)
	Set/Get the annulus center.

void	GetCenter (double &x, double &y, double &z)
	Set/Get the annulus center.

void	GetCenter (double xyz[3])
	Set/Get the annulus center.

double *	GetCenter ()
	Set/Get the annulus center.


void	SetAxis (double x, double y, double z)
	Set/Get the axis of the annulus.

void	SetAxis (double axis[3])
	Set/Get the axis of the annulus.

void	SetAxis (const vtkVector3d &axis)
	Set/Get the axis of the annulus.

void	GetAxis (double &x, double &y, double &z)
	Set/Get the axis of the annulus.

void	GetAxis (double xyz[3])
	Set/Get the axis of the annulus.

double *	GetAxis ()
	Set/Get the axis of the annulus.

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.

Static Public Member Functions
static vtkAnnulus *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAnnulus *	SafeDownCast (vtkObjectBase *o)

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAnnulus ()

	~vtkAnnulus () 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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Detailed Description

implicit function for a annulus

vtkAnnulus computes the implicit function and function gradient for an annulus composed of two co-axial cylinders. vtkAnnulus is a concrete implementation of vtkImplicitFunction. By default the Annulus 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 annulus is infinite in extent. To truncate the annulus in modeling operations use the vtkImplicitBoolean in combination with clipping planes.

Tests:: vtkAnnulus (Tests)

Definition at line 40 of file vtkAnnulus.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImplicitFunction vtkAnnulus::Superclass

Definition at line 44 of file vtkAnnulus.h.

Constructor & Destructor Documentation

◆ vtkAnnulus()

vtkAnnulus::vtkAnnulus ( )

protected

◆ ~vtkAnnulus()

vtkAnnulus::~vtkAnnulus ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkAnnulus * vtkAnnulus::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAnnulus::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkAnnulus * vtkAnnulus::NewInstance ( ) const

◆ PrintSelf()

void vtkAnnulus::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 vtkObjectBase.

◆ EvaluateFunction() [1/4]

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

overridevirtual

Evaluate annulus equation.

Implements vtkImplicitFunction.

◆ EvaluateGradient()

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

overridevirtual

Evaluate annulus function gradient.

Implements vtkImplicitFunction.

◆ SetInnerRadius()

void vtkAnnulus::SetInnerRadius ( double radius )

Set/Get the inner annulus radius.

Default is 0.25.

◆ GetInnerRadius()

double vtkAnnulus::GetInnerRadius ( ) const

Set/Get the inner annulus radius.

Default is 0.25.

◆ SetOuterRadius()

void vtkAnnulus::SetOuterRadius ( double radius )

Set/Get the outer annulus radius.

Default is 0.5.

◆ GetOuterRadius()

double vtkAnnulus::GetOuterRadius ( ) const

Set/Get the outer annulus radius.

Default is 0.5.

◆ SetCenter() [1/3]

void vtkAnnulus::SetCenter	(	double	x,
		double	y,
		double	z
	)

Set/Get the annulus center.

Default is (0, 0, 0).

◆ SetCenter() [2/3]

void vtkAnnulus::SetCenter ( const double xyz[3] )

Set/Get the annulus center.

Default is (0, 0, 0).

◆ SetCenter() [3/3]

void vtkAnnulus::SetCenter ( const vtkVector3d & xyz )

Set/Get the annulus center.

Default is (0, 0, 0).

◆ GetCenter() [1/3]

void vtkAnnulus::GetCenter	(	double &	x,
		double &	y,
		double &	z
	)

Set/Get the annulus center.

Default is (0, 0, 0).

◆ GetCenter() [2/3]

void vtkAnnulus::GetCenter ( double xyz[3] )

Set/Get the annulus center.

Default is (0, 0, 0).

◆ GetCenter() [3/3]

double * vtkAnnulus::GetCenter ( )

Set/Get the annulus center.

Default is (0, 0, 0).