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

vtkPaletteMaterial Class Reference

#include <vtkPaletteMaterial.h>

Inheritance diagram for vtkPaletteMaterial:

Inheritance graph
[legend]
Collaboration diagram for vtkPaletteMaterial:

Collaboration graph
[legend]
List of all members.

Detailed Description

A palette color material object.

Author:
Sean McInerney
Version:
Revision
1.1
Date:
Date
2004/06/02 11:35:09
See also:
vtkAbstractPaletteMaterial

Definition at line 34 of file vtkPaletteMaterial.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkPaletteMaterial, vtkAbstractPaletteMaterial)
void PrintSelf (ostream &, vtkIndent)
const vtkXMLChType * GetTagName (void) const
 Get the XML tag name for marshalling / unmarshalling.

int GetType (void) const
 Get an enumeration of the element type.

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.

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

int Insert (vtkPaletteElement *&element)
 Add an element to this object.

int Erase (const char *name)
 Erase an element associated with a name from this object.

void GetColor (double &c0, double &c1, double &c2)
 Get/Set the data of this palette color material.

void SetColor (double c0, double c1, double c2)
 Get/Set the data of this palette color material.

double GetOpacity (void)
 Get the opacity attribute of this palette color material.

void SetOpacity (double)
 Get the opacity attribute of this palette color material.

void GetAmbientColor (double &c0, double &c1, double &c2)
 Get/Set the ambient data of this palette color material.

void SetAmbientColor (double c0, double c1, double c2)
 Get/Set the ambient data of this palette color material.

void GetDiffuseColor (double &c0, double &c1, double &c2)
 Get/Set the diffuse data of this palette color material.

void SetDiffuseColor (double c0, double c1, double c2)
 Get/Set the diffuse data of this palette color material.

void GetSpecularColor (double &c0, double &c1, double &c2)
 Get/Set the specular data of this palette color material.

void SetSpecularColor (double c0, double c1, double c2)
 Get/Set the specular data of this palette color material.

double GetSpecularPower (void)
 Get the specular power attribute of this palette color.

void SetSpecularPower (double)
 Get the specular power attribute of this palette color.

virtual vtkAbstractPaletteMaterial * GetAmbientColorElement ()
 Get the palette specular element.

void SetAmbientColorElement (vtkAbstractPaletteMaterial *)
 Get the palette specular element.

virtual vtkAbstractPaletteMaterial * GetDiffuseColorElement ()
 Get the palette specular element.

void SetDiffuseColorElement (vtkAbstractPaletteMaterial *)
 Get the palette specular element.

virtual vtkAbstractPaletteMaterial * GetSpecularColorElement ()
 Get the palette specular element.

void SetSpecularColorElement (vtkAbstractPaletteMaterial *)
 Get the palette specular element.


Static Public Member Functions

vtkPaletteMaterial * New (void)

Static Public Attributes

const vtkXMLChType *const materialString

Protected Member Functions

 vtkPaletteMaterial (void)
 ~vtkPaletteMaterial ()
void MarshalContent (ostream &, vtkIndent)

Protected Attributes

vtkAbstractPaletteMaterial * AmbientColorElement
vtkAbstractPaletteMaterial * DiffuseColorElement
vtkAbstractPaletteMaterial * SpecularColorElement

Constructor & Destructor Documentation

vtkPaletteMaterial::vtkPaletteMaterial (  void   )  [protected]
 

vtkPaletteMaterial::~vtkPaletteMaterial (   )  [protected]
 

Member Function Documentation

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

Erase an element associated with a name from this object.

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

Reimplemented from vtkPaletteElement.

vtkPaletteElement* vtkPaletteMaterial::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.

void vtkPaletteMaterial::GetAmbientColor (  double &  c0,
double &  c1,
double &  c2
)  [virtual]
 

Get/Set the ambient data of this palette color material.

Implements vtkAbstractPaletteMaterial.

virtual vtkAbstractPaletteMaterial* vtkPaletteMaterial::GetAmbientColorElement (   )  [virtual]
 

Get the palette specular element.

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

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

Reimplemented from vtkPaletteElement.

void vtkPaletteMaterial::GetColor (  double &  c0,
double &  c1,
double &  c2
)  [virtual]
 

Get/Set the data of this palette color material.

Implements vtkAbstractPaletteMaterial.

void vtkPaletteMaterial::GetDiffuseColor (  double &  c0,
double &  c1,
double &  c2
)  [virtual]
 

Get/Set the diffuse data of this palette color material.

Implements vtkAbstractPaletteMaterial.

virtual vtkAbstractPaletteMaterial* vtkPaletteMaterial::GetDiffuseColorElement (   )  [virtual]
 

Get the palette specular element.

double vtkPaletteMaterial::GetOpacity (  void   )  [virtual]
 

Get the opacity attribute of this palette color material.

Implements vtkAbstractPaletteMaterial.

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

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

Reimplemented from vtkPaletteElement.

void vtkPaletteMaterial::GetSpecularColor (  double &  c0,
double &  c1,
double &  c2
)  [virtual]
 

Get/Set the specular data of this palette color material.

Implements vtkAbstractPaletteMaterial.

virtual vtkAbstractPaletteMaterial* vtkPaletteMaterial::GetSpecularColorElement (   )  [virtual]
 

Get the palette specular element.

double vtkPaletteMaterial::GetSpecularPower (  void   )  [virtual]
 

Get the specular power attribute of this palette color.

Implements vtkAbstractPaletteMaterial.

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

Get the XML tag name for marshalling / unmarshalling.

Implements vtkPaletteElement.

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

Get an enumeration of the element type.

Reimplemented from vtkPaletteElement.

int vtkPaletteMaterial::Insert (  vtkPaletteElement *&  element  ) 
 

Add an element to this object.

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

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

Returns true if the palette is empty.

Reimplemented from vtkPaletteElement.

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

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

cannot have children).

Reimplemented from vtkPaletteElement.

Definition at line 51 of file vtkPaletteMaterial.h.

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

Reimplemented from vtkPaletteElement.

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

Reimplemented from vtkExtensionsObject.

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

Reimplemented from vtkPaletteElement.

void vtkPaletteMaterial::SetAmbientColor (  double  c0,
double  c1,
double  c2
)  [virtual]
 

Get/Set the ambient data of this palette color material.

Implements vtkAbstractPaletteMaterial.

void vtkPaletteMaterial::SetAmbientColorElement (  vtkAbstractPaletteMaterial *   ) 
 

Get the palette specular element.

void vtkPaletteMaterial::SetColor (  double  c0,
double  c1,
double  c2
)  [virtual]
 

Get/Set the data of this palette color material.

Implements vtkAbstractPaletteMaterial.

void vtkPaletteMaterial::SetDiffuseColor (  double  c0,
double  c1,
double  c2
)  [virtual]
 

Get/Set the diffuse data of this palette color material.

Implements vtkAbstractPaletteMaterial.

void vtkPaletteMaterial::SetDiffuseColorElement (  vtkAbstractPaletteMaterial *   ) 
 

Get the palette specular element.

void vtkPaletteMaterial::SetOpacity (  double   )  [virtual]
 

Get the opacity attribute of this palette color material.

Implements vtkAbstractPaletteMaterial.

void vtkPaletteMaterial::SetSpecularColor (  double  c0,
double  c1,
double  c2
)  [virtual]
 

Get/Set the specular data of this palette color material.

Implements vtkAbstractPaletteMaterial.

void vtkPaletteMaterial::SetSpecularColorElement (  vtkAbstractPaletteMaterial *   ) 
 

Get the palette specular element.

void vtkPaletteMaterial::SetSpecularPower (  double   )  [virtual]
 

Get the specular power attribute of this palette color.

Implements vtkAbstractPaletteMaterial.

vtkPaletteMaterial::vtkTypeRevisionMacro (  vtkPaletteMaterial  ,
vtkAbstractPaletteMaterial 
) 
 

Member Data Documentation

vtkAbstractPaletteMaterial* vtkPaletteMaterial::AmbientColorElement [protected]
 

Definition at line 174 of file vtkPaletteMaterial.h.

vtkAbstractPaletteMaterial* vtkPaletteMaterial::DiffuseColorElement [protected]
 

Definition at line 175 of file vtkPaletteMaterial.h.

const vtkXMLChType* const vtkPaletteMaterial::materialString [static]
 

Definition at line 163 of file vtkPaletteMaterial.h.

vtkAbstractPaletteMaterial* vtkPaletteMaterial::SpecularColorElement [protected]
 

Definition at line 176 of file vtkPaletteMaterial.h.

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