Files
ThirdParty-6/ParaView-5.0.1/ParaViewCore/ServerManager/Rendering/vtkSMUtilities.h

95 lines
3.6 KiB
C++

/*=========================================================================
Program: ParaView
Module: vtkSMUtilities.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkSMUtilities - collection of utility methods.
// .SECTION Description
// vtkSMUtilities defines a collection of useful static methods.
#ifndef vtkSMUtilities_h
#define vtkSMUtilities_h
#include "vtkPVServerManagerRenderingModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkImageData;
class vtkPoints;
class VTKPVSERVERMANAGERRENDERING_EXPORT vtkSMUtilities : public vtkSMObject
{
public:
static vtkSMUtilities* New();
vtkTypeMacro(vtkSMUtilities, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Save the image to a file.
// The file is created on the process on which this method is called.
// Return vtkErrorCode::NoError (0) on success, otherwise returns the error
// code.
/// quality [0,100] -- 0 = low, 100=high, -1=default
static int SaveImage(vtkImageData* image, const char* filename,
int quality);
static int SaveImage(vtkImageData* image, const char* filename)
{ return vtkSMUtilities::SaveImage(image, filename, -1); }
// Description:
// Save the image to a file using a vtkImageWriter subclass given by writerName.
// The file is created on the process on which this method is called.
static int SaveImage(vtkImageData* image, const char* filename,
const char* writerName);
// Description:
// Calls SaveImage(image, filename, writerName) only on process 0.
// Other processes will recieve the return code through a broadcast.
static int SaveImageOnProcessZero(vtkImageData* image,
const char* filename, const char* writerName);
// Description:
// Returns the points an orbit to revolve around the \c center at a distance
// of \c radius in the plane defined by the \c center and the \c normal. The
// number of points returned is equal to \c resolution.
// Returns a new instance of vtkPoints. The caller is responsible for freeing
// the allocated memory.
static vtkPoints* CreateOrbit(const double center[3], const double normal[3],
int resolution, const double startPoint[3]);
// Will pick an arbitrary starting point
static vtkPoints* CreateOrbit(const double center[3], const double normal[3],
double radius, int resolution);
// Description:
// Convenience method used to merge a smaller image (\c src) into a
// larger one (\c dest). The location of the smaller image in the larger image
// are determined by their extents.
static void Merge(vtkImageData* dest, vtkImageData* src,
int borderWidth=0, const unsigned char* borderColorRGB=NULL);
// Description:
// Fill the specified extents in the image with the given color.
// If the image is a 4 component image, then this method fills the 4th
// component with 0xff.
static void FillImage(vtkImageData* image, const int extent[6], const unsigned char rgb[3]);
//BTX
protected:
vtkSMUtilities() {}
~vtkSMUtilities(){}
private:
vtkSMUtilities(const vtkSMUtilities&); // Not implemented
void operator=(const vtkSMUtilities&); // Not implemented
//ETX
};
#endif