Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkOutlineSource Class Reference

#include <vtkOutlineSource.h>

Inheritance diagram for vtkOutlineSource:

Inheritance graph
[legend]
Collaboration diagram for vtkOutlineSource:

Collaboration graph
[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.

Created by:
  • Schroeder, Will
CVS contributions (if > 5%):
  • Schroeder, Will (54%)
  • Biddiscombe, John (21%)
  • Martin, Ken (16%)
CVS logs (CVSweb):
  • .cxx (/Graphics/vtkOutlineSource.cxx)
  • .h (/Graphics/vtkOutlineSource.h)

Definition at line 46 of file vtkOutlineSource.h.

Public Types

typedef vtkPolyDataSource 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])

Static Public Member Functions

vtkOutlineSourceNew ()
int IsTypeOf (const char *type)
vtkOutlineSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkOutlineSource ()
 ~vtkOutlineSource ()
void Execute ()

Protected Attributes

int BoxType
double Bounds [6]
double Corners [24]


Member Typedef Documentation

typedef vtkPolyDataSource vtkOutlineSource::Superclass
 

Reimplemented from vtkPolyDataSource.

Reimplemented in vtkOutlineCornerSource.

Definition at line 50 of file vtkOutlineSource.h.


Constructor & Destructor Documentation

vtkOutlineSource::vtkOutlineSource  )  [protected]
 

vtkOutlineSource::~vtkOutlineSource  )  [inline, protected]
 

Definition at line 82 of file vtkOutlineSource.h.


Member Function Documentation

vtkOutlineSource* vtkOutlineSource::New  )  [static]
 

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkOutlineCornerSource.

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

Reimplemented from vtkPolyDataSource.

Reimplemented in vtkOutlineCornerSource.

int vtkOutlineSource::IsTypeOf const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

Reimplemented in vtkOutlineCornerSource.

virtual int vtkOutlineSource::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

Reimplemented in vtkOutlineCornerSource.

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

Reimplemented from vtkPolyDataSource.

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 vtkPolyDataSource.

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 59 of file vtkOutlineSource.h.

References VTK_BOX_TYPE_AXIS_ALIGNED.

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 61 of file vtkOutlineSource.h.

References VTK_BOX_TYPE_ORIENTED.

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}.

void vtkOutlineSource::Execute  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

Reimplemented in vtkOutlineCornerSource.


Member Data Documentation

int vtkOutlineSource::BoxType [protected]
 

Definition at line 85 of file vtkOutlineSource.h.

double vtkOutlineSource::Bounds[6] [protected]
 

Definition at line 86 of file vtkOutlineSource.h.

double vtkOutlineSource::Corners[24] [protected]
 

Definition at line 87 of file vtkOutlineSource.h.


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