vtkOutlineSource Class Reference

#include <vtkOutlineSource.h>

Inheritance diagram for vtkOutlineSource:

[legend]

Collaboration diagram for vtkOutlineSource:

[legend]

List of all members.

Detailed Description

create wireframe outline around bounding box

vtkOutlineSource creates a wireframe outline around a user-specified bounding box. The outline may be created aligned with the {x,y,z} axis - in which case it is defined by the 6 bounds {xmin,xmax,ymin,ymax,zmin,zmax} via SetBounds(). Alternatively, the box may be arbitrarily aligned, in which case it should be set via the SetCorners() member.

Tests:: vtkOutlineSource (Tests)

Definition at line 37 of file vtkOutlineSource.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetBoxType (int)
virtual int	GetBoxType ()
void	SetBoxTypeToAxisAligned ()
void	SetBoxTypeToOriented ()

virtual void	SetBounds (double, double, double, double, double, double)
virtual void	SetBounds (double[6])
virtual double *	GetBounds ()
virtual void	GetBounds (double data[6])

virtual void	SetCorners (double data[])
virtual double *	GetCorners ()
virtual void	GetCorners (double data[24])

virtual void	SetGenerateFaces (int)
virtual void	GenerateFacesOn ()
virtual void	GenerateFacesOff ()
virtual int	GetGenerateFaces ()
Static Public Member Functions
static vtkOutlineSource *	New ()
static int	IsTypeOf (const char *type)
static vtkOutlineSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkOutlineSource ()
	~vtkOutlineSource ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
int	BoxType
int	GenerateFaces
double	Bounds [6]
double	Corners [24]

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkOutlineSource::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

Definition at line 41 of file vtkOutlineSource.h.

Constructor & Destructor Documentation

vtkOutlineSource::vtkOutlineSource ( ) [protected]

vtkOutlineSource::~vtkOutlineSource ( ) [inline, protected]

Definition at line 80 of file vtkOutlineSource.h.

Member Function Documentation

static vtkOutlineSource* vtkOutlineSource::New ( ) [static]

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

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

virtual const char* vtkOutlineSource::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

static int vtkOutlineSource::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 vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

virtual int vtkOutlineSource::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 vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

static vtkOutlineSource* vtkOutlineSource::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

void vtkOutlineSource::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 vtkPolyDataAlgorithm.

Reimplemented in vtkOutlineCornerSource.

virtual void vtkOutlineSource::SetBoxType ( int ) [virtual]

Set box type to AxisAligned (default) or Oriented. Use the method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.

virtual int vtkOutlineSource::GetBoxType ( ) [virtual]

Set box type to AxisAligned (default) or Oriented. Use the method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.

void vtkOutlineSource::SetBoxTypeToAxisAligned ( ) [inline]

Set box type to AxisAligned (default) or Oriented. Use the method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.

Definition at line 50 of file vtkOutlineSource.h.

void vtkOutlineSource::SetBoxTypeToOriented ( ) [inline]

Set box type to AxisAligned (default) or Oriented. Use the method SetBounds() with AxisAligned mode, and SetCorners() with Oriented mode.

Definition at line 52 of file vtkOutlineSource.h.

virtual void vtkOutlineSource::SetBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)			`[virtual]`

Specify the bounds of the box to be used in Axis Aligned mode.

virtual void vtkOutlineSource::SetBounds ( double [6] ) [virtual]

Specify the bounds of the box to be used in Axis Aligned mode.

virtual double* vtkOutlineSource::GetBounds ( ) [virtual]

Specify the bounds of the box to be used in Axis Aligned mode.

virtual void vtkOutlineSource::GetBounds ( double data[6] ) [virtual]

Specify the bounds of the box to be used in Axis Aligned mode.

virtual void vtkOutlineSource::SetCorners ( double data[] ) [virtual]

Specify the corners of the outline when in Oriented mode, the values are supplied as 8*3 double values The correct corner ordering is using {x,y,z} convention for the unit cube as follows: {0,0,0},{1,0,0},{0,1,0},{1,1,0},{0,0,1},{1,0,1},{0,1,1},{1,1,1}.

virtual double* vtkOutlineSource::GetCorners ( ) [virtual]

Specify the corners of the outline when in Oriented mode, the values are supplied as 8*3 double values The correct corner ordering is using {x,y,z} convention for the unit cube as follows: {0,0,0},{1,0,0},{0,1,0},{1,1,0},{0,0,1},{1,0,1},{0,1,1},{1,1,1}.

virtual void vtkOutlineSource::GetCorners ( double data[24] ) [virtual]

Specify the corners of the outline when in Oriented mode, the values are supplied as 8*3 double values The correct corner ordering is using {x,y,z} convention for the unit cube as follows: {0,0,0},{1,0,0},{0,1,0},{1,1,0},{0,0,1},{1,0,1},{0,1,1},{1,1,1}.

virtual void vtkOutlineSource::SetGenerateFaces ( int ) [virtual]

Generate solid faces for the box. This is off by default.

virtual void vtkOutlineSource::GenerateFacesOn ( ) [virtual]

Generate solid faces for the box. This is off by default.

virtual void vtkOutlineSource::GenerateFacesOff ( ) [virtual]

Generate solid faces for the box. This is off by default.

virtual int vtkOutlineSource::GetGenerateFaces ( ) [virtual]

Generate solid faces for the box. This is off by default.

int vtkOutlineSource::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`