Getting a scene out of a view, as an image or as geometry.
vtkScivisExporter is the part of a view that writes what it is showing to a file, reached as vtkScivisView::GetExporter(). Two things come out of a scene: a picture of it, and the geometry in it.
view->GetExporter()->SaveScreenshot("frame.png");
view->GetExporter()->ExportScene("scene.gltf");
Both pick their format from the file extension, so choosing one is choosing a name. Images are written as .png, .jpg, .tif or .bmp; geometry as .gltf, .obj, .vrml or .x3d.
- How a capture comes out:
- Magnification and TransparentBackground describe every capture this exporter makes rather than being repeated at each call, so an application that wants everything at twice the window size says so once. CaptureImage() hands back the picture instead of writing it, for an application that has somewhere else to put it.
- What it does to the view:
- The scene is brought up to date and drawn before anything is written, so what comes out is what is on screen. A transparent capture has to turn the background off to take it, and puts back what was there afterwards, so the view looks the same before and after.
- See also
- vtkScivisView vtkWindowToImageFilter
- Tests:
- vtkScivisExporter (Tests)
Definition at line 52 of file vtkScivisExporter.h.
|
| virtual vtkTypeBool | IsA (const char *type) |
| | Return 1 if this class is the same type of (or a subclass of) the named class.
|
| vtkScivisExporter * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| bool | SaveScreenshot (const char *filename) |
| | Write a picture of the scene, as .png, .jpg, .tif or .bmp.
|
| vtkSmartPointer< vtkImageData > | CaptureImage () |
| | The same picture, handed back rather than written.
|
| bool | ExportScene (const char *filename) |
| | Write the geometry in the scene, as .gltf, .obj, .vrml/.wrl or .x3d.
|
| virtual void | SetMagnification (int) |
| | How much larger than the render window a capture comes out, so 2 gives an image twice the width and height.
|
| virtual int | GetMagnification () |
| | How much larger than the render window a capture comes out, so 2 gives an image twice the width and height.
|
| virtual void | SetTransparentBackground (bool) |
| | Whether a capture has a transparent background rather than the view's.
|
| virtual bool | GetTransparentBackground () |
| | Whether a capture has a transparent background rather than the view's.
|
| virtual void | TransparentBackgroundOn () |
| | Whether a capture has a transparent background rather than the view's.
|
| virtual void | TransparentBackgroundOff () |
| | Whether a capture has a transparent background rather than the view's.
|
| | 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 | 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.
|
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| 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 vtkScivisExporter * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkScivisExporter * | SafeDownCast (vtkObjectBase *o) |
| 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 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.
|
1.16.1