vtkStructuredExtent Class Reference

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

#include <vtkStructuredExtent.h>

Inheritance diagram for vtkStructuredExtent:

Collaboration diagram for vtkStructuredExtent:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkStructuredExtent *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
Static Public Member Functions
static vtkStructuredExtent *	New ()
static int	IsTypeOf (const char *type)
static vtkStructuredExtent *	SafeDownCast (vtkObjectBase *o)
static void	Clamp (int ext[6], int wholeExt[6])
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])
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkStructuredExtent ()
	~vtkStructuredExtent ()

---

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

Reimplemented from vtkObject.

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]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkStructuredExtent::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type 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.

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]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkStructuredExtent::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkStructuredExtent* vtkStructuredExtent::NewInstance

(

)

const

Reimplemented from vtkObject.

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],
		int	wholeExt[6]
	)		[inline, static]

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]
	)		[inline, static]

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]
	)		[inline, static]

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
	)		[inline, static]

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]
	)		[inline, static]

Makes ext relative to wholeExt.

Definition at line 141 of file vtkStructuredExtent.h.

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

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:

• dox/Common/DataModel/vtkStructuredExtent.h