vtkPiecewiseFunction.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkPiecewiseFunction.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
 
=========================================================================*/
 
#ifndef vtkPiecewiseFunction_h
#define vtkPiecewiseFunction_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
 
class vtkPiecewiseFunctionInternals;
 
class VTKCOMMONDATAMODEL_EXPORT vtkPiecewiseFunction : public vtkDataObject
{
public:
  static vtkPiecewiseFunction *New();
  vtkTypeMacro(vtkPiecewiseFunction,vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  void DeepCopy( vtkDataObject *f );
  void ShallowCopy( vtkDataObject *f );
 
  int GetDataObjectType() {return VTK_PIECEWISE_FUNCTION;};
 
  int  GetSize();
 
 
  int AddPoint( double x, double y );
  int AddPoint( double x, double y, double midpoint, double sharpness );
  int RemovePoint( double x );
 
  void RemoveAllPoints();
 
  void AddSegment( double x1, double y1, double x2, double y2 );
 
  double GetValue( double x );
 
 
  int GetNodeValue( int index, double val[4] );
  int SetNodeValue( int index, double val[4] );
 
 
  double *GetDataPointer();
  void FillFromDataPointer(int, double*);
 
 
  vtkGetVector2Macro( Range, double );
 
  int AdjustRange(double range[2]);
 
 
  void GetTable( double x1, double x2, int size, float *table, int stride=1 );
  void GetTable( double x1, double x2, int size, double *table, int stride=1 );
 
 
  void BuildFunctionFromTable( double x1, double x2, int size,
                               double *table, int stride=1 );
 
 
  vtkSetMacro( Clamping, int );
  vtkGetMacro( Clamping, int );
  vtkBooleanMacro( Clamping, int );
 
  const char  *GetType();
 
  double GetFirstNonZeroValue();
 
  void Initialize();
 
  //BTX
 
  static vtkPiecewiseFunction* GetData(vtkInformation* info);
  static vtkPiecewiseFunction* GetData(vtkInformationVector* v, int i=0);
  //ETX
 
 
  vtkSetMacro(AllowDuplicateScalars, int);
  vtkGetMacro(AllowDuplicateScalars, int);
  vtkBooleanMacro(AllowDuplicateScalars, int);
 
protected:
  vtkPiecewiseFunction();
  ~vtkPiecewiseFunction();
 
  // The internal STL structures
  vtkPiecewiseFunctionInternals *Internal;
 
  // Determines the function value outside of defined points
  // Zero = always return 0.0 outside of defined points
  // One  = clamp to the lowest value below defined points and
  //        highest value above defined points
  int   Clamping;
 
  // Array of points ((X,Y) pairs)
  double *Function;
 
  // Min and max range of function point locations
  double Range[2];
 
  // Internal method to sort the vector and update the
  // Range whenever a node is added, edited or removed.
  // It always calls Modified().
  void SortAndUpdateRange();
  // Returns true if the range has been updated and Modified() has been called
  bool UpdateRange();
 
  int AllowDuplicateScalars;
 
private:
  vtkPiecewiseFunction(const vtkPiecewiseFunction&);  // Not implemented.
  void operator=(const vtkPiecewiseFunction&);  // Not implemented.
};
 
#endif