helper class to aid working with structured extents. More...

#include <vtkStructuredExtent.h>

Inheritance diagram for vtkStructuredExtent:

Collaboration diagram for vtkStructuredExtent:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkStructuredExtent *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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

static int	IsTypeOf (const char *type)

static vtkStructuredExtent *	SafeDownCast (vtkObjectBase *o)

static void	Clamp (int ext[6], const int wholeExt[])

static bool	StrictlySmaller (const int ext[6], const int wholeExt[6])

static bool	Smaller (const int ext[6], const int wholeExt[6])

static void	Grow (int ext[6], int count)

static void	Transform (int ext[6], int wholeExt[6])

static void	GetDimensions (const int ext[6], int dims[3])

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

	vtkStructuredExtent ()

	~vtkStructuredExtent ()

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 &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

helper class to aid working with structured extents.

vtkStructuredExtent is an helper class that helps in arithmetic with structured extents. It defines a bunch of static methods (most of which are inlined) to aid in dealing with extents.

Tests:: vtkStructuredExtent (Tests)

Definition at line 34 of file vtkStructuredExtent.h.

Member Typedef Documentation

typedef vtkObject vtkStructuredExtent::Superclass

Definition at line 38 of file vtkStructuredExtent.h.

Constructor & Destructor Documentation

vtkStructuredExtent::vtkStructuredExtent ( )

protected

vtkStructuredExtent::~vtkStructuredExtent ( )

protected

Member Function Documentation

static vtkStructuredExtent* vtkStructuredExtent::New ( )

static

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

static

virtual int vtkStructuredExtent::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 vtkObject.

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

static

virtual vtkObjectBase* vtkStructuredExtent::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkStructuredExtent* vtkStructuredExtent::NewInstance ( ) const

void vtkStructuredExtent::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 vtkObject.

void vtkStructuredExtent::Clamp	(	int	ext[6],
		const int	wholeExt[]
	)

inlinestatic

Clamps ext to fit in wholeExt.

Definition at line 73 of file vtkStructuredExtent.h.

bool vtkStructuredExtent::StrictlySmaller	(	const int	ext[6],
		const int	wholeExt[6]
	)

inlinestatic

Returns true if ext is fits within wholeExt with atleast 1 dimension smaller than the wholeExt.

Definition at line 110 of file vtkStructuredExtent.h.

bool vtkStructuredExtent::Smaller	(	const int	ext[6],
		const int	wholeExt[6]
	)

inlinestatic

Returns if ext fits within wholeExt. Unline StrictlySmaller, this method returns true even if ext == wholeExt.

Definition at line 86 of file vtkStructuredExtent.h.

void vtkStructuredExtent::Grow	(	int	ext[6],
		int	count
	)

inlinestatic

Grows the ext on each side by the given count.

Definition at line 129 of file vtkStructuredExtent.h.

void vtkStructuredExtent::Transform	(	int	ext[6],
		int	wholeExt[6]
	)

inlinestatic

Makes ext relative to wholeExt.

Definition at line 141 of file vtkStructuredExtent.h.

void vtkStructuredExtent::GetDimensions	(	const int	ext[6],
		int	dims[3]
	)

inlinestatic

Given the extents, computes the dimensions.

Definition at line 154 of file vtkStructuredExtent.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkStructuredExtent.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation