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

vtkAbstractPaletteMaterial Class Reference

#include <vtkAbstractPaletteMaterial.h>

Inheritance diagram for vtkAbstractPaletteMaterial:

Inheritance graph
[legend]
Collaboration diagram for vtkAbstractPaletteMaterial:

Collaboration graph
[legend]
List of all members.

Detailed Description

Abstract base for palette color materials.

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

Definition at line 46 of file vtkAbstractPaletteMaterial.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkAbstractPaletteMaterial, vtkPaletteElement)
virtual int GetType ()
 Get/Set the type attribute of this palette color material data.

virtual void SetType (int)
 Get/Set the type attribute of this palette color material data.

virtual vtkAbstractPaletteMaterial * GetXRef ()
 Get the xref attribute of this palette color material.

virtual void SetXRef (vtkAbstractPaletteMaterial *)
 Get the xref attribute of this palette color material.

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

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

void GetColor (double v[3])
 Get/Set the data of this palette color material.

void SetColor (double v[3])
 Get/Set the data of this palette color material.

virtual double GetOpacity (void)=0
 Get the opacity attribute of this palette color.

virtual void SetOpacity (double)=0
 Get the opacity attribute of this palette color.

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

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

void GetAmbientColor (double v[3])
 Get/Set the ambient data of this palette color material.

void SetAmbientColor (double v[3])
 Get/Set the ambient data of this palette color material.

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

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

void GetDiffuseColor (double v[3])
 Get/Set the diffuse data of this palette color material.

void SetDiffuseColor (double v[3])
 Get/Set the diffuse data of this palette color material.

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

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

void GetSpecularColor (double v[3])
 Get/Set the specular data of this palette color material.

void SetSpecularColor (double v[3])
 Get/Set the specular data of this palette color material.

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

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


Static Public Member Functions

Color and Material Format Conversion Methods
void ConvertColor (double const &c0, double const &c1, double const &c2, double const &opacity, vtkAbstractPaletteMaterial *&o)
 Convert color component floats into a palette color object.

void ConvertColor (unsigned char const &c0, unsigned char const &c1, unsigned char const &c2, unsigned char const &opacity, vtkAbstractPaletteMaterial *&o)
 Convert color component bytes into a palette color object.

void ConvertColor (vtkColorWord const &color, vtkAbstractPaletteMaterial *&o)
 Convert a packed color word into a palette color object.

void ConvertColor (vtkAbstractPaletteMaterial *const &o, double &c0, double &c1, double &c2, double &opacity)
 Convert a palette color object into color component floats.

void ConvertColor (vtkAbstractPaletteMaterial *const &o, unsigned char &c0, unsigned char &c1, unsigned char &c2, unsigned char &opacity)
 Convert a palette color object into color component bytes.

void ConvertColor (vtkAbstractPaletteMaterial *const &o, vtkColorWord &color)
 Convert a palette color object into a packed color word.


Static Public Attributes

const vtkXMLChType *const typeString
const vtkXMLChType *const xrefString
const vtkXMLChType *const RGBString
const vtkXMLChType *const HSVString
const vtkXMLChType *const HSLString
const vtkXMLChType *const RGBAString
const vtkXMLChType *const HSVAString
const vtkXMLChType *const HSLAString
const vtkXMLChType *const CSSString
const vtkXMLChType *const XREFString

Protected Member Functions

 vtkAbstractPaletteMaterial (void)
 ~vtkAbstractPaletteMaterial ()
void MarshalAttributes (ostream &)
void UnmarshalAttribute (const vtkXMLChType *const &attr, const vtkXMLChType *const &value)

Protected Attributes

int Type
vtkAbstractPaletteMaterial * XRef

Constructor & Destructor Documentation

vtkAbstractPaletteMaterial::vtkAbstractPaletteMaterial (  void   )  [protected]
 

vtkAbstractPaletteMaterial::~vtkAbstractPaletteMaterial (   )  [protected]
 

Member Function Documentation

void vtkAbstractPaletteMaterial::ConvertColor (  vtkAbstractPaletteMaterial *const &  o,
vtkColorWord &  color
)  [inline, static]
 

Convert a palette color object into a packed color word.

Definition at line 324 of file vtkAbstractPaletteMaterial.h.

void vtkAbstractPaletteMaterial::ConvertColor (  vtkAbstractPaletteMaterial *const &  o,
unsigned char &  c0,
unsigned char &  c1,
unsigned char &  c2,
unsigned char &  opacity
)  [inline, static]
 

Convert a palette color object into color component bytes.

Definition at line 302 of file vtkAbstractPaletteMaterial.h.

References ConvertColor(), and VTK_EXTENSIONS_UINT8_MAX.

void vtkAbstractPaletteMaterial::ConvertColor (  vtkAbstractPaletteMaterial *const &  o,
double &  c0,
double &  c1,
double &  c2,
double &  opacity
)  [inline, static]
 

Convert a palette color object into color component floats.

Definition at line 283 of file vtkAbstractPaletteMaterial.h.

References GetColor(), and GetOpacity().

void vtkAbstractPaletteMaterial::ConvertColor (  vtkColorWord const &  color,
vtkAbstractPaletteMaterial *&  o
)  [inline, static]
 

Convert a packed color word into a palette color object.

Definition at line 269 of file vtkAbstractPaletteMaterial.h.

References VTK_EXTENSIONS_GET_COLORBYTE.

void vtkAbstractPaletteMaterial::ConvertColor (  unsigned char const &  c0,
unsigned char const &  c1,
unsigned char const &  c2,
unsigned char const &  opacity,
vtkAbstractPaletteMaterial *&  o
)  [inline, static]
 

Convert color component bytes into a palette color object.

Definition at line 253 of file vtkAbstractPaletteMaterial.h.

References ConvertColor(), and VTK_EXTENSIONS_UINT8_MAX.

void vtkAbstractPaletteMaterial::ConvertColor (  double const &  c0,
double const &  c1,
double const &  c2,
double const &  opacity,
vtkAbstractPaletteMaterial *&  o
)  [inline, static]
 

Convert color component floats into a palette color object.

Definition at line 238 of file vtkAbstractPaletteMaterial.h.

References SetColor(), and SetOpacity().

Referenced by ConvertColor().

void vtkAbstractPaletteMaterial::GetAmbientColor (  double  v[3]  )  [inline]
 

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

Definition at line 200 of file vtkAbstractPaletteMaterial.h.

References GetAmbientColor().

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

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

Implemented in vtkAbstractPaletteColor, and vtkPaletteMaterial.

Referenced by GetAmbientColor().

void vtkAbstractPaletteMaterial::GetColor (  double  v[3]  )  [inline]
 

Get/Set the data of this palette color material.

Definition at line 188 of file vtkAbstractPaletteMaterial.h.

References GetColor().

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

Get/Set the data of this palette color material.

Implemented in vtkPaletteColorBase, and vtkPaletteMaterial.

Referenced by ConvertColor(), and GetColor().

void vtkAbstractPaletteMaterial::GetDiffuseColor (  double  v[3]  )  [inline]
 

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

Definition at line 212 of file vtkAbstractPaletteMaterial.h.

References GetDiffuseColor().

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

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

Implemented in vtkAbstractPaletteColor, and vtkPaletteMaterial.

Referenced by GetDiffuseColor().

virtual double vtkAbstractPaletteMaterial::GetOpacity (  void   )  [pure virtual]
 

Get the opacity attribute of this palette color.

Implemented in vtkAbstractPaletteColor, vtkPaletteColor, vtkPaletteDiffuseColor, and vtkPaletteMaterial.

Referenced by ConvertColor().

void vtkAbstractPaletteMaterial::GetSpecularColor (  double  v[3]  )  [inline]
 

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

Definition at line 224 of file vtkAbstractPaletteMaterial.h.

References GetSpecularColor().

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

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

Implemented in vtkAbstractPaletteColor, and vtkPaletteMaterial.

Referenced by GetSpecularColor().

virtual double vtkAbstractPaletteMaterial::GetSpecularPower (  void   )  [pure virtual]
 

Get the specular power attribute of this palette color.

Implemented in vtkAbstractPaletteColor, vtkPaletteMaterial, and vtkPaletteSpecularColor.

virtual int vtkAbstractPaletteMaterial::GetType (   )  [virtual]
 

Get/Set the type attribute of this palette color material data.

Reimplemented from vtkPaletteElement.

virtual vtkAbstractPaletteMaterial* vtkAbstractPaletteMaterial::GetXRef (   )  [virtual]
 

Get the xref attribute of this palette color material.

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

Reimplemented from vtkPaletteElement.

Reimplemented in vtkPaletteColor, vtkPaletteDiffuseColor, and vtkPaletteSpecularColor.

void vtkAbstractPaletteMaterial::SetAmbientColor (  double  v[3]  )  [inline]
 

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

Definition at line 206 of file vtkAbstractPaletteMaterial.h.

References SetAmbientColor().

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

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

Implemented in vtkAbstractPaletteColor, and vtkPaletteMaterial.

Referenced by SetAmbientColor().

void vtkAbstractPaletteMaterial::SetColor (  double  v[3]  )  [inline]
 

Get/Set the data of this palette color material.

Definition at line 194 of file vtkAbstractPaletteMaterial.h.

References SetColor().

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

Get/Set the data of this palette color material.

Implemented in vtkPaletteColorBase, and vtkPaletteMaterial.

Referenced by ConvertColor(), and SetColor().

void vtkAbstractPaletteMaterial::SetDiffuseColor (  double  v[3]  )  [inline]
 

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

Definition at line 218 of file vtkAbstractPaletteMaterial.h.

References SetDiffuseColor().

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

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

Implemented in vtkAbstractPaletteColor, and vtkPaletteMaterial.

Referenced by SetDiffuseColor().

virtual void vtkAbstractPaletteMaterial::SetOpacity (  double   )  [pure virtual]
 

Get the opacity attribute of this palette color.

Implemented in vtkAbstractPaletteColor, vtkPaletteColor, vtkPaletteDiffuseColor, and vtkPaletteMaterial.

Referenced by ConvertColor().

void vtkAbstractPaletteMaterial::SetSpecularColor (  double  v[3]  )  [inline]
 

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

Definition at line 230 of file vtkAbstractPaletteMaterial.h.

References SetSpecularColor().

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

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

Implemented in vtkAbstractPaletteColor, and vtkPaletteMaterial.

Referenced by SetSpecularColor().

virtual void vtkAbstractPaletteMaterial::SetSpecularPower (  double   )  [pure virtual]
 

Get the specular power attribute of this palette color.

Implemented in vtkAbstractPaletteColor, vtkPaletteMaterial, and vtkPaletteSpecularColor.

virtual void vtkAbstractPaletteMaterial::SetType (  int   )  [virtual]
 

Get/Set the type attribute of this palette color material data.

virtual void vtkAbstractPaletteMaterial::SetXRef (  vtkAbstractPaletteMaterial *   )  [virtual]
 

Get the xref attribute of this palette color material.

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

Reimplemented from vtkPaletteElement.

Reimplemented in vtkPaletteColor, vtkPaletteDiffuseColor, and vtkPaletteSpecularColor.

vtkAbstractPaletteMaterial::vtkTypeRevisionMacro (  vtkAbstractPaletteMaterial  ,
vtkPaletteElement 
) 
 

Member Data Documentation

const vtkXMLChType* const vtkAbstractPaletteMaterial::CSSString [static]
 

Definition at line 157 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::HSLAString [static]
 

Definition at line 156 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::HSLString [static]
 

Definition at line 153 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::HSVAString [static]
 

Definition at line 155 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::HSVString [static]
 

Definition at line 152 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::RGBAString [static]
 

Definition at line 154 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::RGBString [static]
 

Definition at line 151 of file vtkAbstractPaletteMaterial.h.

int vtkAbstractPaletteMaterial::Type [protected]
 

Definition at line 171 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::typeString [static]
 

Definition at line 148 of file vtkAbstractPaletteMaterial.h.

vtkAbstractPaletteMaterial* vtkAbstractPaletteMaterial::XRef [protected]
 

Definition at line 172 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::XREFString [static]
 

Definition at line 158 of file vtkAbstractPaletteMaterial.h.

const vtkXMLChType* const vtkAbstractPaletteMaterial::xrefString [static]
 

Definition at line 149 of file vtkAbstractPaletteMaterial.h.

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