vtkVRMLExporter Class Reference

export a scene into VRML 2.0 format. More...

#include <vtkVRMLExporter.h>

Inheritance diagram for vtkVRMLExporter:

Collaboration diagram for vtkVRMLExporter:

Public Types
typedef vtkExporter	Superclass
Public Types inherited from vtkExporter
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.
vtkVRMLExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetFilePointer (FILE *)
	Set the file pointer to write to.
	vtkSetFilePathMacro (FileName)
	Specify the name of the VRML file to write.
	vtkGetFilePathMacro (FileName)
	Specify the name of the VRML file to write.
virtual void	SetSpeed (double)
	Specify the Speed of navigation.
virtual double	GetSpeed ()
	Specify the Speed of navigation.
Public Member Functions inherited from vtkExporter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual VTK_UNBLOCKTHREADS void	Write ()
	Write data to output.
VTK_UNBLOCKTHREADS void	Update ()
	Convenient alias for Write() method.
void	SetStartWrite (void(*f)(void *), void *arg)
	Specify a function to be called before data is written.
void	SetEndWrite (void(*f)(void *), void *arg)
	Specify a function to be called after data is written.
void	SetStartWriteArgDelete (void(*f)(void *))
	Set the arg delete method.
void	SetEndWriteArgDelete (void(*f)(void *))
	Set the arg delete method.
vtkMTimeType	GetMTime () override
	Returns the MTime also considering the RenderWindow.
virtual void	SetRenderWindow (vtkRenderWindow *)
	Set/Get the rendering window that contains the scene to be written.
virtual vtkRenderWindow *	GetRenderWindow ()
	Set/Get the rendering window that contains the scene to be written.
virtual void	SetActiveRenderer (vtkRenderer *)
	Set/Get the renderer that contains actors to be written.
virtual vtkRenderer *	GetActiveRenderer ()
	Set/Get the renderer that contains actors to be written.
void	SetInput (vtkRenderWindow *renWin)
	These methods are provided for backward compatibility.
vtkRenderWindow *	GetInput ()
	These methods are provided for backward compatibility.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
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.
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.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkVRMLExporter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkVRMLExporter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkExporter
static vtkTypeBool	IsTypeOf (const char *type)
static vtkExporter *	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 (vtkTypeBool 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 vtkTypeBool	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
	vtkVRMLExporter ()
	~vtkVRMLExporter () override
void	WriteData () override
void	WriteALight (vtkLight *aLight, FILE *fp)
void	WriteAnActor (vtkActor *anActor, FILE *fp)
void	WritePointData (vtkPoints *points, vtkDataArray *normals, vtkDataArray *tcoords, vtkUnsignedCharArray *colors, FILE *fp)
void	WriteShapeBegin (vtkActor *actor, FILE *fileP, vtkPolyData *polyData, vtkPointData *pntData, vtkUnsignedCharArray *color)
void	WriteShapeEnd (FILE *fileP)
Protected Member Functions inherited from vtkExporter
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkExporter ()
	~vtkExporter () override
virtual void	WriteData ()=0
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 *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName
FILE *	FilePointer
double	Speed
Protected Attributes inherited from vtkExporter
vtkRenderWindow *	RenderWindow
vtkRenderer *	ActiveRenderer
void(*	StartWrite )(void *)
void(*	StartWriteArgDelete )(void *)
void *	StartWriteArg
void(*	EndWrite )(void *)
void(*	EndWriteArgDelete )(void *)
void *	EndWriteArg
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
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

export a scene into VRML 2.0 format.

vtkVRMLExporter is a concrete subclass of vtkExporter that writes VRML 2.0 files. This is based on the VRML 2.0 draft #3 but it should be pretty stable since we aren't using any of the newer features.

See also

vtkExporter

Online Examples:

ImportToExport

Tests:

vtkVRMLExporter (Tests)

Definition at line 52 of file vtkVRMLExporter.h.

Member Typedef Documentation

Superclass

typedef vtkExporter vtkVRMLExporter::Superclass

Definition at line 56 of file vtkVRMLExporter.h.

Constructor & Destructor Documentation

vtkVRMLExporter()

vtkVRMLExporter::vtkVRMLExporter ( )

protected

~vtkVRMLExporter()

vtkVRMLExporter::~vtkVRMLExporter ( )

overrideprotected

Member Function Documentation

New()

static vtkVRMLExporter * vtkVRMLExporter::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkVRMLExporter::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 vtkExporter.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkVRMLExporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkExporter.

NewInstance()

vtkVRMLExporter * vtkVRMLExporter::NewInstance

(

)

const

PrintSelf()

void vtkVRMLExporter::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 vtkExporter.

vtkSetFilePathMacro()

vtkVRMLExporter::vtkSetFilePathMacro

(

FileName

)

Specify the name of the VRML file to write.

vtkGetFilePathMacro()

vtkVRMLExporter::vtkGetFilePathMacro

(

FileName

)

Specify the name of the VRML file to write.

SetSpeed()

virtual void vtkVRMLExporter::SetSpeed ( double  )

virtual

Specify the Speed of navigation.

Default is 4.

GetSpeed()

virtual double vtkVRMLExporter::GetSpeed ( )

virtual

Specify the Speed of navigation.

Default is 4.

SetFilePointer()

void vtkVRMLExporter::SetFilePointer

(

FILE *

)

Set the file pointer to write to.

This will override a FileName if specified.

WriteData()

void vtkVRMLExporter::WriteData ( )

overrideprotectedvirtual

Implements vtkExporter.

WriteALight()

void vtkVRMLExporter::WriteALight ( vtkLight *  aLight, FILE *  fp  )

protected

WriteAnActor()

void vtkVRMLExporter::WriteAnActor ( vtkActor *  anActor, FILE *  fp  )

protected

WritePointData()

void vtkVRMLExporter::WritePointData ( vtkPoints *  points, vtkDataArray *  normals, vtkDataArray *  tcoords, vtkUnsignedCharArray *  colors, FILE *  fp  )

protected

WriteShapeBegin()

void vtkVRMLExporter::WriteShapeBegin ( vtkActor *  actor, FILE *  fileP, vtkPolyData *  polyData, vtkPointData *  pntData, vtkUnsignedCharArray *  color  )

protected

WriteShapeEnd()

void vtkVRMLExporter::WriteShapeEnd ( FILE *  fileP )

protected

Member Data Documentation

FileName

char* vtkVRMLExporter::FileName

protected

Definition at line 93 of file vtkVRMLExporter.h.

FilePointer

FILE* vtkVRMLExporter::FilePointer

protected

Definition at line 94 of file vtkVRMLExporter.h.

Speed

double vtkVRMLExporter::Speed

protected

Definition at line 95 of file vtkVRMLExporter.h.

---

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

• IO/Export/vtkVRMLExporter.h