vtkX3DExporter Class Reference

create an x3d file More...

#include <vtkX3DExporter.h>

Inheritance diagram for vtkX3DExporter:

Collaboration diagram for vtkX3DExporter:

Public Types
typedef vtkExporter	Superclass
Public Types inherited from vtkExporter
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkX3DExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
char *	RegisterAndGetOutputString ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetSpeed (double)
virtual double	GetSpeed ()
virtual void	SetBinary (int)
virtual void	BinaryOn ()
virtual void	BinaryOff ()
virtual int	GetBinary ()
virtual void	SetFastest (int)
virtual void	FastestOn ()
virtual void	FastestOff ()
virtual int	GetFastest ()
virtual void	SetWriteToOutputString (int)
virtual int	GetWriteToOutputString ()
virtual void	WriteToOutputStringOn ()
virtual void	WriteToOutputStringOff ()
virtual int	GetOutputStringLength ()
virtual char *	GetOutputString ()
unsigned char *	GetBinaryOutputString ()
Public Member Functions inherited from vtkExporter
vtkExporter *	NewInstance () const
virtual void	Write ()
void	Update ()
void	SetStartWrite (void(*f)(void *), void *arg)
void	SetEndWrite (void(*f)(void *), void *arg)
void	SetStartWriteArgDelete (void(*f)(void *))
void	SetEndWriteArgDelete (void(*f)(void *))
unsigned long	GetMTime ()
virtual void	SetRenderWindow (vtkRenderWindow *)
virtual vtkRenderWindow *	GetRenderWindow ()
void	SetInput (vtkRenderWindow *renWin)
vtkRenderWindow *	GetInput ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
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 vtkX3DExporter *	New ()
static int	IsTypeOf (const char *type)
static vtkX3DExporter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkExporter
static int	IsTypeOf (const char *type)
static vtkExporter *	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
	vtkX3DExporter ()
	~vtkX3DExporter ()
void	WriteData ()
void	WriteALight (vtkLight *aLight, vtkX3DExporterWriter *writer)
void	WriteAnActor (vtkActor *anActor, vtkX3DExporterWriter *writer, int index)
void	WritePointData (vtkPoints *points, vtkDataArray *normals, vtkDataArray *tcoords, vtkUnsignedCharArray *colors, vtkX3DExporterWriter *writer, int index)
void	WriteATextActor2D (vtkActor2D *anTextActor2D, vtkX3DExporterWriter *writer)
void	WriteATexture (vtkActor *anActor, vtkX3DExporterWriter *writer)
void	WriteAnAppearance (vtkActor *anActor, bool writeEmissiveColor, vtkX3DExporterWriter *writer)
int	HasHeadLight (vtkRenderer *ren)
Protected Member Functions inherited from vtkExporter
	vtkExporter ()
	~vtkExporter ()
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
int	WriteToOutputString
char *	OutputString
int	OutputStringLength
char *	FileName
double	Speed
int	Binary
int	Fastest
Protected Attributes inherited from vtkExporter
vtkRenderWindow *	RenderWindow
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
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

create an x3d file

vtkX3DExporter is a render window exporter which writes out the renderered scene into an X3D file. X3D is an XML-based format for representation 3D scenes (similar to VRML). Check out http://www.web3d.org/x3d/ for more details.

Thanks:

X3DExporter is contributed by Christophe Mouton at EDF.

Tests:

vtkX3DExporter (Tests)

Definition at line 44 of file vtkX3DExporter.h.

Member Typedef Documentation

typedef vtkExporter vtkX3DExporter::Superclass

Definition at line 48 of file vtkX3DExporter.h.

Constructor & Destructor Documentation

vtkX3DExporter::vtkX3DExporter ( )

protected

vtkX3DExporter::~vtkX3DExporter ( )

protected

Member Function Documentation

static vtkX3DExporter* vtkX3DExporter::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkX3DExporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkExporter.

vtkX3DExporter* vtkX3DExporter::NewInstance

(

)

const

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

virtual void vtkX3DExporter::SetFileName ( const char *  )

virtual

Set/Get the output file name.

virtual char* vtkX3DExporter::GetFileName ( )

virtual

Set/Get the output file name.

virtual void vtkX3DExporter::SetSpeed ( double  )

virtual

Specify the Speed of navigation. Default is 4.

virtual double vtkX3DExporter::GetSpeed ( )

virtual

Specify the Speed of navigation. Default is 4.

virtual void vtkX3DExporter::SetBinary ( int  )

virtual

Turn on binary mode

virtual void vtkX3DExporter::BinaryOn ( )

virtual

Turn on binary mode

virtual void vtkX3DExporter::BinaryOff ( )

virtual

Turn on binary mode

virtual int vtkX3DExporter::GetBinary ( )

virtual

Turn on binary mode

virtual void vtkX3DExporter::SetFastest ( int  )

virtual

In binary mode use fastest instead of best compression

virtual void vtkX3DExporter::FastestOn ( )

virtual

In binary mode use fastest instead of best compression

virtual void vtkX3DExporter::FastestOff ( )

virtual

In binary mode use fastest instead of best compression

virtual int vtkX3DExporter::GetFastest ( )

virtual

In binary mode use fastest instead of best compression

virtual void vtkX3DExporter::SetWriteToOutputString ( int  )

virtual

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

virtual int vtkX3DExporter::GetWriteToOutputString ( )

virtual

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

virtual void vtkX3DExporter::WriteToOutputStringOn ( )

virtual

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

virtual void vtkX3DExporter::WriteToOutputStringOff ( )

virtual

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

virtual int vtkX3DExporter::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* vtkX3DExporter::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* vtkX3DExporter::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 90 of file vtkX3DExporter.h.

char* vtkX3DExporter::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.

void vtkX3DExporter::WriteData ( )

protectedvirtual

Write data to output.

Implements vtkExporter.

void vtkX3DExporter::WriteALight ( vtkLight *  aLight, vtkX3DExporterWriter *  writer  )

protected

void vtkX3DExporter::WriteAnActor ( vtkActor *  anActor, vtkX3DExporterWriter *  writer, int  index  )

protected

void vtkX3DExporter::WritePointData ( vtkPoints *  points, vtkDataArray *  normals, vtkDataArray *  tcoords, vtkUnsignedCharArray *  colors, vtkX3DExporterWriter *  writer, int  index  )

protected

void vtkX3DExporter::WriteATextActor2D ( vtkActor2D *  anTextActor2D, vtkX3DExporterWriter *  writer  )

protected

void vtkX3DExporter::WriteATexture ( vtkActor *  anActor, vtkX3DExporterWriter *  writer  )

protected

void vtkX3DExporter::WriteAnAppearance ( vtkActor *  anActor, bool  writeEmissiveColor, vtkX3DExporterWriter *  writer  )

protected

int vtkX3DExporter::HasHeadLight ( vtkRenderer *  ren )

protected

Member Data Documentation

int vtkX3DExporter::WriteToOutputString

protected

Definition at line 106 of file vtkX3DExporter.h.

char* vtkX3DExporter::OutputString

protected

Definition at line 107 of file vtkX3DExporter.h.

int vtkX3DExporter::OutputStringLength

protected

Definition at line 108 of file vtkX3DExporter.h.

char* vtkX3DExporter::FileName

protected

Definition at line 124 of file vtkX3DExporter.h.

double vtkX3DExporter::Speed

protected

Definition at line 125 of file vtkX3DExporter.h.

int vtkX3DExporter::Binary

protected

Definition at line 126 of file vtkX3DExporter.h.

int vtkX3DExporter::Fastest

protected

Definition at line 127 of file vtkX3DExporter.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/vtkX3DExporter.h