Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkProperty Class Reference

#include <vtkProperty.h>

Inheritance diagram for vtkProperty:

Inheritance graph
[legend]
Collaboration diagram for vtkProperty:

Collaboration graph
[legend]
List of all members.

Detailed Description

represent surface properties of a geometric object

vtkProperty is an object that represents lighting and other surface properties of a geometric object. The primary properties that can be set are colors (overall, ambient, diffuse, specular, and edge color); specular power; opacity of the object; the representation of the object (points, wireframe, or surface); and the shading method to be used (flat, Gouraud, and Phong). Also, some special graphics features like backface properties can be set and manipulated with this object.

See also:
vtkActor vtkPropertyDevice
Examples:
vtkProperty (Examples)
Tests:
vtkProperty (Tests)

Definition at line 54 of file vtkProperty.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void DeepCopy (vtkProperty *p)
virtual void Render (vtkActor *, vtkRenderer *)
virtual void BackfaceRender (vtkActor *, vtkRenderer *)
virtual void SetInterpolation (int)
virtual int GetInterpolation ()
void SetInterpolationToFlat ()
void SetInterpolationToGouraud ()
void SetInterpolationToPhong ()
char * GetInterpolationAsString ()
virtual void SetRepresentation (int)
virtual int GetRepresentation ()
void SetRepresentationToPoints ()
void SetRepresentationToWireframe ()
void SetRepresentationToSurface ()
char * GetRepresentationAsString ()
void SetColor (double r, double g, double b)
void SetColor (double a[3])
double * GetColor ()
void GetColor (double rgb[3])
virtual void SetAmbient (double)
virtual double GetAmbient ()
virtual void SetDiffuse (double)
virtual double GetDiffuse ()
virtual void SetSpecular (double)
virtual double GetSpecular ()
virtual void SetSpecularPower (double)
virtual double GetSpecularPower ()
virtual void SetOpacity (double)
virtual double GetOpacity ()
virtual void SetAmbientColor (double, double, double)
virtual void SetAmbientColor (double[3])
virtual double * GetAmbientColor ()
virtual void GetAmbientColor (double data[3])
virtual void SetDiffuseColor (double, double, double)
virtual void SetDiffuseColor (double[3])
virtual double * GetDiffuseColor ()
virtual void GetDiffuseColor (double data[3])
virtual void SetSpecularColor (double, double, double)
virtual void SetSpecularColor (double[3])
virtual double * GetSpecularColor ()
virtual void GetSpecularColor (double data[3])
virtual int GetEdgeVisibility ()
virtual void SetEdgeVisibility (int)
virtual void EdgeVisibilityOn ()
virtual void EdgeVisibilityOff ()
virtual void SetEdgeColor (double, double, double)
virtual void SetEdgeColor (double[3])
virtual double * GetEdgeColor ()
virtual void GetEdgeColor (double data[3])
virtual void SetLineWidth (float)
virtual float GetLineWidth ()
virtual void SetLineStipplePattern (int)
virtual int GetLineStipplePattern ()
virtual void SetLineStippleRepeatFactor (int)
virtual int GetLineStippleRepeatFactor ()
virtual void SetPointSize (float)
virtual float GetPointSize ()
virtual int GetBackfaceCulling ()
virtual void SetBackfaceCulling (int)
virtual void BackfaceCullingOn ()
virtual void BackfaceCullingOff ()
virtual int GetFrontfaceCulling ()
virtual void SetFrontfaceCulling (int)
virtual void FrontfaceCullingOn ()
virtual void FrontfaceCullingOff ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPropertySafeDownCast (vtkObject *o)
static vtkPropertyNew ()

Protected Member Functions

 vtkProperty ()
 ~vtkProperty ()

Protected Attributes

double Color [3]
double AmbientColor [3]
double DiffuseColor [3]
double SpecularColor [3]
double EdgeColor [3]
double Ambient
double Diffuse
double Specular
double SpecularPower
double Opacity
float PointSize
float LineWidth
int LineStipplePattern
int LineStippleRepeatFactor
int Interpolation
int Representation
int EdgeVisibility
int BackfaceCulling
int FrontfaceCulling


Member Typedef Documentation

typedef vtkObject vtkProperty::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

Definition at line 57 of file vtkProperty.h.


Constructor & Destructor Documentation

vtkProperty::vtkProperty  )  [protected]
 

vtkProperty::~vtkProperty  )  [inline, protected]
 

Definition at line 232 of file vtkProperty.h.


Member Function Documentation

virtual const char* vtkProperty::GetClassName  )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

static int vtkProperty::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

virtual int vtkProperty::IsA const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

static vtkProperty* vtkProperty::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

void vtkProperty::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

static vtkProperty* vtkProperty::New  )  [static]
 

Construct object with object color, ambient color, diffuse color, specular color, and edge color white; ambient coefficient=0; diffuse coefficient=0; specular coefficient=0; specular power=1; Gouraud shading; and surface representation. Backface and frontface culling are off.

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

void vtkProperty::DeepCopy vtkProperty p  ) 
 

Assign one property to another.

virtual void vtkProperty::Render vtkActor ,
vtkRenderer
[inline, virtual]
 

This method causes the property to set up whatever is required for its instance variables. This is actually handled by a subclass of vtkProperty, which is created automatically. This method includes the invoking actor as an argument which can be used by property devices that require the actor.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

Definition at line 75 of file vtkProperty.h.

virtual void vtkProperty::BackfaceRender vtkActor ,
vtkRenderer
[inline, virtual]
 

This method renders the property as a backface property. TwoSidedLighting must be turned off to see any backface properties. Note that only colors and opacity are used for backface properties. Other properties such as Representation, Culling are specified by the Property.

Reimplemented in vtkMesaProperty, and vtkOpenGLProperty.

Definition at line 82 of file vtkProperty.h.

virtual void vtkProperty::SetInterpolation int   )  [virtual]
 

Set the shading interpolation method for an object.

virtual int vtkProperty::GetInterpolation  )  [virtual]
 

This method renders the property as a backface property. TwoSidedLighting must be turned off to see any backface properties. Note that only colors and opacity are used for backface properties. Other properties such as Representation, Culling are specified by the Property.

void vtkProperty::SetInterpolationToFlat  )  [inline]
 

This method renders the property as a backface property. TwoSidedLighting must be turned off to see any backface properties. Note that only colors and opacity are used for backface properties. Other properties such as Representation, Culling are specified by the Property.

Definition at line 88 of file vtkProperty.h.

References VTK_FLAT.

void vtkProperty::SetInterpolationToGouraud  )  [inline]
 

This method renders the property as a backface property. TwoSidedLighting must be turned off to see any backface properties. Note that only colors and opacity are used for backface properties. Other properties such as Representation, Culling are specified by the Property.

Definition at line 89 of file vtkProperty.h.

References VTK_GOURAUD.

void vtkProperty::SetInterpolationToPhong  )  [inline]
 

This method renders the property as a backface property. TwoSidedLighting must be turned off to see any backface properties. Note that only colors and opacity are used for backface properties. Other properties such as Representation, Culling are specified by the Property.

Definition at line 90 of file vtkProperty.h.

References VTK_PHONG.

char * vtkProperty::GetInterpolationAsString void   )  [inline]
 

Return the method of shading as a descriptive character string.

Definition at line 259 of file vtkProperty.h.

References VTK_FLAT, and VTK_GOURAUD.

virtual void vtkProperty::SetRepresentation int   )  [virtual]
 

Control the surface geometry representation for the object.

virtual int vtkProperty::GetRepresentation  )  [virtual]
 

Control the surface geometry representation for the object.

void vtkProperty::SetRepresentationToPoints  )  [inline]
 

Control the surface geometry representation for the object.

Definition at line 98 of file vtkProperty.h.

References VTK_POINTS.

void vtkProperty::SetRepresentationToWireframe  )  [inline]
 

Control the surface geometry representation for the object.

Definition at line 99 of file vtkProperty.h.

References VTK_WIREFRAME.

void vtkProperty::SetRepresentationToSurface  )  [inline]
 

Control the surface geometry representation for the object.

Definition at line 101 of file vtkProperty.h.

References VTK_SURFACE.

char * vtkProperty::GetRepresentationAsString void   )  [inline]
 

Return the method of shading as a descriptive character string.

Definition at line 277 of file vtkProperty.h.

References VTK_POINTS, and VTK_WIREFRAME.

void vtkProperty::SetColor double  r,
double  g,
double  b
 

Set the color of the object. Has the side effect of setting the ambient diffuse and specular colors as well. This is basically a quick overall color setting method.

void vtkProperty::SetColor double  a[3]  )  [inline]
 

Set the color of the object. Has the side effect of setting the ambient diffuse and specular colors as well. This is basically a quick overall color setting method.

Definition at line 110 of file vtkProperty.h.

double* vtkProperty::GetColor  ) 
 

Set the color of the object. Has the side effect of setting the ambient diffuse and specular colors as well. This is basically a quick overall color setting method.

void vtkProperty::GetColor double  rgb[3]  ) 
 

Set the color of the object. Has the side effect of setting the ambient diffuse and specular colors as well. This is basically a quick overall color setting method.

virtual void vtkProperty::SetAmbient double   )  [virtual]
 

Set/Get the ambient lighting coefficient.

virtual double vtkProperty::GetAmbient  )  [virtual]
 

Set/Get the ambient lighting coefficient.

virtual void vtkProperty::SetDiffuse double   )  [virtual]
 

Set/Get the diffuse lighting coefficient.

virtual double vtkProperty::GetDiffuse  )  [virtual]
 

Set/Get the diffuse lighting coefficient.

virtual void vtkProperty::SetSpecular double   )  [virtual]
 

Set/Get the specular lighting coefficient.

virtual double vtkProperty::GetSpecular  )  [virtual]
 

Set/Get the specular lighting coefficient.

virtual void vtkProperty::SetSpecularPower double   )  [virtual]
 

Set/Get the specular power.

virtual double vtkProperty::GetSpecularPower  )  [virtual]
 

Set/Get the specular power.

virtual void vtkProperty::SetOpacity double   )  [virtual]
 

Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual double vtkProperty::GetOpacity  )  [virtual]
 

Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual void vtkProperty::SetAmbientColor double  ,
double  ,
double 
[virtual]
 

Set/Get the ambient surface color. Not all renderers support separate ambient and diffuse colors. From a physical standpoint it really doesn't make too much sense to have both. For the rendering libraries that don't support both, the diffuse color is used.

virtual void vtkProperty::SetAmbientColor double  [3]  )  [virtual]
 

Set/Get the ambient surface color. Not all renderers support separate ambient and diffuse colors. From a physical standpoint it really doesn't make too much sense to have both. For the rendering libraries that don't support both, the diffuse color is used.

virtual double* vtkProperty::GetAmbientColor  )  [virtual]
 

Set/Get the ambient surface color. Not all renderers support separate ambient and diffuse colors. From a physical standpoint it really doesn't make too much sense to have both. For the rendering libraries that don't support both, the diffuse color is used.

virtual void vtkProperty::GetAmbientColor double  data[3]  )  [virtual]
 

Set/Get the ambient surface color. Not all renderers support separate ambient and diffuse colors. From a physical standpoint it really doesn't make too much sense to have both. For the rendering libraries that don't support both, the diffuse color is used.

virtual void vtkProperty::SetDiffuseColor double  ,
double  ,
double 
[virtual]
 

Set/Get the diffuse surface color.

virtual void vtkProperty::SetDiffuseColor double  [3]  )  [virtual]
 

Set/Get the diffuse surface color.

virtual double* vtkProperty::GetDiffuseColor  )  [virtual]
 

Set/Get the diffuse surface color.

virtual void vtkProperty::GetDiffuseColor double  data[3]  )  [virtual]
 

Set/Get the diffuse surface color.

virtual void vtkProperty::SetSpecularColor double  ,
double  ,
double 
[virtual]
 

Set/Get the specular surface color.

virtual void vtkProperty::SetSpecularColor double  [3]  )  [virtual]
 

Set/Get the specular surface color.

virtual double* vtkProperty::GetSpecularColor  )  [virtual]
 

Set/Get the specular surface color.

virtual void vtkProperty::GetSpecularColor double  data[3]  )  [virtual]
 

Set/Get the specular surface color.

virtual int vtkProperty::GetEdgeVisibility  )  [virtual]
 

Turn on/off the visibility of edges. On some renderers it is possible to render the edges of geometric primitives separately from the interior.

virtual void vtkProperty::SetEdgeVisibility int   )  [virtual]
 

Turn on/off the visibility of edges. On some renderers it is possible to render the edges of geometric primitives separately from the interior.

virtual void vtkProperty::EdgeVisibilityOn  )  [virtual]
 

Turn on/off the visibility of edges. On some renderers it is possible to render the edges of geometric primitives separately from the interior.

virtual void vtkProperty::EdgeVisibilityOff  )  [virtual]
 

Turn on/off the visibility of edges. On some renderers it is possible to render the edges of geometric primitives separately from the interior.

virtual void vtkProperty::SetEdgeColor double  ,
double  ,
double 
[virtual]
 

Set/Get the color of primitive edges (if edge visibility is enabled).

virtual void vtkProperty::SetEdgeColor double  [3]  )  [virtual]
 

Set/Get the color of primitive edges (if edge visibility is enabled).

virtual double* vtkProperty::GetEdgeColor  )  [virtual]
 

Set/Get the color of primitive edges (if edge visibility is enabled).

virtual void vtkProperty::GetEdgeColor double  data[3]  )  [virtual]
 

Set/Get the color of primitive edges (if edge visibility is enabled).

virtual void vtkProperty::SetLineWidth float   )  [virtual]
 

Set/Get the width of a Line. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

virtual float vtkProperty::GetLineWidth  )  [virtual]
 

Set/Get the width of a Line. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

virtual void vtkProperty::SetLineStipplePattern int   )  [virtual]
 

Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). This is only implemented for OpenGL. The default is 0xFFFF.

virtual int vtkProperty::GetLineStipplePattern  )  [virtual]
 

Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). This is only implemented for OpenGL. The default is 0xFFFF.

virtual void vtkProperty::SetLineStippleRepeatFactor int   )  [virtual]
 

Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1.

virtual int vtkProperty::GetLineStippleRepeatFactor  )  [virtual]
 

Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1.

virtual void vtkProperty::SetPointSize float   )  [virtual]
 

Set/Get the diameter of a point. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

virtual float vtkProperty::GetPointSize  )  [virtual]
 

Set/Get the diameter of a point. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

virtual int vtkProperty::GetBackfaceCulling  )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If backface culling is on, polygons facing away from camera are not drawn.

virtual void vtkProperty::SetBackfaceCulling int   )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If backface culling is on, polygons facing away from camera are not drawn.

virtual void vtkProperty::BackfaceCullingOn  )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If backface culling is on, polygons facing away from camera are not drawn.

virtual void vtkProperty::BackfaceCullingOff  )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If backface culling is on, polygons facing away from camera are not drawn.

virtual int vtkProperty::GetFrontfaceCulling  )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If frontface culling is on, polygons facing towards camera are not drawn.

virtual void vtkProperty::SetFrontfaceCulling int   )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If frontface culling is on, polygons facing towards camera are not drawn.

virtual void vtkProperty::FrontfaceCullingOn  )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If frontface culling is on, polygons facing towards camera are not drawn.

virtual void vtkProperty::FrontfaceCullingOff  )  [virtual]
 

Turn on/off fast culling of polygons based on orientation of normal with respect to camera. If frontface culling is on, polygons facing towards camera are not drawn.


Member Data Documentation

double vtkProperty::Color[3] [protected]
 

Definition at line 232 of file vtkProperty.h.

double vtkProperty::AmbientColor[3] [protected]
 

Definition at line 235 of file vtkProperty.h.

double vtkProperty::DiffuseColor[3] [protected]
 

Definition at line 236 of file vtkProperty.h.

double vtkProperty::SpecularColor[3] [protected]
 

Definition at line 237 of file vtkProperty.h.

double vtkProperty::EdgeColor[3] [protected]
 

Definition at line 238 of file vtkProperty.h.

double vtkProperty::Ambient [protected]
 

Definition at line 239 of file vtkProperty.h.

double vtkProperty::Diffuse [protected]
 

Definition at line 240 of file vtkProperty.h.

double vtkProperty::Specular [protected]
 

Definition at line 241 of file vtkProperty.h.

double vtkProperty::SpecularPower [protected]
 

Definition at line 242 of file vtkProperty.h.

double vtkProperty::Opacity [protected]
 

Definition at line 243 of file vtkProperty.h.

float vtkProperty::PointSize [protected]
 

Definition at line 244 of file vtkProperty.h.

float vtkProperty::LineWidth [protected]
 

Definition at line 245 of file vtkProperty.h.

int vtkProperty::LineStipplePattern [protected]
 

Definition at line 246 of file vtkProperty.h.

int vtkProperty::LineStippleRepeatFactor [protected]
 

Definition at line 247 of file vtkProperty.h.

int vtkProperty::Interpolation [protected]
 

Definition at line 248 of file vtkProperty.h.

int vtkProperty::Representation [protected]
 

Definition at line 249 of file vtkProperty.h.

int vtkProperty::EdgeVisibility [protected]
 

Definition at line 250 of file vtkProperty.h.

int vtkProperty::BackfaceCulling [protected]
 

Definition at line 251 of file vtkProperty.h.

int vtkProperty::FrontfaceCulling [protected]
 

Definition at line 252 of file vtkProperty.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:11:36 2008 for VTK by  doxygen 1.4.3-20050530