X3D Exporter Writer. More...

#include <vtkX3DExporterWriter.h>

Inheritance diagram for vtkX3DExporterWriter:

Collaboration diagram for vtkX3DExporterWriter:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkX3DExporterWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	OpenFile (const char *file)=0

virtual int	OpenStream ()=0

char *	RegisterAndGetOutputString ()

virtual void	CloseFile ()=0

virtual void	Flush ()

virtual void	StartDocument ()=0

virtual void	EndDocument ()=0

virtual void	SetField (int attributeID, const char *value, bool mfstring=false)=0

virtual void	SetField (int attributeID, int)=0

virtual void	SetField (int attributeID, float)=0

virtual void	SetField (int attributeID, double)=0

virtual void	SetField (int attributeID, bool)=0

virtual void	SetField (int attributeID, int type, const double *a)=0

virtual void	SetField (int attributeID, int type, vtkDataArray *a)=0

virtual void	SetField (int attributeID, const double *values, size_t size)=0

virtual void	SetField (int attributeID, const int *values, size_t size, bool image=false)=0


virtual void	SetWriteToOutputString (int)

virtual int	GetWriteToOutputString ()

virtual void	WriteToOutputStringOn ()

virtual void	WriteToOutputStringOff ()


virtual int	GetOutputStringLength ()

virtual char *	GetOutputString ()

unsigned char *	GetBinaryOutputString ()


virtual void	StartNode (int nodeID)=0

virtual void	EndNode ()=0

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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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 int	IsTypeOf (const char *type)

static vtkX3DExporterWriter *	SafeDownCast (vtkObjectBase *o)

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


	vtkX3DExporterWriter ()

	~vtkX3DExporterWriter ()

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

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	OutputString

int	OutputStringLength

int	WriteToOutputString

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

X3D Exporter Writer.

vtkX3DExporterWriter is the definition for classes that implement a encoding for the X3D exporter

Definition at line 34 of file vtkX3DExporterWriter.h.

Member Typedef Documentation

typedef vtkObject vtkX3DExporterWriter::Superclass

Definition at line 37 of file vtkX3DExporterWriter.h.

Constructor & Destructor Documentation

vtkX3DExporterWriter::vtkX3DExporterWriter ( )

protected

Sets the field specified with attributeID of the active node to the given value. The type of the field is specified with type Supported types: MFString virtual void SetField(int attributeID, int type, std::string) = 0;

vtkX3DExporterWriter::~vtkX3DExporterWriter ( )

protected

Sets the field specified with attributeID of the active node to the given value. The type of the field is specified with type Supported types: MFString virtual void SetField(int attributeID, int type, std::string) = 0;

Member Function Documentation

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

static

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

Reimplemented in vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

static vtkX3DExporterWriter* vtkX3DExporterWriter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkX3DExporterWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

vtkX3DExporterWriter* vtkX3DExporterWriter::NewInstance ( ) const

void vtkX3DExporterWriter::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 vtkObject.

Reimplemented in vtkX3DExporterXMLWriter.

virtual int vtkX3DExporterWriter::OpenFile ( const char * file )

pure virtual

Opens the file specified with file returns 1 if successful otherwise 0

Implemented in vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

virtual int vtkX3DExporterWriter::OpenStream ( )

pure virtual

Init data support to be a stream instead of a file

Implemented in vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

virtual void vtkX3DExporterWriter::SetWriteToOutputString ( int )

virtual

Enable writing to an OutputString instead of the default, a file.

virtual int vtkX3DExporterWriter::GetWriteToOutputString ( )

virtual

Enable writing to an OutputString instead of the default, a file.

virtual void vtkX3DExporterWriter::WriteToOutputStringOn ( )

virtual

Enable writing to an OutputString instead of the default, a file.

virtual void vtkX3DExporterWriter::WriteToOutputStringOff ( )

virtual

Enable writing to an OutputString instead of the default, a file.

virtual int vtkX3DExporterWriter::GetOutputStringLength ( )

virtual

When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. The string is deleted during the next call to write ...

virtual char* vtkX3DExporterWriter::GetOutputString ( )

virtual

When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. The string is deleted during the next call to write ...

unsigned char* vtkX3DExporterWriter::GetBinaryOutputString ( )

inline

When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. The string is deleted during the next call to write ...

Definition at line 60 of file vtkX3DExporterWriter.h.

char* vtkX3DExporterWriter::RegisterAndGetOutputString ( )

This convenience method returns the string, sets the IVAR to NULL, so that the user is responsible for deleting the string. I am not sure what the name should be, so it may change in the future.

virtual void vtkX3DExporterWriter::CloseFile ( )

pure virtual

Implemented in vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

virtual void vtkX3DExporterWriter::Flush ( )

inlinevirtual

Reimplemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

Definition at line 76 of file vtkX3DExporterWriter.h.

virtual void vtkX3DExporterWriter::StartDocument ( )

pure virtual

Starts a document and sets all necessary informations, i.e. the header of the implemented encoding

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::EndDocument ( )

pure virtual

Ends a document and sets all necessary informations or necessary bytes to finish the encoding correctly

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::StartNode ( int nodeID )

pure virtual

Starts/ends a new X3D node specified via nodeID. The list of nodeIds can be found in vtkX3DExportWriterSymbols.h. The EndNode function closes the last open node. So there must be corresponding Start/EndNode() calls for every node

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::EndNode ( )

pure virtual

Starts/ends a new X3D node specified via nodeID. The list of nodeIds can be found in vtkX3DExportWriterSymbols.h. The EndNode function closes the last open node. So there must be corresponding Start/EndNode() calls for every node

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		const char *	value,
		bool	mfstring = `false`
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is SFString and MFString virtual void SetField(int attributeID, const std::string &value) = 0;

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		int
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is SFInt32

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		float
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is SFFloat

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		double
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is SFDouble

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		bool
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is SFBool

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		int	type,
		const double *	a
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is specified with type Supported types: SFVEC3F, SFCOLOR, SFROTATION

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		int	type,
		vtkDataArray *	a
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is specified with type Supported types: MFVEC3F, MFVEC2F

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		const double *	values,
		size_t	size
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is specified with type Supported types: MFCOLOR

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

virtual void vtkX3DExporterWriter::SetField	(	int	attributeID,
		const int *	values,
		size_t	size,
		bool	image = `false`
	)

pure virtual

Sets the field specified with attributeID of the active node to the given value. The type of the field is specified with type It is possible to specify that the field is an image for optimized formating or compression Supported types: MFINT32, SFIMAGE

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

Member Data Documentation

char* vtkX3DExporterWriter::OutputString

protected

Definition at line 147 of file vtkX3DExporterWriter.h.

int vtkX3DExporterWriter::OutputStringLength

protected

Definition at line 148 of file vtkX3DExporterWriter.h.

int vtkX3DExporterWriter::WriteToOutputString

protected

Definition at line 149 of file vtkX3DExporterWriter.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Export/vtkX3DExporterWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation