vtkColorPalette.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * $Id$
 *
 * Copyright (c) 2004 Sean McInerney
 * All rights reserved.
 *
 * See Copyright.txt or http://vtkextensions.sourceforge.net/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.
 *
 */
#ifndef VTK_COLOR_PALETTE_H_
#  define VTK_COLOR_PALETTE_H_
#  include "vtkPalette.h"

VTK_EXTENSIONS_PALETTE_NAMESPACE_BEGIN

class vtkColorPaletteInternal;

class VTK_EXTENSIONS_PALETTE_EXPORT vtkColorPalette
  : public vtkPalette
{
public:
  static vtkColorPalette* New (void);
  vtkTypeRevisionMacro (vtkColorPalette, vtkPalette);

  vtkIdType   GetNumberOfChildColors (void) const;

  virtual bool  InsertMaterial (const char* /*const&*/      name,
                                vtkMaterial /*const&*/      material);

  virtual bool  FindMaterial (const char* /*const&*/        name,
                              vtkMaterial      &        material);

  virtual bool  RemoveMaterial (const char* /*const&*/      name);
  bool          InsertColor (const char*  /*const&*/        name,
                             vtkColorWord /*const&*/        rgba);

  bool          FindColor (const char* /*const&*/           name,
                           vtkColorWord&                rgba);

  bool          RemoveColor (const char* /*const&*/         name);
  virtual bool  FindName (vtkPalette* /*const&*/    palette,
                          const char*      &    name) {return false;}

  virtual bool  FindName (vtkMaterial /*const&*/    material,
                          const char*      &    name) {return false;}

  virtual bool  FindName (vtkColorWord /*const&*/   rgba,
                          const char*       &   name) {return false;}

  virtual bool  FindNextName (const char* &     name) {return false;}
  virtual void  InitTraversal (const char* /*const&*/       name = NULL) {}

  virtual bool  TraverseForward (const char* &          name,
                                 vtkPalette  &          palette)
    {return false;}

  virtual bool  TraverseForward (const char* &          name,
                                 vtkMaterial &          material)
    {return false;}

  virtual bool  TraverseForward (const char* &          name,
                                 vtkColorWord&          rgba)
    {return false;}

  void          InitColorScope (void);
  bool          IncrementColorInScope (const char*  & name,
                                       vtkColorWord & color);
  bool          DecrementColorInScope (const char*  & name,
                                       vtkColorWord & color);
  bool          CurrentColorInScope (const char*  & name,
                                     vtkColorWord & color) const;
  void          InsertDefaultPalettes (bool /*const&*/ = false);

  void          InsertDefaultMaterials (bool /*const&*/ = false);

  void          InsertDefaultColors (bool /*const&*/ revert = false);
  //BTX
  void          PrintColor (ostream&            target,
                            vtkIndent           indent,
                            const char*  const& name,
                            vtkColorWord const& color);
  //ETX

protected:
  vtkColorPalette (void);
  ~vtkColorPalette();

  friend class vtkPaletteIterator;

private:
  vtkColorPaletteInternal*   Internal;

private:
  vtkColorPalette (const vtkColorPalette&);
  void operator= (const vtkColorPalette&);
};

VTK_EXTENSIONS_PALETTE_NAMESPACE_END

#endif /* VTK_PALETTE_H_ */
/* 
 * End of: $Id$.
 * 
 */

---