vtkProperty Class Reference

#include <vtkProperty.h>

Inheritance diagram for vtkProperty:

[legend]Collaboration diagram for vtkProperty:

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 61 of file vtkProperty.h.

Public Types

typedef vtkObject Superclass

VTK_TEXTURE_UNIT_0 = 0

VTK_TEXTURE_UNIT_1

VTK_TEXTURE_UNIT_2

VTK_TEXTURE_UNIT_3

VTK_TEXTURE_UNIT_4

VTK_TEXTURE_UNIT_5

VTK_TEXTURE_UNIT_6

VTK_TEXTURE_UNIT_7

enum VTKTextureUnit {
VTK_TEXTURE_UNIT_0 = 0, VTK_TEXTURE_UNIT_1, VTK_TEXTURE_UNIT_2, VTK_TEXTURE_UNIT_3,
VTK_TEXTURE_UNIT_4, VTK_TEXTURE_UNIT_5, VTK_TEXTURE_UNIT_6, VTK_TEXTURE_UNIT_7
}

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 *)

void LoadMaterial (const char *name)

void LoadMaterialFromString (const char *materialxml)

void LoadMaterial (vtkXMLMaterial *)

void RemoveTexture (const char *name)

void RemoveAllTextures ()

int GetNumberOfTextures ()

virtual void ReleaseGraphicsResources (vtkWindow *win)

virtual void PostRender (vtkActor *, vtkRenderer *)

virtual void SetInterpolation (int)

virtual int GetInterpolation ()

void SetInterpolationToFlat ()

void SetInterpolationToGouraud ()

void SetInterpolationToPhong ()

const char * GetInterpolationAsString ()

virtual void SetRepresentation (int)

virtual int GetRepresentation ()

void SetRepresentationToPoints ()

void SetRepresentationToWireframe ()

void SetRepresentationToSurface ()

const char * GetRepresentationAsString ()

void SetColor (double r, double g, double b)

void SetColor (double a[3])

double * GetColor ()

void GetColor (double rgb[3])

void GetColor (double &r, double &g, double &b)

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 &, double &, double &)

virtual void GetAmbientColor (double[3])

virtual void SetDiffuseColor (double, double, double)

virtual void SetDiffuseColor (double[3])

virtual double * GetDiffuseColor ()

virtual void GetDiffuseColor (double &, double &, double &)

virtual void GetDiffuseColor (double[3])

virtual void SetSpecularColor (double, double, double)

virtual void SetSpecularColor (double[3])

virtual double * GetSpecularColor ()

virtual void GetSpecularColor (double &, double &, double &)

virtual void GetSpecularColor (double[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 &, double &, double &)

virtual void GetEdgeColor (double[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 ()

virtual vtkXMLMaterial * GetMaterial ()

virtual char * GetMaterialName ()

virtual void SetShading (int)

virtual int GetShading ()

virtual void ShadingOn ()

virtual void ShadingOff ()

virtual vtkShaderProgram * GetShaderProgram ()

virtual void AddShaderVariable (const char *name, int numVars, int *x)

virtual void AddShaderVariable (const char *name, int numVars, float *x)

virtual void AddShaderVariable (const char *name, int numVars, double *x)

void AddShaderVariable (const char *name, int v)

void AddShaderVariable (const char *name, float v)

void AddShaderVariable (const char *name, double v)

void AddShaderVariable (const char *name, int v1, int v2)

void AddShaderVariable (const char *name, float v1, float v2)

void AddShaderVariable (const char *name, double v1, double v2)

void AddShaderVariable (const char *name, int v1, int v2, int v3)

void AddShaderVariable (const char *name, float v1, float v2, float v3)

void AddShaderVariable (const char *name, double v1, double v2, double v3)

void SetTexture (const char *name, vtkTexture *texture)

vtkTexture * GetTexture (const char *name)

void SetTexture (int unit, vtkTexture *texture)

vtkTexture * GetTexture (int unit)

void RemoveTexture (int unit)

Static Public Member Functions

static int IsTypeOf (const char *type)

static vtkProperty * SafeDownCast (vtkObject *o)

static vtkProperty * New ()

Protected Member Functions

vtkProperty ()

~vtkProperty ()

virtual void SetMaterialName (const char *)

void SetShaderProgram (vtkShaderProgram *)

vtkTexture * GetTextureAtIndex (int index)

int GetTextureUnitAtIndex (int index)

int GetTextureUnit (const char *name)

void LoadProperty ()

void LoadTextures ()

void LoadTexture (vtkXMLDataElement *elem)

void LoadPerlineNoise (vtkXMLDataElement *)

void LoadMember (vtkXMLDataElement *elem)

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

int Shading

char * MaterialName

vtkShaderProgram * ShaderProgram

vtkXMLMaterial * Material

Friends

class vtkGLSLShaderProgram

class vtkShader

Member Typedef Documentation

typedef vtkObject vtkProperty::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

Definition at line 64 of file vtkProperty.h.

Member Enumeration Documentation

enum vtkProperty::VTKTextureUnit

Used to specify which texture unit a texture will use. Only relevant when multitexturing. BTX

Enumerator:

VTK_TEXTURE_UNIT_0
VTK_TEXTURE_UNIT_1
VTK_TEXTURE_UNIT_2
VTK_TEXTURE_UNIT_3
VTK_TEXTURE_UNIT_4
VTK_TEXTURE_UNIT_5
VTK_TEXTURE_UNIT_6
VTK_TEXTURE_UNIT_7

Definition at line 390 of file vtkProperty.h.

Constructor & Destructor Documentation

vtkProperty::vtkProperty ( ) [protected]

vtkProperty::~vtkProperty ( ) [protected]

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 *
	)			`[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.

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 89 of file vtkProperty.h.

virtual void vtkProperty::PostRender	(	vtkActor *	,
		vtkRenderer *
	)			`[virtual]`

This method is called after the actor has been rendered. Don't call this directly. This method cleans up any shaders allocated.

Reimplemented in vtkOpenGLProperty.

virtual void vtkProperty::SetInterpolation ( int ) [virtual]

Set the shading interpolation method for an object.

virtual int vtkProperty::GetInterpolation ( ) [virtual]

Set the shading interpolation method for an object.

void vtkProperty::SetInterpolationToFlat ( ) [inline]

Set the shading interpolation method for an object.

Definition at line 103 of file vtkProperty.h.

References VTK_FLAT.

void vtkProperty::SetInterpolationToGouraud ( ) [inline]

Set the shading interpolation method for an object.

Definition at line 104 of file vtkProperty.h.

References VTK_GOURAUD.

void vtkProperty::SetInterpolationToPhong ( ) [inline]

Set the shading interpolation method for an object.

Definition at line 105 of file vtkProperty.h.

References VTK_PHONG.

const char * vtkProperty::GetInterpolationAsString ( void ) [inline]

Return the method of shading as a descriptive character string.

Definition at line 468 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 113 of file vtkProperty.h.

References VTK_POINTS.

void vtkProperty::SetRepresentationToWireframe ( ) [inline]

Control the surface geometry representation for the object.

Definition at line 114 of file vtkProperty.h.

References VTK_WIREFRAME.

void vtkProperty::SetRepresentationToSurface ( ) [inline]

Control the surface geometry representation for the object.

Definition at line 116 of file vtkProperty.h.

References VTK_SURFACE.

const char * vtkProperty::GetRepresentationAsString ( void ) [inline]

Return the method of shading as a descriptive character string.

Definition at line 486 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 125 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.

void vtkProperty::GetColor	(	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.

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]

virtual double* vtkProperty::GetAmbientColor ( ) [virtual]

virtual void vtkProperty::GetAmbientColor	(	double &	,
		double &	,
		double &
	)			`[virtual]`

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

virtual void vtkProperty::SetDiffuseColor	(	double	,
		double	,
		double
	)			`[virtual]`