Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

vtkPalette Class Reference

#include <vtkPalette.h>

Inheritance diagram for vtkPalette:

Inheritance graph
[legend]
Collaboration diagram for vtkPalette:

Collaboration graph
[legend]
List of all members.

Detailed Description

An associative array of color materials.

vtkPalette provides an interface to an associative array of color materials.

Author:
Sean McInerney
Version:
Revision
1.2
Date:
Date
2004/06/12 20:01:23

Definition at line 39 of file vtkPalette.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkPalette, vtkPaletteElement)
void PrintSelf (ostream &, vtkIndent)
int GetType (void) const
 Get an enumeration of the element type.

const vtkXMLChType * GetTagName (void) const
 Get the XML tag name for marshalling / unmarshalling.

const vtkXMLChType * GetFullName (void)
 Get the full name for this palette.

virtual vtkPalette * GetParent (void) const
 Get the parent palette of this palette.

int IsRoot (void) const
 Is this palette element a root node (i.e.

int IsLeaf (void) const
 Is this palette element a leaf node (i.e.

int IsEmpty (void) const
 Returns true if the palette is empty.

vtkIdType GetSize (void) const
 Returns the total number of elements in the palette including children.

vtkIdType GetCapacity (void) const
 Returns the total number of elements that can be held by this object.

virtual vtkPaletteElementHashMap * GetElements ()
 Get a pointer to the internal elements map instance.

vtkPaletteElement * Find (const char *name) const
 Find an element associated with a name as a child of this object.

vtkPaletteElement * FindInScope (const char *name) const
 Find an element associated with a scoped name in the map.

const char * StringToColor (const char *name, double &red, double &green, double &blue, double &alpha)
 Gets the RGBA component bytes of the color and returns a pointer to the text following these values if the parsing was finished.

 vtkGetXMLStringMacro (VersionAttr, vtkXMLChType)
 Get/Set the id attribute of this palette element.

 vtkSetXMLStringMacro (VersionAttr, vtkXMLChType)
 Get/Set the id attribute of this palette element.

Local Object Search Methods
int Find (const char *name, vtkPalette *&element)
 Find an element associated with a name in the map.

int Find (const char *name, vtkPaletteColor *&element)
 Find an element associated with a name in the map.

int Find (const char *name, vtkPaletteMaterial *&element)
 Find an element associated with a name in the map.

int Find (const char *name, vtkAbstractPaletteMaterial *&element)
 Find an element associated with a name in the map.

Scoped Object Search Methods
int FindInScope (const char *name, vtkPalette *&element)
 Find an element associated with a scoped name in the map.

int FindInScope (const char *name, vtkPaletteColor *&element)
 Find an element associated with a scoped name in the map.

int FindInScope (const char *name, vtkPaletteMaterial *&element)
 Find an element associated with a scoped name in the map.

int FindInScope (const char *name, vtkAbstractPaletteMaterial *&element)
 Find an element associated with a scoped name in the map.

Local Object Insertion Methods
int Insert (vtkPaletteElement *element)
 Add an element to the map.

Local Object Creation+Insertion Methods
int Insert (const char *name, vtkPalette *element)
 Create and add an object associated with a name to the map.

int Insert (const char *name, vtkPaletteColor *element)
 Create and add an object associated with a name to the map.

int Insert (const char *name, vtkPaletteMaterial *element)
 Create and add an object associated with a name to the map.

Scoped Object Insertion Methods
int InsertInScope (const char *name, vtkPaletteElement *element)
 Add an element associated with a name to the map.

Scoped Object Creation+Insertion Methods
int InsertInScope (const char *name, vtkPalette *element)
 Create and add an object associated with a name to the map.

int InsertInScope (const char *name, vtkPaletteColor *element)
 Create and add an object associated with a name to the map.

int InsertInScope (const char *name, vtkPaletteMaterial *element)
 Create and add an object associated with a name to the map.

General Type Map Methods
int Erase (const char *name)
 Erase an element associated with a name from this object's map.

int EraseInScope (const char *name)
 Erase an element associated with a scoped name from a map.

Color and Material Data Creation Insertion Methods
int InsertColor (const char *name, const double c0, const double c1, const double c2, const double alpha, vtkPaletteColor *object)
 Add a name associated with RGBA component floats to the map.

int InsertColor (const char *name, const double c0, const double c1, const double c2, const double alpha)
 Add a name associated with RGBA component floats to the map.

int InsertColor (const char *name, const double c0, const double c1, const double c2)
 Add a name associated with RGB component floats to the map.

int InsertColor (const char *name, const double color[4])
 Add a name associated with an RGBA float array to the map.

int InsertColor (const char *name, const unsigned char c0, const unsigned char c1, const unsigned char c2, const unsigned char alpha)
 Add a name associated with RGBA component bytes to the map.

int InsertColor (const char *name, const unsigned char c0, const unsigned char c1, const unsigned char c2)
 Add a name associated with RGB component bytes to the map.

int InsertColor (const char *name, const unsigned char color[4])
 Add a name associated with an RGBA byte array to the map.

int InsertColor (const char *name, const vtkColorWord rgba)
 Add a name associated with a packed RGBA word to the map.

int InsertMaterial (const char *name, const vtkMaterial material, vtkPaletteMaterial *object)
 Add an associated name - material pair to the map.

int InsertMaterial (const char *name, const vtkMaterial material)
 Add an associated name - material pair to the map.

Color and Material Data Search Methods
int FindColor (const char *name, double &c0, double &c1, double &c2, double &alpha)
 Find color data associated with the given name.

int FindColor (const char *name, double &c0, double &c1, double &c2)
 Find color data associated with the given name.

int FindColor (const char *name, double color[4])
 Find color data associated with the given name.

int FindColor (const char *name, vtkColorWord &rgba)
 Given a name, find an associated packed RGBA word in the map.

int FindColor (const char *name, unsigned char &c0, unsigned char &c1, unsigned char &c2, unsigned char &alpha)
 Given a name, find associated RGBA component bytes in the map.

int FindColor (const char *name, unsigned char &c0, unsigned char &c1, unsigned char &c2)
 Given a name, find associated RGB component bytes in the map.

int FindColor (const char *name, unsigned char color[4])
 Given a name, find an associated RGBA byte array in the map.

int FindMaterial (const char *name, vtkMaterial &material)
 Find material data associated with the given name.

Traversal Methods
int InitTraversal (void)
 Initialize traversal through the elements.

is \c NULL or
Initialize traversal through the elements.empty, traversal starts at the first pair in the map.

Parameters:
name The name of the element at which the traversal iterator will be positioned. If


int InitTraversal (const char *name)
int GetNextElement (const char *&name, vtkPaletteElement *&element)
 Get the current name - element association in the map and iterate forward to the next pair.

int GetCurrentElement (const char *&name, vtkPaletteElement *&element) const
 Get the current name - element association in the map.

int GetFirstElement (const char *&name, vtkPaletteElement *&element)
 Get the first name - element association in the map.

int GetLastElement (const char *&name, vtkPaletteElement *&element)
 Get the last name - element association in the map.

int GetNextPalette (const char *&name, vtkPalette *&palette)
 Get the current name - palette association in the map and iterate forward to the next palette pair.

int GetCurrentPalette (const char *&name, vtkPalette *&palette) const
 Get the current name - palette association in the map.

int GetNextColor (const char *&name, vtkPaletteColor *&color)
 Get the current name - color association in the map and iterate forward to the next color pair.

int GetCurrentColor (const char *&name, vtkPaletteColor *&color) const
 Get the current name - color association in the map.

int GetNextMaterial (const char *&name, vtkPaletteMaterial *&material)
 Get the current name - material association in the map and iterate forward to the next material pair.

int GetCurrentMaterial (const char *&name, vtkPaletteMaterial *&material) const
 Get the current name - material association in the map.

int GetNextAbstractMaterial (const char *&name, vtkAbstractPaletteMaterial *&material)
 Get the current name - material association in the map and iterate forward to the next material pair.

int GetCurrentAbstractMaterial (const char *&name, vtkAbstractPaletteMaterial *&material) const
 Get the current name - material association in the map.

Methods for Inserting Default Associations
virtual void InsertDefaultPalettes (int revert=VTK_FALSE)
 Insert default palette pairs into the map.

virtual void InsertDefaultMaterials (int revert=VTK_FALSE)
 Insert default material pairs into the map.

virtual void InsertDefaultColors (int revert=VTK_FALSE)
 Insert default color pairs into the map.

void InsertDefaults (int revert=VTK_FALSE)
 Insert all defaults into the maps.


Static Public Member Functions

vtkPalette * New (void)

Static Public Attributes

const char *const PalettePathsEnvVar
 Search path env.

const char *const PaletteFilesEnvVar
 Search filename env.

const vtkXMLChType *const paletteString
const vtkXMLChType *const createdString
const vtkXMLChType *const modifiedString
const vtkXMLChType *const versionString

Protected Member Functions

 vtkPalette (void)
 ~vtkPalette ()
virtual void SetParent (vtkPalette *a)
Output Marshalling Specializations
void MarshalAttributes (ostream &)
void MarshalContent (ostream &, vtkIndent)
 Print the all material pairs as a formatted string on the target output stream.

void UnmarshalAttribute (const vtkXMLChType *const &attr, const vtkXMLChType *const &value)
virtual void PrintMaterial (ostream &target, vtkIndent indent, const char *const &name, vtkMaterial const &material)
 Print the material data associated with name as a formatted string on the target output stream.

void PrintColor (ostream &target, vtkIndent indent, const char *const &name, vtkColorWord const &color)
 Print the color data associated with name as a formatted string on the target output stream.


Static Protected Member Functions

void BuildSearchLists (void)
void InitSearchPathsTraversal (const char *const &name=NULL)
int TraverseSearchPathsForward (const char *&name)
void InitSearchFilesTraversal (const char *const &name=NULL)
int TraverseSearchFilesForward (const char *&name)

Protected Attributes

vtkXMLChType * FullName
vtkXMLChType * CreatedAttr
vtkXMLChType * ModifiedAttr
vtkXMLChType * VersionAttr
vtkPaletteElementHashMap * Elements
vtkPaletteElementHashMapIterator * Iterator

Constructor & Destructor Documentation

vtkPalette::vtkPalette (  void   )  [protected]
 

vtkPalette::~vtkPalette (   )  [protected]
 

Member Function Documentation

void vtkPalette::BuildSearchLists (  void   )  [static, protected]
 

int vtkPalette::Erase (  const char *  name  )  [virtual]
 

Erase an element associated with a name from this object's map.

Parameters:
name The name of the element to be erased.
Returns:
true on success, false otherwise.

Reimplemented from vtkPaletteElement.

int vtkPalette::EraseInScope (  const char *  name  ) 
 

Erase an element associated with a scoped name from a map.

Parameters:
name The full path name of the element to be erased.
Returns:
true on success, false otherwise.

int vtkPalette::Find (  const char *  name,
vtkAbstractPaletteMaterial *&  element
) 
 

Find an element associated with a name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

int vtkPalette::Find (  const char *  name,
vtkPaletteMaterial *&  element
) 
 

Find an element associated with a name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

int vtkPalette::Find (  const char *  name,
vtkPaletteColor *&  element
) 
 

Find an element associated with a name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

int vtkPalette::Find (  const char *  name,
vtkPalette *&  element
) 
 

Find an element associated with a name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

vtkPaletteElement* vtkPalette::Find (  const char *  name  )  const [virtual]
 

Find an element associated with a name as a child of this object.

Parameters:
name The full path name of the element to be found.
Returns:
The element associated with the specified name if found or NULL if the name is removed, empty, or non-existant.

Reimplemented from vtkPaletteElement.

int vtkPalette::FindColor (  const char *  name,
unsigned char  color[4]
)  [inline]
 

Given a name, find an associated RGBA byte array in the map.

Returns:
true on success, false otherwise.

Definition at line 769 of file vtkPalette.h.

References FindColor().

int vtkPalette::FindColor (  const char *  name,
unsigned char &  c0,
unsigned char &  c1,
unsigned char &  c2
)  [inline]
 

Given a name, find associated RGB component bytes in the map.

Returns:
true on success, false otherwise.

Definition at line 759 of file vtkPalette.h.

References FindColor().

int vtkPalette::FindColor (  const char *  name,
unsigned char &  c0,
unsigned char &  c1,
unsigned char &  c2,
unsigned char &  alpha
)  [inline]
 

Given a name, find associated RGBA component bytes in the map.

Returns:
true on success, false otherwise.

Definition at line 741 of file vtkPalette.h.

References FindColor(), VTK_FALSE, VTK_TRUE, and vtkColorWord.

int vtkPalette::FindColor (  const char *  name,
vtkColorWord &  rgba
)  [inline]
 

Given a name, find an associated packed RGBA word in the map.

Returns:
true on success, false otherwise.

Reimplemented in vtkColorPalette.

Definition at line 726 of file vtkPalette.h.

References FindColor(), VTK_FALSE, VTK_TRUE, and vtkColorWord.

int vtkPalette::FindColor (  const char *  name,
double  color[4]
)  [inline]
 

Find color data associated with the given name.

Returns:
true on success, false otherwise.

Definition at line 719 of file vtkPalette.h.

References FindColor().

int vtkPalette::FindColor (  const char *  name,
double &  c0,
double &  c1,
double &  c2
)  [inline]
 

Find color data associated with the given name.

Returns:
true on success, false otherwise.

Definition at line 709 of file vtkPalette.h.

References FindColor().

int vtkPalette::FindColor (  const char *  name,
double &  c0,
double &  c1,
double &  c2,
double &  alpha
) 
 

Find color data associated with the given name.

Returns:
true on success, false otherwise.

Referenced by FindColor().

int vtkPalette::FindInScope (  const char *  name,
vtkAbstractPaletteMaterial *&  element
) 
 

Find an element associated with a scoped name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

int vtkPalette::FindInScope (  const char *  name,
vtkPaletteMaterial *&  element
) 
 

Find an element associated with a scoped name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

int vtkPalette::FindInScope (  const char *  name,
vtkPaletteColor *&  element
) 
 

Find an element associated with a scoped name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

int vtkPalette::FindInScope (  const char *  name,
vtkPalette *&  element
) 
 

Find an element associated with a scoped name in the map.

Parameters:
name The full path name of the element to be found.
element Holds a pointer to the element if found, otherwise NULL.
Returns:
true on success, false otherwise.

vtkPaletteElement* vtkPalette::FindInScope (  const char *  name  )  const
 

Find an element associated with a scoped name in the map.

Parameters:
name The full path name of the element to be found.
Returns:
The element associated with the specified name if found or null if the name is removed, empty, or non-existant.

int vtkPalette::FindMaterial (  const char *  name,
vtkMaterial &  material
) 
 

Find material data associated with the given name.

Returns:
true on success, false otherwise.

Reimplemented in vtkColorPalette.

vtkIdType vtkPalette::GetCapacity (  void   )  const [virtual]
 

Returns the total number of elements that can be held by this object.

Reimplemented from vtkPaletteElement.

int vtkPalette::GetCurrentAbstractMaterial (  const char *&  name,
vtkAbstractPaletteMaterial *&  material
)  const
 

Get the current name - material association in the map.

Returns:
false if either the map is empty, traversal has reached end of the map, or the current traversal element is not a material. Otherwise true is returned.

int vtkPalette::GetCurrentColor (  const char *&  name,
vtkPaletteColor *&  color
)  const
 

Get the current name - color association in the map.

Returns:
false if either the map is empty, traversal has reached end of the map, or the current traversal element is not a color. Otherwise true is returned.

int vtkPalette::GetCurrentElement (  const char *&  name,
vtkPaletteElement *&  element
)  const
 

Get the current name - element association in the map.

Returns:
false if either the map is empty or traversal has reached the end of the map. Otherwise true is returned.

int vtkPalette::GetCurrentMaterial (  const char *&  name,
vtkPaletteMaterial *&  material
)  const
 

Get the current name - material association in the map.

Returns:
false if either the map is empty, traversal has reached end of the map, or the current traversal element is not a material. Otherwise true is returned.

int vtkPalette::GetCurrentPalette (  const char *&  name,
vtkPalette *&  palette
)  const
 

Get the current name - palette association in the map.

Returns:
false if either the map is empty, traversal has reached the end of the map, or the current traversal element is not a palette. Otherwise true is returned.

virtual vtkPaletteElementHashMap* vtkPalette::GetElements (   )  [virtual]
 

Get a pointer to the internal elements map instance.

int vtkPalette::GetFirstElement (  const char *&  name,
vtkPaletteElement *&  element
) 
 

Get the first name - element association in the map.

Returns:
false if either the map is empty, otherwise true.

const vtkXMLChType* vtkPalette::GetFullName (  void   ) 
 

Get the full name for this palette.

int vtkPalette::GetLastElement (  const char *&  name,
vtkPaletteElement *&  element
) 
 

Get the last name - element association in the map.

Returns:
false if either the map is empty, otherwise true.

int vtkPalette::GetNextAbstractMaterial (  const char *&  name,
vtkAbstractPaletteMaterial *&  material
) 
 

Get the current name - material association in the map and iterate forward to the next material pair.

Returns:
false if either the map is empty or traversal has reached the end of the map. Otherwise true is returned.

int vtkPalette::GetNextColor (  const char *&  name,
vtkPaletteColor *&  color
) 
 

Get the current name - color association in the map and iterate forward to the next color pair.

Returns:
false if either the map is empty or traversal has reached the end of the map. Otherwise true is returned.

int vtkPalette::GetNextElement (  const char *&  name,
vtkPaletteElement *&  element
) 
 

Get the current name - element association in the map and iterate forward to the next pair.

Returns:
false if either the map is empty or traversal has reached the end of the map. Otherwise true is returned.

int vtkPalette::GetNextMaterial (  const char *&  name,
vtkPaletteMaterial *&  material
) 
 

Get the current name - material association in the map and iterate forward to the next material pair.

Returns:
false if either the map is empty or traversal has reached the end of the map. Otherwise true is returned.

int vtkPalette::GetNextPalette (  const char *&  name,
vtkPalette *&  palette
) 
 

Get the current name - palette association in the map and iterate forward to the next palette pair.

Returns:
false if either the map is empty or traversal has reached the end of the map. Otherwise true is returned.

vtkPalette * vtkPalette::GetParent (  void   )  const [inline, virtual]
 

Get the parent palette of this palette.

Reimplemented from vtkPaletteElement.

Definition at line 693 of file vtkPalette.h.

vtkIdType vtkPalette::GetSize (  void   )  const [virtual]
 

Returns the total number of elements in the palette including children.

Reimplemented from vtkPaletteElement.

const vtkXMLChType* vtkPalette::GetTagName (  void   )  const [virtual]
 

Get the XML tag name for marshalling / unmarshalling.

Implements vtkPaletteElement.

int vtkPalette::GetType (  void   )  const [virtual]
 

Get an enumeration of the element type.

Reimplemented from vtkPaletteElement.

void vtkPalette::InitSearchFilesTraversal (  const char *const &  name = NULL  )  [static, protected]
 

void vtkPalette::InitSearchPathsTraversal (  const char *const &  name = NULL  )  [static, protected]
 

int vtkPalette::InitTraversal (  const char *  name  ) 
 

Reimplemented in vtkColorPalette.

int vtkPalette::InitTraversal (  void   ) 
 

Initialize traversal through the elements.

int vtkPalette::Insert (  const char *  name,
vtkPaletteMaterial *  element
) 
 

Create and add an object associated with a name to the map.

Parameters:
name The full path name of the palette to be created and added.
element A pointer to the object that is created and added.
Returns:
true on success, false otherwise.

int vtkPalette::Insert (  const char *  name,
vtkPaletteColor *  element
) 
 

Create and add an object associated with a name to the map.

Parameters:
name The full path name of the palette to be created and added.
element A pointer to the object that is created and added.
Returns:
true on success, false otherwise.

int vtkPalette::Insert (  const char *  name,
vtkPalette *  element
) 
 

Create and add an object associated with a name to the map.

Parameters:
name The full path name of the palette to be created and added.
element A pointer to the object that is created and added.
Returns:
true on success, false otherwise.

int vtkPalette::Insert (  vtkPaletteElement *  element  )  [virtual]
 

Add an element to the map.

Parameters:
element A pointer to the element to be added.
Note:
The element is added directly to this palette object using the name attribute of the element as the key. The insertion will fail if the name attribute is empty.
Returns:
true on success, false otherwise.

Reimplemented from vtkPaletteElement.

int vtkPalette::InsertColor (  const char *  name,
const vtkColorWord  rgba
)  [inline]
 

Add a name associated with a packed RGBA word to the map.

Returns:
true on success, false otherwise.

Reimplemented in vtkColorPalette.

Definition at line 824 of file vtkPalette.h.

References InsertColor(), and VTK_EXTENSIONS_GET_COLORBYTE.

int vtkPalette::InsertColor (  const char *  name,
const unsigned char  color[4]
)  [inline]
 

Add a name associated with an RGBA byte array to the map.

Returns:
true on success, false otherwise.

Definition at line 817 of file vtkPalette.h.

References InsertColor().

int vtkPalette::InsertColor (  const char *  name,
const unsigned char  c0,
const unsigned char  c1,
const unsigned char  c2
)  [inline]
 

Add a name associated with RGB component bytes to the map.

Returns:
true on success, false otherwise.

Definition at line 808 of file vtkPalette.h.

References InsertColor(), and VTK_EXTENSIONS_RGB_MAX.

int vtkPalette::InsertColor (  const char *  name,
const unsigned char  c0,
const unsigned char  c1,
const unsigned char  c2,
const unsigned char  alpha
)  [inline]
 

Add a name associated with RGBA component bytes to the map.

Returns:
true on success, false otherwise.

Definition at line 793 of file vtkPalette.h.

References InsertColor(), and VTK_EXTENSIONS_UINT8_MAX.

int vtkPalette::InsertColor (  const char *  name,
const double  color[4]
)  [inline]
 

Add a name associated with an RGBA float array to the map.

Returns:
true on success, false otherwise.

Definition at line 786 of file vtkPalette.h.

References InsertColor().

int vtkPalette::InsertColor (  const char *  name,
const double  c0,
const double  c1,
const double  c2
)  [inline]
 

Add a name associated with RGB component floats to the map.

Returns:
true on success, false otherwise.

Definition at line 777 of file vtkPalette.h.

References InsertColor().

int vtkPalette::InsertColor (  const char *  name,
const double  c0,
const double  c1,
const double  c2,
const double  alpha
) 
 

Add a name associated with RGBA component floats to the map.

Returns:
true on success, false otherwise.

int vtkPalette::InsertColor (  const char *  name,
const double  c0,
const double  c1,
const double  c2,
const double  alpha,
vtkPaletteColor *  object
) 
 

Add a name associated with RGBA component floats to the map.

Returns:
true on success, false otherwise.

Referenced by InsertColor().

virtual void vtkPalette::InsertDefaultColors (  int  revert = VTK_FALSE  )  [virtual]
 

Insert default color pairs into the map.

Referenced by InsertDefaults().

virtual void vtkPalette::InsertDefaultMaterials (  int  revert = VTK_FALSE  )  [virtual]
 

Insert default material pairs into the map.

Referenced by InsertDefaults().

virtual void vtkPalette::InsertDefaultPalettes (  int  revert = VTK_FALSE  )  [virtual]
 

Insert default palette pairs into the map.

Referenced by InsertDefaults().

void vtkPalette::InsertDefaults (  int  revert = VTK_FALSE  )  [inline]
 

Insert all defaults into the maps.

Definition at line 700 of file vtkPalette.h.

References InsertDefaultColors(), InsertDefaultMaterials(), InsertDefaultPalettes(), and InsertDefaults().

Referenced by InsertDefaults().

int vtkPalette::InsertInScope (  const char *  name,
vtkPaletteMaterial *  element
) 
 

Create and add an object associated with a name to the map.

Parameters:
name The full path name of the palette to be created and added.
element A pointer to the object that is created and added.
Returns:
true on success, false otherwise.

int vtkPalette::InsertInScope (  const char *  name,
vtkPaletteColor *  element
) 
 

Create and add an object associated with a name to the map.

Parameters:
name The full path name of the palette to be created and added.
element A pointer to the object that is created and added.
Returns:
true on success, false otherwise.

int vtkPalette::InsertInScope (  const char *  name,
vtkPalette *  element
) 
 

Create and add an object associated with a name to the map.

Parameters:
name The full path name of the palette to be created and added.
element A pointer to the object that is created and added.
Returns:
true on success, false otherwise.

int vtkPalette::InsertInScope (  const char *  name,
vtkPaletteElement *  element
) 
 

Add an element associated with a name to the map.

Parameters:
name The full path name of the element to be added.
element A pointer to the element to be added.
Returns:
true on success, false otherwise.

int vtkPalette::InsertMaterial (  const char *  name,
const vtkMaterial  material
) 
 

Add an associated name - material pair to the map.

Returns:
true on success, false otherwise.

Reimplemented in vtkColorPalette.

int vtkPalette::InsertMaterial (  const char *  name,
const vtkMaterial  material,
vtkPaletteMaterial *  object
) 
 

Add an associated name - material pair to the map.

Returns:
true on success, false otherwise.

int vtkPalette::IsEmpty (  void   )  const [virtual]
 

Returns true if the palette is empty.

Reimplemented from vtkPaletteElement.

int vtkPalette::IsLeaf (  void   )  const [inline, virtual]
 

Is this palette element a leaf node (i.e.

cannot have children).

Reimplemented from vtkPaletteElement.

Definition at line 72 of file vtkPalette.h.

References VTK_FALSE.

int vtkPalette::IsRoot (  void   )  const [inline, virtual]
 

Is this palette element a root node (i.e.

cannot have parent).

Reimplemented from vtkPaletteElement.

Definition at line 68 of file vtkPalette.h.

References VTK_FALSE, and VTK_TRUE.

void vtkPalette::MarshalAttributes (  ostream &   )  [protected, virtual]
 

Reimplemented from vtkPaletteElement.

void vtkPalette::MarshalContent (  ostream &  ,
vtkIndent 
)  [protected, virtual]
 

Print the all material pairs as a formatted string on the target output stream.

Reimplemented from vtkPaletteElement.

vtkPalette* vtkPalette::New (  void   )  [static]
 

Reimplemented from vtkExtensionsObject.

Reimplemented in vtkColorPalette.

void vtkPalette::PrintColor (  ostream &  target,
vtkIndent  indent,
const char *const &  name,
vtkColorWord const &  color
)  [protected]
 

Print the color data associated with name as a formatted string on the target output stream.

Reimplemented in vtkColorPalette.

virtual void vtkPalette::PrintMaterial (  ostream &  target,
vtkIndent  indent,
const char *const &  name,
vtkMaterial const &  material
)  [inline, protected, virtual]
 

Print the material data associated with name as a formatted string on the target output stream.

Definition at line 637 of file vtkPalette.h.

void vtkPalette::PrintSelf (  ostream &  ,
vtkIndent 
)  [virtual]
 

Reimplemented from vtkPaletteElement.

virtual void vtkPalette::SetParent (  vtkPalette *  a  )  [inline, protected, virtual]
 

Definition at line 669 of file vtkPalette.h.

const char* vtkPalette::StringToColor (  const char *  name,
double &  red,
double &  green,
double &  blue,
double &  alpha
) 
 

Gets the RGBA component bytes of the color and returns a pointer to the text following these values if the parsing was finished.

Note:
This method can parse a variety of text color storage formats. More detailed documentation should be written. Look at the implementation source for now.

int vtkPalette::TraverseSearchFilesForward (  const char *&  name  )  [static, protected]
 

int vtkPalette::TraverseSearchPathsForward (  const char *&  name  )  [static, protected]
 

void vtkPalette::UnmarshalAttribute (  const vtkXMLChType *const &  attr,
const vtkXMLChType *const &  value
)  [protected, virtual]
 

Reimplemented from vtkPaletteElement.

vtkPalette::vtkGetXMLStringMacro (  VersionAttr  ,
vtkXMLChType 
) 
 

Get/Set the id attribute of this palette element.

vtkPalette::vtkSetXMLStringMacro (  VersionAttr  ,
vtkXMLChType 
) 
 

Get/Set the id attribute of this palette element.

vtkPalette::vtkTypeRevisionMacro (  vtkPalette  ,
vtkPaletteElement 
) 
 

Member Data Documentation

vtkXMLChType* vtkPalette::CreatedAttr [protected]
 

Definition at line 661 of file vtkPalette.h.

const vtkXMLChType* const vtkPalette::createdString [static]
 

Definition at line 608 of file vtkPalette.h.

vtkPaletteElementHashMap* vtkPalette::Elements [protected]
 

Definition at line 665 of file vtkPalette.h.

vtkXMLChType* vtkPalette::FullName [protected]
 

Definition at line 660 of file vtkPalette.h.

vtkPaletteElementHashMapIterator* vtkPalette::Iterator [protected]
 

Definition at line 666 of file vtkPalette.h.

vtkXMLChType* vtkPalette::ModifiedAttr [protected]
 

Definition at line 662 of file vtkPalette.h.

const vtkXMLChType* const vtkPalette::modifiedString [static]
 

Definition at line 609 of file vtkPalette.h.

const char* const vtkPalette::PaletteFilesEnvVar [static]
 

Search filename env.

var. ("VTK_PALETTE_FILES").

Definition at line 604 of file vtkPalette.h.

const char* const vtkPalette::PalettePathsEnvVar [static]
 

Search path env.

var. ("VTK_PALETTE_PATHS").

Definition at line 601 of file vtkPalette.h.

const vtkXMLChType* const vtkPalette::paletteString [static]
 

Definition at line 606 of file vtkPalette.h.

vtkXMLChType* vtkPalette::VersionAttr [protected]
 

Definition at line 663 of file vtkPalette.h.

const vtkXMLChType* const vtkPalette::versionString [static]
 

Definition at line 610 of file vtkPalette.h.

The documentation for this class was generated from the following file:
Generated on Tue Aug 10 03:43:42 2004 for vtkExtensions by doxygen 1.3.7