implicit function for a frustum More...

#include <vtkFrustum.h>

Inheritance diagram for vtkFrustum:

Collaboration diagram for vtkFrustum:

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.

vtkFrustum *	NewInstance () const

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

double	EvaluateFunction (double x[3]) override
	Evaluate function at position x-y-z and return value.

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

virtual double	EvaluateFunction (double x[3])=0
	Evaluate function at position x-y-z and return value.

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)
	Evaluate function at position x-y-z and return value.

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

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


virtual double	GetNearPlaneDistance ()
	Get/Set the near plane distance of the frustum, i.e.

void	SetNearPlaneDistance (double distance)
	Get/Set the near plane distance of the frustum, i.e.


virtual double	GetHorizontalAngle ()
	Get/Set the horizontal angle of the frustum in degrees.

void	SetHorizontalAngle (double angleInDegrees)
	Get/Set the horizontal angle of the frustum in degrees.


virtual double	GetVerticalAngle ()
	Get/Set the vertical angle of the frustum in degrees.

void	SetVerticalAngle (double angleInDegrees)
	Get/Set the vertical angle of the frustum in degrees.


vtkPlane *	GetTopPlane ()
	Get individual planes that make up the frustum.

vtkPlane *	GetBottomPlane ()
	Get individual planes that make up the frustum.

vtkPlane *	GetRightPlane ()
	Get individual planes that make up the frustum.

vtkPlane *	GetLeftPlane ()
	Get individual planes that make up the frustum.

vtkPlane *	GetNearPlane ()
	Get individual planes that make up the frustum.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkFrustum *	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

	vtkFrustum ()

	~vtkFrustum () 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 frustum

vtkFrustum represents a 4-sided frustum, with a near plane but infinite on the far side. It is defined by the two angles between its forward axis and its horizontal and vertical planes, and the distance between its origin and near plane. vtkFrustum is a concrete implementation of vtkImplicitFunction. The frustum is oriented toward the Y Axis; its top face facing toward the Z Axis and its "right" face facing the X Axis.

Warning: The frustum is infinite in extent towards its far plane. To truncate the frustum in modeling operations use the vtkImplicitBoolean in combination with clipping planes.

Tests:: vtkFrustum (Tests)

Definition at line 34 of file vtkFrustum.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImplicitFunction vtkFrustum::Superclass

Definition at line 38 of file vtkFrustum.h.

Constructor & Destructor Documentation

◆ vtkFrustum()

vtkFrustum::vtkFrustum ( )

protected

◆ ~vtkFrustum()

vtkFrustum::~vtkFrustum ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkFrustum * vtkFrustum::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkFrustum::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkFrustum * vtkFrustum::NewInstance ( ) const

◆ PrintSelf()

void vtkFrustum::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 vtkFrustum::EvaluateFunction ( double x[3] )

overridevirtual

Evaluate function at position x-y-z and return value.

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

Implements vtkImplicitFunction.

◆ EvaluateGradient() [1/2]

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

Implements vtkImplicitFunction.

◆ GetNearPlaneDistance()

virtual double vtkFrustum::GetNearPlaneDistance ( )

virtual

Get/Set the near plane distance of the frustum, i.e.

the distance between its origin and near plane along the forward axis. Values below 0 will be clamped. Defaults to 0.5.

◆ SetNearPlaneDistance()

void vtkFrustum::SetNearPlaneDistance ( double distance )

Get/Set the near plane distance of the frustum, i.e.

the distance between its origin and near plane along the forward axis. Values below 0 will be clamped. Defaults to 0.5.

◆ GetHorizontalAngle()

virtual double vtkFrustum::GetHorizontalAngle ( )

virtual

Get/Set the horizontal angle of the frustum in degrees.

It represents the angle between its forward axis and its right and left planes. Clamped between 1 and 89 degrees. Defaults to 30.

◆ SetHorizontalAngle()

void vtkFrustum::SetHorizontalAngle ( double angleInDegrees )

Get/Set the horizontal angle of the frustum in degrees.

It represents the angle between its forward axis and its right and left planes. Clamped between 1 and 89 degrees. Defaults to 30.

◆ GetVerticalAngle()

virtual double vtkFrustum::GetVerticalAngle ( )

virtual

Get/Set the vertical angle of the frustum in degrees.

It represents the angle between its forward axis and its top and bottom planes. Clamped between 1 and 89 degrees. Defaults to 30.

◆ SetVerticalAngle()

void vtkFrustum::SetVerticalAngle ( double angleInDegrees )

Get/Set the vertical angle of the frustum in degrees.

It represents the angle between its forward axis and its top and bottom planes. Clamped between 1 and 89 degrees. Defaults to 30.