VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkX3DExporter Class Reference

create an x3d file More...

#include <vtkX3DExporter.h>

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

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. More...
 
vtkX3DExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFileName (const char *)
 Set/Get the output file name. More...
 
virtual char * GetFileName ()
 
virtual void SetSpeed (double)
 Specify the Speed of navigation. More...
 
virtual double GetSpeed ()
 
virtual void SetBinary (vtkTypeBool)
 Turn on binary mode. More...
 
virtual void BinaryOn ()
 
virtual void BinaryOff ()
 
virtual vtkTypeBool GetBinary ()
 
virtual void SetFastest (vtkTypeBool)
 In binary mode use fastest instead of best compression. More...
 
virtual void FastestOn ()
 
virtual void FastestOff ()
 
virtual vtkTypeBool GetFastest ()
 
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...
 
- Public Member Functions inherited from vtkExporter
vtkExporterNewInstance () const
 
virtual void Write ()
 Write data to output. More...
 
void Update ()
 Convenient alias for Write() method. More...
 
virtual void SetRenderWindow (vtkRenderWindow *)
 Set/Get the rendering window that contains the scene to be written. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 
virtual void SetActiveRenderer (vtkRenderer *)
 Set/Get the renderer that contains actors to be written. More...
 
virtual vtkRendererGetActiveRenderer ()
 
void SetInput (vtkRenderWindow *renWin)
 These methods are provided for backward compatibility. More...
 
vtkRenderWindowGetInput ()
 
void SetStartWrite (void(*f)(void *), void *arg)
 Specify a function to be called before data is written. More...
 
void SetEndWrite (void(*f)(void *), void *arg)
 Specify a function to be called after data is written. More...
 
void SetStartWriteArgDelete (void(*f)(void *))
 Set the arg delete method. More...
 
void SetEndWriteArgDelete (void(*f)(void *))
 Set the arg delete method. More...
 
vtkMTimeType GetMTime () override
 Returns the MTime also considering the RenderWindow. 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...
 
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 vtkX3DExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkX3DExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkExporter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExporterSafeDownCast (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
 
 vtkX3DExporter ()
 
 ~vtkX3DExporter () override
 
void WriteData () override
 Write data to output. More...
 
void WriteALight (vtkLight *aLight, vtkX3DExporterWriter *writer)
 
void WriteAnActor (vtkActor *anActor, vtkX3DExporterWriter *writer, int index)
 
void WriteAPiece (vtkPolyData *piece, 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)
 
virtual void WriteAdditionalNodes (vtkX3DExporterWriter *vtkNotUsed(writer))
 
int HasHeadLight (vtkRenderer *ren)
 
- Protected Member Functions inherited from vtkExporter
 vtkExporter ()
 
 ~vtkExporter () 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

vtkTypeBool WriteToOutputString
 
char * OutputString
 
vtkIdType OutputStringLength
 
char * FileName
 
double Speed
 
vtkTypeBool Binary
 
vtkTypeBool Fastest
 
- Protected Attributes inherited from vtkExporter
vtkRenderWindowRenderWindow
 
vtkRendererActiveRenderer
 
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
std::atomic< int32_t > 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 46 of file vtkX3DExporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkX3DExporter.h.

Constructor & Destructor Documentation

◆ vtkX3DExporter()

vtkX3DExporter::vtkX3DExporter ( )
protected

◆ ~vtkX3DExporter()

vtkX3DExporter::~vtkX3DExporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkX3DExporter* vtkX3DExporter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkX3DExporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExporter.

◆ NewInstance()

vtkX3DExporter* vtkX3DExporter::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetFileName()

virtual void vtkX3DExporter::SetFileName ( const char *  )
virtual

Set/Get the output file name.

◆ GetFileName()

virtual char* vtkX3DExporter::GetFileName ( )
virtual

◆ SetSpeed()

virtual void vtkX3DExporter::SetSpeed ( double  )
virtual

Specify the Speed of navigation.

Default is 4.

◆ GetSpeed()

virtual double vtkX3DExporter::GetSpeed ( )
virtual

◆ SetBinary()

virtual void vtkX3DExporter::SetBinary ( vtkTypeBool  )
virtual

Turn on binary mode.

◆ BinaryOn()

virtual void vtkX3DExporter::BinaryOn ( )
virtual

◆ BinaryOff()

virtual void vtkX3DExporter::BinaryOff ( )
virtual

◆ GetBinary()

virtual vtkTypeBool vtkX3DExporter::GetBinary ( )
virtual

◆ SetFastest()

virtual void vtkX3DExporter::SetFastest ( vtkTypeBool  )
virtual

In binary mode use fastest instead of best compression.

◆ FastestOn()

virtual void vtkX3DExporter::FastestOn ( )
virtual

◆ FastestOff()

virtual void vtkX3DExporter::FastestOff ( )
virtual

◆ GetFastest()

virtual vtkTypeBool vtkX3DExporter::GetFastest ( )
virtual

◆ SetWriteToOutputString()

virtual void vtkX3DExporter::SetWriteToOutputString ( vtkTypeBool  )
virtual

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

◆ GetWriteToOutputString()

virtual vtkTypeBool vtkX3DExporter::GetWriteToOutputString ( )
virtual

◆ WriteToOutputStringOn()

virtual void vtkX3DExporter::WriteToOutputStringOn ( )
virtual

◆ WriteToOutputStringOff()

virtual void vtkX3DExporter::WriteToOutputStringOff ( )
virtual

◆ GetOutputStringLength()

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

◆ GetOutputString()

virtual char* vtkX3DExporter::GetOutputString ( )
virtual

◆ GetBinaryOutputString()

unsigned char* vtkX3DExporter::GetBinaryOutputString ( )
inline

Definition at line 104 of file vtkX3DExporter.h.

◆ RegisterAndGetOutputString()

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

◆ WriteData()

void vtkX3DExporter::WriteData ( )
overrideprotectedvirtual

Write data to output.

Implements vtkExporter.

◆ WriteALight()

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

◆ WriteAnActor()

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

◆ WriteAPiece()

void vtkX3DExporter::WriteAPiece ( vtkPolyData piece,
vtkActor anActor,
vtkX3DExporterWriter writer,
int  index 
)
protected

◆ WritePointData()

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

◆ WriteATextActor2D()

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

◆ WriteATexture()

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

◆ WriteAnAppearance()

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

◆ WriteAdditionalNodes()

virtual void vtkX3DExporter::WriteAdditionalNodes ( vtkX3DExporterWriter vtkNotUsedwriter)
inlineprotectedvirtual

Definition at line 145 of file vtkX3DExporter.h.

◆ HasHeadLight()

int vtkX3DExporter::HasHeadLight ( vtkRenderer ren)
protected

Member Data Documentation

◆ WriteToOutputString

vtkTypeBool vtkX3DExporter::WriteToOutputString
protected

Definition at line 122 of file vtkX3DExporter.h.

◆ OutputString

char* vtkX3DExporter::OutputString
protected

Definition at line 123 of file vtkX3DExporter.h.

◆ OutputStringLength

vtkIdType vtkX3DExporter::OutputStringLength
protected

Definition at line 124 of file vtkX3DExporter.h.

◆ FileName

char* vtkX3DExporter::FileName
protected

Definition at line 149 of file vtkX3DExporter.h.

◆ Speed

double vtkX3DExporter::Speed
protected

Definition at line 150 of file vtkX3DExporter.h.

◆ Binary

vtkTypeBool vtkX3DExporter::Binary
protected

Definition at line 151 of file vtkX3DExporter.h.

◆ Fastest

vtkTypeBool vtkX3DExporter::Fastest
protected

Definition at line 152 of file vtkX3DExporter.h.


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