VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkX3DExporterWriter Class Referenceabstract

X3D Exporter Writer. More...

#include <vtkX3DExporterWriter.h>

Inheritance diagram for vtkX3DExporterWriter:
[legend]
Collaboration diagram for vtkX3DExporterWriter:
[legend]

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. More...
 
vtkX3DExporterWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int OpenFile (const char *file)=0
 Opens the file specified with file returns 1 if successful otherwise 0. More...
 
virtual int OpenStream ()=0
 Init data support to be a stream instead of a file. More...
 
virtual void SetWriteToOutputString (vtkTypeBool)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual vtkTypeBool GetWriteToOutputString ()
 
virtual void WriteToOutputStringOn ()
 
virtual void WriteToOutputStringOff ()
 
virtual vtkIdType GetOutputStringLength ()
 When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...
 
virtual char * GetOutputString ()
 
unsigned char * GetBinaryOutputString ()
 
char * RegisterAndGetOutputString ()
 This convenience method returns the string, sets the IVAR to nullptr, so that the user is responsible for deleting the string. More...
 
virtual void CloseFile ()=0
 
virtual void Flush ()
 
virtual void StartDocument ()=0
 Starts a document and sets all necessary information, i.e. More...
 
virtual void EndDocument ()=0
 Ends a document and sets all necessary information or necessary bytes to finish the encoding correctly. More...
 
virtual void StartNode (int nodeID)=0
 Starts/ends a new X3D node specified via nodeID. More...
 
virtual void EndNode ()=0
 
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. More...
 
virtual void SetField (int attributeID, int)=0
 Sets the field specified with attributeID of the active node to the given value. More...
 
virtual void SetField (int attributeID, float)=0
 Sets the field specified with attributeID of the active node to the given value. More...
 
virtual void SetField (int attributeID, double)=0
 Sets the field specified with attributeID of the active node to the given value. More...
 
virtual void SetField (int attributeID, bool)=0
 Sets the field specified with attributeID of the active node to the given value. More...
 
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. More...
 
virtual void SetField (int attributeID, int type, vtkDataArray *a)=0
 Sets the field specified with attributeID of the active node to the given value. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkX3DExporterWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
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
 
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
 

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

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 vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkX3DExporterWriter::NewInstanceInternal ( ) const
protectedvirtual

◆ 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 vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

◆ OpenStream()

virtual int vtkX3DExporterWriter::OpenStream ( )
pure virtual

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

Implemented in vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

◆ SetWriteToOutputString()

virtual void vtkX3DExporterWriter::SetWriteToOutputString ( vtkTypeBool  )
virtual

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

◆ GetWriteToOutputString()

virtual vtkTypeBool vtkX3DExporterWriter::GetWriteToOutputString ( )
virtual

◆ WriteToOutputStringOn()

virtual void vtkX3DExporterWriter::WriteToOutputStringOn ( )
virtual

◆ WriteToOutputStringOff()

virtual void vtkX3DExporterWriter::WriteToOutputStringOff ( )
virtual

◆ 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

◆ GetBinaryOutputString()

unsigned char* vtkX3DExporterWriter::GetBinaryOutputString ( )
inline

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

◆ 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

◆ SetField() [1/9]

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 vtkX3DExporterXMLWriter, and vtkX3DExporterFIWriter.

◆ SetField() [2/9]

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.

◆ SetField() [3/9]

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.

◆ SetField() [4/9]

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.

◆ SetField() [5/9]

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.

◆ SetField() [6/9]

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.

◆ SetField() [7/9]

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.

◆ SetField() [8/9]

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.

◆ SetField() [9/9]

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 formatting or compression Supported types: MFINT32, SFIMAGE

Implemented in vtkX3DExporterFIWriter, and vtkX3DExporterXMLWriter.

Member Data Documentation

◆ OutputString

char* vtkX3DExporterWriter::OutputString
protected

Definition at line 194 of file vtkX3DExporterWriter.h.

◆ OutputStringLength

vtkIdType vtkX3DExporterWriter::OutputStringLength
protected

Definition at line 195 of file vtkX3DExporterWriter.h.

◆ WriteToOutputString

vtkTypeBool vtkX3DExporterWriter::WriteToOutputString
protected

Definition at line 196 of file vtkX3DExporterWriter.h.


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