FiletoActor Class Reference
[Gui/FiletoActor]

The purpose of this class is to contruct a dataflow from a file as input to an actor as output. More...

#include <FiletoActor.h>

Inheritance diagram for FiletoActor:

[legend]Collaboration diagram for FiletoActor:


Public Member Functions
	vtkTypeMacro (FiletoActor, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the state of this object.
void	decimate (float arg)
	Decimate the dataflow data.
float	decimate () const
	Give the decimation factor.
vtkActor *	actor () const
	Give the Actor.
vtkPolyDataMapper *	mapper () const
	Give the Mapper.
virtual void	SetFileName (const char *pathname)
	Specify the input file name.
virtual void	SetFileName (const std::string pathname)
	Specify the input file name.
vtkPolyData *	GetOutput () const
	Give the PolyData object that is the output of the FiletoPoly object.
vtkPolyData *	GetDecimatedOutput () const
	Give the PolyData object that is the DecimatedOuput of the FiletoPoly object.
void	SetInput (vtkPolyData *input)
	Set the PolyData object that is applied to the Actor.
vtkPolyData *	GetInput () const
	Give the current input of this object.
std::string	inputType () const
	Give the input type as given by FiletoPoly::classType().
virtual void	ReleaseDataFlagOn ()
	Specify dynamic memory management.
virtual void	ReleaseDataFlagOff ()
	Specify static memory management.
virtual void	SetReleaseDataFlag (int dynamic)
	Specify the memory management model (i.e.
virtual int	GetReleaseDataFlag ()
	Give the memory management model.
void	DebugOn ()
	This function overloads the one in vtkObject.
void	DebugOff ()
	This function overloads the one in vtkObject.
Static Public Member Functions
static FiletoActor *	New ()
	Instantiate a new object of this type.
Protected Member Functions
	FiletoActor ()
	Ctor.
virtual	~FiletoActor ()
	Dtor.
void	constructDataflow ()
	Construct the dataflow.
Protected Attributes
FiletoPoly *	_dataflow
	The FiletoPoly portion of the dataflow.
vtkPolyDataMapper *	_mapper
	The Mapper that terminates the dataflow.
vtkActor *	_actor
	The Actor which may be may be applied to a Renderer.

Detailed Description

The purpose of this class is to contruct a dataflow from a file as input to an actor as output.

This class may be used as is or as a base class.

Definition at line 30 of file FiletoActor.h.

Constructor & Destructor Documentation

FiletoActor::FiletoActor ( ) [protected]

Ctor.

Allocate some of the required objects.

virtual FiletoActor::~FiletoActor ( ) [protected, virtual]

Dtor.

Clean up.

Member Function Documentation

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

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:: The new object.

Reimplemented from vtkObject.

FiletoActor::vtkTypeMacro	(	FiletoActor	,
		vtkObject
	)

void FiletoActor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Print the state of this object.

Parameters:

	os	The output stream.
	indent	The indentation level. Used for formating output.

Reimplemented from vtkObject.

void FiletoActor::decimate ( float arg )

Decimate the dataflow data.

This function is used to speed the graphics display during those times when the view is changing in some manner. This function will generate a notify to those Observer objects that are registed with this object.

Parameters:

arg

The decimation factor, 0.0 < arg <= 1.0, where a value of 1.0 represents no decimation and 0.0 + epsilion represents maximum decimation. Values that do not satisfy the above inequality will be changed to the nearest value that does.

float FiletoActor::decimate ( ) const

Give the decimation factor.

Returns:: The decimation factor; 0.0 <= return < 1.0.

vtkActor* FiletoActor::actor ( ) const

Give the Actor.

Returns:: The Actor that terminates the dataflow.

vtkPolyDataMapper* FiletoActor::mapper ( ) const

Give the Mapper.

Returns:: The Mapper that terminates the dataflow.

virtual void FiletoActor::SetFileName ( const char * pathname ) [virtual]

Specify the input file name.

Parameters:

pathname

The FQN of the input file.

virtual void FiletoActor::SetFileName ( const std::string pathname ) [virtual]

Specify the input file name.

Parameters:

pathname

The FQN of the input file.

vtkPolyData* FiletoActor::GetOutput ( ) const

Give the PolyData object that is the output of the FiletoPoly object.

This may be used to insert external dataflow (in conjuction with SetInput()), tee of the data or modify it.

Returns:: The PolyData associated with the output of this dataflow.

vtkPolyData* FiletoActor::GetDecimatedOutput ( ) const

Give the PolyData object that is the DecimatedOuput of the FiletoPoly object.

Returns:: The PolyData associated with the decimated output of this dataflow.

void FiletoActor::SetInput ( vtkPolyData * input )

Set the PolyData object that is applied to the Actor.

This may be used to insert additional dataflow externally between this object's GetOutput() and SetInput(). To reset the dataflow to the situation taht exists immediately after ctor do object.SetInput(object.GetOutput()) where object is an object of this class.

Parameters:

input

The input dataset.

vtkPolyData* FiletoActor::GetInput ( ) const

Give the current input of this object.

Returns:

std::string FiletoActor::inputType ( ) const

Give the input type as given by FiletoPoly::classType().

Returns:: The input type.

virtual void FiletoActor::ReleaseDataFlagOn ( ) [virtual]

Specify dynamic memory management.

virtual void FiletoActor::ReleaseDataFlagOff ( ) [virtual]

Specify static memory management.

virtual void FiletoActor::SetReleaseDataFlag ( int dynamic ) [virtual]

Specify the memory management model (i.e.

static or dynamic).

Parameters:

dynamic

If the model is to be dynamic then non zero.

virtual int FiletoActor::GetReleaseDataFlag ( ) [virtual]

Give the memory management model.

Returns:: If the model is dynamic then true.

void FiletoActor::DebugOn ( ) [virtual]

This function overloads the one in vtkObject.

Set both this object's and the imbedded dataflow object's debbuging on.

Reimplemented from vtkObject.

void FiletoActor::DebugOff ( ) [virtual]

This function overloads the one in vtkObject.

Set both this object's and the imbedded dataflow object's debbuging off.

Reimplemented from vtkObject.

void FiletoActor::constructDataflow ( ) [protected]

Construct the dataflow.

This function simply attaches the mapper to the dataflow provided by the ctor which is assumed to be valid here. This function may be overload in order to construct baroque dataflows. This function sets objectState appropiately as should any overriding function.