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

vtkWebGLExporter export the data of the scene to be used in the WebGL. More...

#include <vtkWebGLExporter.h>

Inheritance diagram for vtkWebGLExporter:
[legend]
Collaboration diagram for vtkWebGLExporter:
[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.
 
vtkWebGLExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void parseScene (vtkRendererCollection *renderers, const char *viewId, int parseType)
 Get all the needed information from the vtkRenderer.
 
void exportStaticScene (vtkRendererCollection *renderers, int width, int height, std::string path)
 Get all the needed information from the vtkRenderer.
 
const char * GenerateMetadata ()
 Get all the needed information from the vtkRenderer.
 
const char * GetId ()
 Get all the needed information from the vtkRenderer.
 
vtkWebGLObjectGetWebGLObject (int index)
 Get all the needed information from the vtkRenderer.
 
int GetNumberOfObjects ()
 Get all the needed information from the vtkRenderer.
 
bool hasChanged ()
 Get all the needed information from the vtkRenderer.
 
void SetCenterOfRotation (float a1, float a2, float a3)
 Get all the needed information from the vtkRenderer.
 
void SetMaxAllowedSize (int mesh, int lines)
 Get all the needed information from the vtkRenderer.
 
void SetMaxAllowedSize (int size)
 Get all the needed information from the vtkRenderer.
 
- 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.
 
vtkCommandGetCommand (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 vtkWebGLExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGLExporterSafeDownCast (vtkObjectBase *o)
 
static void ComputeMD5 (const unsigned char *content, int size, std::string &hash)
 
- 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkWebGLExporter ()
 
 ~vtkWebGLExporter () override
 
void parseRenderer (vtkRenderer *render, const char *viewId, bool onlyWidget, void *mapTime)
 
void generateRendererData (vtkRendererCollection *renderers, const char *viewId)
 
void parseActor (vtkActor *actor, vtkMTimeType actorTime, size_t rendererId, int layer, bool isWidget)
 
void parseActor2D (vtkActor2D *actor, vtkMTimeType actorTime, size_t renderId, int layer, bool isWidget)
 
const char * GenerateExportMetadata ()
 
vtkTriangleFilterGetPolyData (vtkMapper *mapper, vtkMTimeType &dataMTime)
 
- 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

vtkTriangleFilterTriangleFilter
 
double CameraLookAt [10]
 
bool GradientBackground
 
double Background1 [3]
 
double Background2 [3]
 
double SceneSize [3]
 
std::string SceneId
 
float CenterOfRotation [3]
 
int meshObjMaxSize
 
int lineObjMaxSize
 
std::string renderersMetaData
 
bool hasWidget
 
- 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

vtkWebGLExporter export the data of the scene to be used in the WebGL.

Definition at line 39 of file vtkWebGLExporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkWebGLExporter.h.

Constructor & Destructor Documentation

◆ vtkWebGLExporter()

vtkWebGLExporter::vtkWebGLExporter ( )
protected

◆ ~vtkWebGLExporter()

vtkWebGLExporter::~vtkWebGLExporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWebGLExporter * vtkWebGLExporter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGLExporter::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkWebGLExporter * vtkWebGLExporter::NewInstance ( ) const

◆ PrintSelf()

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

◆ parseScene()

void vtkWebGLExporter::parseScene ( vtkRendererCollection renderers,
const char *  viewId,
int  parseType 
)

Get all the needed information from the vtkRenderer.

◆ exportStaticScene()

void vtkWebGLExporter::exportStaticScene ( vtkRendererCollection renderers,
int  width,
int  height,
std::string  path 
)

Get all the needed information from the vtkRenderer.

◆ GenerateMetadata()

const char * vtkWebGLExporter::GenerateMetadata ( )

Get all the needed information from the vtkRenderer.

◆ GetId()

const char * vtkWebGLExporter::GetId ( )

Get all the needed information from the vtkRenderer.

◆ GetWebGLObject()

vtkWebGLObject * vtkWebGLExporter::GetWebGLObject ( int  index)

Get all the needed information from the vtkRenderer.

◆ GetNumberOfObjects()

int vtkWebGLExporter::GetNumberOfObjects ( )

Get all the needed information from the vtkRenderer.

◆ hasChanged()

bool vtkWebGLExporter::hasChanged ( )

Get all the needed information from the vtkRenderer.

◆ SetCenterOfRotation()

void vtkWebGLExporter::SetCenterOfRotation ( float  a1,
float  a2,
float  a3 
)

Get all the needed information from the vtkRenderer.

◆ SetMaxAllowedSize() [1/2]

void vtkWebGLExporter::SetMaxAllowedSize ( int  mesh,
int  lines 
)

Get all the needed information from the vtkRenderer.

◆ SetMaxAllowedSize() [2/2]

void vtkWebGLExporter::SetMaxAllowedSize ( int  size)

Get all the needed information from the vtkRenderer.

◆ ComputeMD5()

static void vtkWebGLExporter::ComputeMD5 ( const unsigned char *  content,
int  size,
std::string &  hash 
)
static

◆ parseRenderer()

void vtkWebGLExporter::parseRenderer ( vtkRenderer render,
const char *  viewId,
bool  onlyWidget,
void *  mapTime 
)
protected

◆ generateRendererData()

void vtkWebGLExporter::generateRendererData ( vtkRendererCollection renderers,
const char *  viewId 
)
protected

◆ parseActor()

void vtkWebGLExporter::parseActor ( vtkActor actor,
vtkMTimeType  actorTime,
size_t  rendererId,
int  layer,
bool  isWidget 
)
protected

◆ parseActor2D()

void vtkWebGLExporter::parseActor2D ( vtkActor2D actor,
vtkMTimeType  actorTime,
size_t  renderId,
int  layer,
bool  isWidget 
)
protected

◆ GenerateExportMetadata()

const char * vtkWebGLExporter::GenerateExportMetadata ( )
protected

◆ GetPolyData()

vtkTriangleFilter * vtkWebGLExporter::GetPolyData ( vtkMapper mapper,
vtkMTimeType dataMTime 
)
protected

Member Data Documentation

◆ TriangleFilter

vtkTriangleFilter* vtkWebGLExporter::TriangleFilter
protected

Definition at line 80 of file vtkWebGLExporter.h.

◆ CameraLookAt

double vtkWebGLExporter::CameraLookAt[10]
protected

Definition at line 81 of file vtkWebGLExporter.h.

◆ GradientBackground

bool vtkWebGLExporter::GradientBackground
protected

Definition at line 82 of file vtkWebGLExporter.h.

◆ Background1

double vtkWebGLExporter::Background1[3]
protected

Definition at line 83 of file vtkWebGLExporter.h.

◆ Background2

double vtkWebGLExporter::Background2[3]
protected

Definition at line 84 of file vtkWebGLExporter.h.

◆ SceneSize

double vtkWebGLExporter::SceneSize[3]
protected

Definition at line 85 of file vtkWebGLExporter.h.

◆ SceneId

std::string vtkWebGLExporter::SceneId
protected

Definition at line 86 of file vtkWebGLExporter.h.

◆ CenterOfRotation

float vtkWebGLExporter::CenterOfRotation[3]
protected

Definition at line 87 of file vtkWebGLExporter.h.

◆ meshObjMaxSize

int vtkWebGLExporter::meshObjMaxSize
protected

Definition at line 88 of file vtkWebGLExporter.h.

◆ lineObjMaxSize

int vtkWebGLExporter::lineObjMaxSize
protected

Definition at line 88 of file vtkWebGLExporter.h.

◆ renderersMetaData

std::string vtkWebGLExporter::renderersMetaData
protected

Definition at line 89 of file vtkWebGLExporter.h.

◆ hasWidget

bool vtkWebGLExporter::hasWidget
protected

Definition at line 90 of file vtkWebGLExporter.h.


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