Documentation for vtkProperty

vtkProperty - represent surface properties of a geometric object

Super Class: vtkObject

Description:

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

 

Methods:

void vtkProperty ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkProperty *New ()
void Render (vtkActor * ,vtkRenderer *)
void BackfaceRender (vtkActor * ,vtkRenderer *)
void SetInterpolation (int )
int GetInterpolation ()
void SetInterpolationToFlat ()
void SetInterpolationToGouraud ()
void SetInterpolationToPhong ()
char *GetInterpolationAsString ()
void SetRepresentation (int )
int GetRepresentation ()
void SetRepresentationToPoints ()
void SetRepresentationToWireframe ()
void SetRepresentationToSurface ()
char *GetRepresentationAsString ()
void SetColor (float ,float ,float )
void SetColor (float )
float *GetColor ()
void GetColor (float )
void SetAmbient (float )
float GetAmbient ()
void SetDiffuse (float )
float GetDiffuse ()
void SetSpecular (float )
float GetSpecular ()
void SetSpecularPower (float )
float GetSpecularPower ()
void SetOpacity (float )
float GetOpacity ()
int GetEdgeVisibility ()
void SetEdgeVisibility (int )
void EdgeVisibilityOn ()
void EdgeVisibilityOff ()
void SetAmbientColor (float ,float ,float )
void SetAmbientColor (float *)
float *GetAmbientColor ()
void SetDiffuseColor (float ,float ,float )
void SetDiffuseColor (float *)
float *GetDiffuseColor ()
void SetSpecularColor (float ,float ,float )
void SetSpecularColor (float *)
float *GetSpecularColor ()
void SetEdgeColor (float ,float ,float )
void SetEdgeColor (float *)
float *GetEdgeColor ()
int GetBackfaceCulling ()
void SetBackfaceCulling (int )
void BackfaceCullingOn ()
void BackfaceCullingOff ()
int GetFrontfaceCulling ()
void SetFrontfaceCulling (int )
void FrontfaceCullingOn ()
void FrontfaceCullingOff ()

 

Detailed Method Descriptions:

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.

static vtkProperty *New ()

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.

void Render (vtkActor * ,vtkRenderer *)

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 BackfaceRender (vtkActor * ,vtkRenderer *)

Set the shading interpolation method for an object.

void SetInterpolation (int )
int GetInterpolation ()
void SetInterpolationToFlat ()
void SetInterpolationToGouraud ()
void SetInterpolationToPhong ()
char *GetInterpolationAsString ()

Control the surface geometry representation for the object.

void SetRepresentation (int )
int GetRepresentation ()
void SetRepresentationToPoints ()
void SetRepresentationToWireframe ()
void SetRepresentationToSurface ()
char *GetRepresentationAsString ()

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 SetColor (float ,float ,float )
void SetColor (float )
float *GetColor ()
void GetColor (float )

Set/Get the ambient lighting coefficient.

void SetAmbient (float )
float GetAmbient ()

Set/Get the diffuse lighting coefficient.

void SetDiffuse (float )
float GetDiffuse ()

Set/Get the specular lighting coefficient.

void SetSpecular (float )
float GetSpecular ()

Set/Get the specular power.

void SetSpecularPower (float )
float GetSpecularPower ()

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

void SetOpacity (float )
float GetOpacity ()

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

int GetEdgeVisibility ()
void SetEdgeVisibility (int )
void EdgeVisibilityOn ()
void EdgeVisibilityOff ()

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.

void SetAmbientColor (float ,float ,float )
void SetAmbientColor (float *)
float *GetAmbientColor ()

Set/Get the diffuse surface color.

void SetDiffuseColor (float ,float ,float )
void SetDiffuseColor (float *)
float *GetDiffuseColor ()

Set/Get the specular surface color.

void SetSpecularColor (float ,float ,float )
void SetSpecularColor (float *)
float *GetSpecularColor ()

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

void SetEdgeColor (float ,float ,float )
void SetEdgeColor (float *)
float *GetEdgeColor ()

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.

int GetBackfaceCulling ()
void SetBackfaceCulling (int )
void BackfaceCullingOn ()
void BackfaceCullingOff ()

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.

int GetFrontfaceCulling ()
void SetFrontfaceCulling (int )
void FrontfaceCullingOn ()
void FrontfaceCullingOff ()