outline of volume cropping region More...

#include <vtkVolumeOutlineSource.h>

Inheritance diagram for vtkVolumeOutlineSource:

Collaboration diagram for vtkVolumeOutlineSource:

Public Types
typedef vtkPolyDataAlgorithm	Superclass

Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkVolumeOutlineSource *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


virtual void	SetVolumeMapper (vtkVolumeMapper *mapper)

vtkVolumeMapper *	GetVolumeMapper ()


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

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

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()

vtkPolyData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

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

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

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)

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

static int	IsTypeOf (const char *type)

static vtkVolumeOutlineSource *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

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

	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)

Protected Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()

	~vtkPolyDataAlgorithm ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes
vtkVolumeMapper *	VolumeMapper

int	GenerateScalars

int	GenerateOutline

int	GenerateFaces

int	ActivePlaneId

double	Color [3]

double	ActivePlaneColor [3]

int	Cropping

int	CroppingRegionFlags

double	Bounds [6]

double	CroppingRegionPlanes [6]

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 40 of file vtkVolumeOutlineSource.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkVolumeOutlineSource::Superclass

Definition at line 44 of file vtkVolumeOutlineSource.h.

Constructor & Destructor Documentation

vtkVolumeOutlineSource::vtkVolumeOutlineSource ( )

protected

vtkVolumeOutlineSource::~vtkVolumeOutlineSource ( )

protected

Member Function Documentation

static vtkVolumeOutlineSource* vtkVolumeOutlineSource::New ( )

static

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

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkVolumeOutlineSource::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkVolumeOutlineSource* vtkVolumeOutlineSource::NewInstance ( ) const

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 52 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