vtkVolumeOutlineSource Class Reference

#include <vtkVolumeOutlineSource.h>

Inheritance diagram for vtkVolumeOutlineSource:

Inheritance graph
[legend]
Collaboration diagram for vtkVolumeOutlineSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

outline of volume cropping region

vtkVolumeOutlineSource generates a wireframe outline that corresponds to the cropping region of a vtkVolumeMapper. It requires a vtkVolumeMapper as input. The GenerateFaces option turns on the solid faces of the outline, and the GenerateScalars option generates color scalars. When GenerateScalars is on, it is possible to set an "ActivePlaneId" value in the range [0..6] to highlight one of the six cropping planes.

Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Tests:
vtkVolumeOutlineSource (Tests)

Definition at line 39 of file vtkVolumeOutlineSource.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 SetVolumeMapper (vtkVolumeMapper *mapper)
vtkVolumeMapperGetVolumeMapper ()
virtual void SetGenerateScalars (int)
virtual void GenerateScalarsOn ()
virtual void GenerateScalarsOff ()
virtual int GetGenerateScalars ()
virtual void SetGenerateOutline (int)
virtual void GenerateOutlineOn ()
virtual void GenerateOutlineOff ()
virtual int GetGenerateOutline ()
virtual void SetGenerateFaces (int)
virtual void GenerateFacesOn ()
virtual void GenerateFacesOff ()
virtual int GetGenerateFaces ()
virtual void SetColor (double, double, double)
virtual void SetColor (double[3])
virtual double * GetColor ()
virtual void GetColor (double &, double &, double &)
virtual void GetColor (double[3])
virtual void SetActivePlaneId (int)
virtual int GetActivePlaneId ()
virtual void SetActivePlaneColor (double, double, double)
virtual void SetActivePlaneColor (double[3])
virtual double * GetActivePlaneColor ()
virtual void GetActivePlaneColor (double &, double &, double &)
virtual void GetActivePlaneColor (double[3])

Static Public Member Functions

static vtkVolumeOutlineSourceNew ()
static int IsTypeOf (const char *type)
static vtkVolumeOutlineSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkVolumeOutlineSource ()
 ~vtkVolumeOutlineSource ()
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, int requestFromOutputPort, unsigned long *mtime)
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Static Protected Member Functions

static int ComputeCubePlanes (double planes[3][4], double croppingPlanes[6], double bounds[6])
static void GeneratePolys (vtkCellArray *polys, vtkUnsignedCharArray *scalars, unsigned char colors[2][3], int activePlane, int flags, int tolPtId[3][4])
static void GenerateLines (vtkCellArray *lines, vtkUnsignedCharArray *scalars, unsigned char colors[2][3], int activePlane, int flags, int tolPtId[3][4])
static void GeneratePoints (vtkPoints *points, vtkCellArray *lines, vtkCellArray *polys, double planes[3][4], double tol)
static void NudgeCropPlanesToBounds (int tolPtId[3][4], double planes[3][4], double tol)
static void CreateColorValues (unsigned char colors[2][3], double color1[3], double color2[3])

Protected Attributes

vtkVolumeMapperVolumeMapper
int GenerateScalars
int GenerateOutline
int GenerateFaces
int ActivePlaneId
double Color [3]
double ActivePlaneColor [3]
int Cropping
int CroppingRegionFlags
double Bounds [6]
double CroppingRegionPlanes [6]

Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 43 of file vtkVolumeOutlineSource.h.


Constructor & Destructor Documentation

vtkVolumeOutlineSource::vtkVolumeOutlineSource (  )  [protected]

vtkVolumeOutlineSource::~vtkVolumeOutlineSource (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

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

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

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

Reimplemented from vtkPolyDataAlgorithm.

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

virtual void vtkVolumeOutlineSource::SetVolumeMapper ( vtkVolumeMapper mapper  )  [virtual]

Set the mapper that has the cropping region that the outline will be generated for. The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.

vtkVolumeMapper* vtkVolumeOutlineSource::GetVolumeMapper (  )  [inline]

Set the mapper that has the cropping region that the outline will be generated for. The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.

Definition at line 51 of file vtkVolumeOutlineSource.h.

virtual void vtkVolumeOutlineSource::SetGenerateScalars ( int   )  [virtual]

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

virtual void vtkVolumeOutlineSource::GenerateScalarsOn (  )  [virtual]

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

virtual void vtkVolumeOutlineSource::GenerateScalarsOff (  )  [virtual]

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

virtual int vtkVolumeOutlineSource::GetGenerateScalars (  )  [virtual]

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

virtual void vtkVolumeOutlineSource::SetGenerateOutline ( int   )  [virtual]

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

virtual void vtkVolumeOutlineSource::GenerateOutlineOn (  )  [virtual]

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

virtual void vtkVolumeOutlineSource::GenerateOutlineOff (  )  [virtual]

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

virtual int vtkVolumeOutlineSource::GetGenerateOutline (  )  [virtual]

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

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

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

virtual void vtkVolumeOutlineSource::GenerateFacesOn (  )  [virtual]

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

virtual void vtkVolumeOutlineSource::GenerateFacesOff (  )  [virtual]

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

virtual int vtkVolumeOutlineSource::GetGenerateFaces (  )  [virtual]

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

virtual void vtkVolumeOutlineSource::SetColor ( double  ,
double  ,
double   
) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void vtkVolumeOutlineSource::SetColor ( double  [3]  )  [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual double* vtkVolumeOutlineSource::GetColor (  )  [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void vtkVolumeOutlineSource::GetColor ( double &  ,
double &  ,
double &   
) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void vtkVolumeOutlineSource::GetColor ( double  [3]  )  [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void vtkVolumeOutlineSource::SetActivePlaneId ( int   )  [virtual]

Set the active plane, e.g. to display which plane is currently being modified by an interaction. Set this to -1 if there is no active plane. The default value is -1.

virtual int vtkVolumeOutlineSource::GetActivePlaneId (  )  [virtual]

Set the active plane, e.g. to display which plane is currently being modified by an interaction. Set this to -1 if there is no active plane. The default value is -1.

virtual void vtkVolumeOutlineSource::SetActivePlaneColor ( double  ,
double  ,
double   
) [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void vtkVolumeOutlineSource::SetActivePlaneColor ( double  [3]  )  [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual double* vtkVolumeOutlineSource::GetActivePlaneColor (  )  [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void vtkVolumeOutlineSource::GetActivePlaneColor ( double &  ,
double &  ,
double &   
) [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void vtkVolumeOutlineSource::GetActivePlaneColor ( double  [3]  )  [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

static int vtkVolumeOutlineSource::ComputeCubePlanes ( double  planes[3][4],
double  croppingPlanes[6],
double  bounds[6] 
) [static, protected]

static void vtkVolumeOutlineSource::GeneratePolys ( vtkCellArray polys,
vtkUnsignedCharArray scalars,
unsigned char  colors[2][3],
int  activePlane,
int  flags,
int  tolPtId[3][4] 
) [static, protected]

static void vtkVolumeOutlineSource::GenerateLines ( vtkCellArray lines,
vtkUnsignedCharArray scalars,
unsigned char  colors[2][3],
int  activePlane,
int  flags,
int  tolPtId[3][4] 
) [static, protected]

static void vtkVolumeOutlineSource::GeneratePoints ( vtkPoints points,
vtkCellArray lines,
vtkCellArray polys,
double  planes[3][4],
double  tol 
) [static, protected]

static void vtkVolumeOutlineSource::NudgeCropPlanesToBounds ( int  tolPtId[3][4],
double  planes[3][4],
double  tol 
) [static, protected]

static void vtkVolumeOutlineSource::CreateColorValues ( unsigned char  colors[2][3],
double  color1[3],
double  color2[3] 
) [static, protected]

virtual int vtkVolumeOutlineSource::ComputePipelineMTime ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
int  requestFromOutputPort,
unsigned long *  mtime 
) [protected, virtual]

A special version of ProcessRequest meant specifically for the pipeline modified time request. See vtkExecutive::ComputePipelineMTime() for details.

Reimplemented from vtkAlgorithm.

virtual int vtkVolumeOutlineSource::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

Definition at line 107 of file vtkVolumeOutlineSource.h.

Definition at line 108 of file vtkVolumeOutlineSource.h.

Definition at line 109 of file vtkVolumeOutlineSource.h.

Definition at line 110 of file vtkVolumeOutlineSource.h.

Definition at line 111 of file vtkVolumeOutlineSource.h.

double vtkVolumeOutlineSource::Color[3] [protected]

Definition at line 112 of file vtkVolumeOutlineSource.h.

Definition at line 113 of file vtkVolumeOutlineSource.h.

Definition at line 115 of file vtkVolumeOutlineSource.h.

Definition at line 116 of file vtkVolumeOutlineSource.h.

double vtkVolumeOutlineSource::Bounds[6] [protected]

Definition at line 117 of file vtkVolumeOutlineSource.h.

Definition at line 118 of file vtkVolumeOutlineSource.h.


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

Generated on Wed Aug 24 12:18:14 2011 for VTK by  doxygen 1.5.6