vtkKWParameterValueFunctionInterface.h

Go to the documentation of this file.

/*=========================================================================

  Module:    $RCSfile: vtkKWParameterValueFunctionInterface.h,v $

  Copyright (c) Kitware, Inc.
  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 __vtkKWParameterValueFunctionInterface_h
#define __vtkKWParameterValueFunctionInterface_h

#include "vtkKWWidgetWithLabel.h"

class KWWidgets_EXPORT vtkKWParameterValueFunctionInterface : public vtkKWWidgetWithLabel
{
// @cond section_public
public:
  vtkTypeRevisionMacro(vtkKWParameterValueFunctionInterface,vtkKWWidgetWithLabel);
  void PrintSelf(ostream& os, vtkIndent indent);

  virtual int HasFunction() = 0;

  virtual int GetFunctionSize() = 0;


  enum 
  {
    MaxFunctionPointDimensionality = 20
  };
  //ETX

  // *******************************************************************
  // The following methods are fast low-level manipulators: do *not* check if
  // points can added/removed or are locked, it is up to the higer-level
  // methods to do it (see vtkKWParameterValueFunctionEditor for example,
  // AddFunctionPointAtParameter() will use the low-level
  // FunctionPointCanBeRemoved() and RemoveFunctionPoint() below).
  // Points are usually accessed by 'id', which is pretty much its rank
  // in the function (i.e., the 0-th point is the first point and has id = 0,
  // the next point has id = 1, etc., up to GetFunctionSize() - 1)
  // *******************************************************************

  virtual unsigned long GetFunctionMTime() = 0;

  virtual int GetFunctionPointParameter(int id, double *parameter) = 0;

  virtual int GetFunctionPointDimensionality() = 0;

// @endcond
// @cond section_protected
protected:
  virtual int InterpolateFunctionPointValues(double parameter,double *values)=0;
  virtual int GetFunctionPointValues(int id, double *values) = 0;

  virtual int SetFunctionPointValues(int id, const double *values) = 0;

  // Add a 'n-tuple' value at a given 'parameter' over the parameter range 
  // (where 'n' is the dimensionality of the point), and return the 
  // corresponding point 'id' (the rank of the newly added point in the
  // function).
  // Return 1 on success, 0 otherwise
  virtual int AddFunctionPoint(double parameter,const double *values,int *id)=0;
  virtual int SetFunctionPoint(int id, double parameter, const double *values)=0;

  virtual int RemoveFunctionPoint(int id) = 0;

  // *******************************************************************
  // The following low-level methods can be reimplemented, but a default 
  // implementation is provided either by this class or by 
  // vtkKWParameterValueFunctionEditor and is working just fine.
  // If you have to reimplement them (for efficiency reasons for example), 
  // make sure to call the corresponding superclass method too
  // (or have a good reason not to :). 
  // Those methods are used by high-level methods, and should 
  // not be called from the other low-level methods described above 
  // (see vtkKWParameterValueFunctionEditor for example, the high-level
  // AddFunctionPointAtParameter() method will use the low-level
  // below FunctionPointCanBeRemoved() and above RemoveFunctionPoint()).
  // *******************************************************************

// @endcond
// @cond section_public
public:
  virtual int GetFunctionPointId(double parameter, int *id);

  virtual int FunctionPointCanBeAdded() = 0;

  virtual int FunctionPointCanBeRemoved(int id) = 0;

  virtual int FunctionPointParameterIsLocked(int id) = 0;

  virtual int FunctionPointValueIsLocked(int id) = 0;

  virtual int FunctionPointCanBeMovedToParameter(int id, double parameter) = 0;

// @endcond
// @cond section_protected
protected:
  vtkKWParameterValueFunctionInterface() {};
  ~vtkKWParameterValueFunctionInterface() {};

  virtual void CreateWidget();

  virtual int FunctionLineIsSampledBetweenPoints(int id1, int id2);

// @endcond
// @cond section_private
private:
  vtkKWParameterValueFunctionInterface(const vtkKWParameterValueFunctionInterface&); // Not implemented
  void operator=(const vtkKWParameterValueFunctionInterface&); // Not implemented
};

#endif
// @endcond

---