X3D Exporter Writer. More...

#include <vtkX3DExporterWriter.h>

Inheritance diagram for vtkX3DExporterWriter:

Collaboration diagram for vtkX3DExporterWriter:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkX3DExporterWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual int	OpenFile (const char *file)=0
	Opens the file specified with file returns 1 if successful otherwise 0.

virtual int	OpenStream ()=0
	Init data support to be a stream instead of a file.

char *	RegisterAndGetOutputString ()
	This convenience method returns the string, sets the IVAR to nullptr, so that the user is responsible for deleting the string.

virtual void	CloseFile ()=0

virtual void	Flush ()

virtual void	StartDocument ()=0
	Starts a document and sets all necessary information, i.e.

virtual void	EndDocument ()=0
	Ends a document and sets all necessary information or necessary bytes to finish the encoding correctly.

virtual void	SetField (int attributeID, const char *value, bool mfstring=false)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, int)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, float)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, double)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, bool)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, int type, const double *a)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, int type, vtkDataArray *a)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, const double *values, size_t size)=0
	Sets the field specified with attributeID of the active node to the given value.

virtual void	SetField (int attributeID, const int *values, size_t size, bool image=false)=0
	Sets the field specified with attributeID of the active node to the given value.


virtual void	SetWriteToOutputString (vtkTypeBool)
	Enable writing to an OutputString instead of the default, a file.

virtual vtkTypeBool	GetWriteToOutputString ()
	Enable writing to an OutputString instead of the default, a file.

virtual void	WriteToOutputStringOn ()
	Enable writing to an OutputString instead of the default, a file.

virtual void	WriteToOutputStringOff ()
	Enable writing to an OutputString instead of the default, a file.


virtual vtkIdType	GetOutputStringLength ()
	When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.

virtual char *	GetOutputString ()
	When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.

unsigned char *	GetBinaryOutputString ()
	When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.


virtual void	StartNode (int nodeID)=0
	Starts/ends a new X3D node specified via nodeID.

virtual void	EndNode ()=0
	Starts/ends a new X3D node specified via nodeID.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkX3DExporterWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkX3DExporterWriter ()

	~vtkX3DExporterWriter () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	OutputString

vtkIdType	OutputStringLength

vtkTypeBool	WriteToOutputString

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

X3D Exporter Writer.

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

Definition at line 35 of file vtkX3DExporterWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkX3DExporterWriter::Superclass

Definition at line 38 of file vtkX3DExporterWriter.h.

Constructor & Destructor Documentation

◆ vtkX3DExporterWriter()

vtkX3DExporterWriter::vtkX3DExporterWriter ( )

protected

◆ ~vtkX3DExporterWriter()

vtkX3DExporterWriter::~vtkX3DExporterWriter ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkX3DExporterWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ NewInstance()

vtkX3DExporterWriter * vtkX3DExporterWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkX3DExporterWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ OpenFile()

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

pure virtual

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

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ OpenStream()

virtual int vtkX3DExporterWriter::OpenStream ( )

pure virtual

Init data support to be a stream instead of a file.

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ SetWriteToOutputString()

virtual void vtkX3DExporterWriter::SetWriteToOutputString ( vtkTypeBool )

virtual

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

◆ GetWriteToOutputString()

virtual vtkTypeBool vtkX3DExporterWriter::GetWriteToOutputString ( )

virtual

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

◆ WriteToOutputStringOn()

virtual void vtkX3DExporterWriter::WriteToOutputStringOn ( )

virtual

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

◆ WriteToOutputStringOff()

virtual void vtkX3DExporterWriter::WriteToOutputStringOff ( )

virtual

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

◆ GetOutputStringLength()

virtual vtkIdType 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 ...

◆ GetOutputString()

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

◆ GetBinaryOutputString()

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 69 of file vtkX3DExporterWriter.h.

◆ RegisterAndGetOutputString()

char * vtkX3DExporterWriter::RegisterAndGetOutputString ( )

This convenience method returns the string, sets the IVAR to nullptr, 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.

◆ CloseFile()

virtual void vtkX3DExporterWriter::CloseFile ( )

pure virtual

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ Flush()

virtual void vtkX3DExporterWriter::Flush ( )

inlinevirtual

Reimplemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

Definition at line 87 of file vtkX3DExporterWriter.h.

◆ StartDocument()

virtual void vtkX3DExporterWriter::StartDocument ( )

pure virtual

Starts a document and sets all necessary information, i.e.

the header of the implemented encoding

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ EndDocument()

virtual void vtkX3DExporterWriter::EndDocument ( )

pure virtual

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

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

◆ StartNode()

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.

◆ EndNode()

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.