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


Public Types

typedef vtkObject Superclass
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 bool GetLighting ()
virtual void SetLighting (bool)
virtual void LightingOn ()
virtual void LightingOff ()
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 vtkXMLMaterialGetMaterial ()
virtual char * GetMaterialName ()
virtual void SetShading (int)
virtual int GetShading ()
virtual void ShadingOn ()
virtual void ShadingOff ()
virtual vtkShaderProgramGetShaderProgram ()
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)
vtkTextureGetTexture (const char *name)
void SetTexture (int unit, vtkTexture *texture)
vtkTextureGetTexture (int unit)
void RemoveTexture (int unit)

Static Public Member Functions

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

Protected Member Functions

 vtkProperty ()
 ~vtkProperty ()
virtual void SetMaterialName (const char *)
void SetShaderProgram (vtkShaderProgram *)
virtual void ReadFrameworkMaterial ()
vtkTextureGetTextureAtIndex (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
bool Lighting
int Shading
char * MaterialName
vtkShaderProgramShaderProgram
vtkXMLMaterialMaterial

Friends

class vtkGLSLShaderProgram
class vtkShader

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

Definition at line 64 of file vtkProperty.h.


Member Enumeration Documentation

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 397 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 *  name  )  [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkRIBProperty, vtkMesaProperty, and vtkOpenGLProperty.

virtual int vtkProperty::IsA ( const char *  name  )  [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 vtkTypeMacro 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 bool vtkProperty::GetLighting (  )  [virtual]

Set/Get lighting flag for an object. Initial value is true.

virtual void vtkProperty::SetLighting ( bool   )  [virtual]

Set/Get lighting flag for an object. Initial value is true.

virtual void vtkProperty::LightingOn (  )  [virtual]

Set/Get lighting flag for an object. Initial value is true.

virtual void vtkProperty::LightingOff (  )  [virtual]

Set/Get lighting flag for an object. Initial value is true.

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

void vtkProperty::SetInterpolationToGouraud (  )  [inline]

Set the shading interpolation method for an object.

Definition at line 111 of file vtkProperty.h.

void vtkProperty::SetInterpolationToPhong (  )  [inline]

Set the shading interpolation method for an object.

Definition at line 112 of file vtkProperty.h.

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

Return the method of shading as a descriptive character string.

Definition at line 480 of file vtkProperty.h.

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

void vtkProperty::SetRepresentationToWireframe (  )  [inline]

Control the surface geometry representation for the object.

Definition at line 121 of file vtkProperty.h.

void vtkProperty::SetRepresentationToSurface (  )  [inline]

Control the surface geometry representation for the object.

Definition at line 123 of file vtkProperty.h.

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

Return the method of shading as a descriptive character string.

Definition at line 498 of file vtkProperty.h.

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 132 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]

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 &  ,
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::GetAmbientColor ( 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 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 &  ,
double &  ,
double &   
) [virtual]

Set/Get the diffuse surface color.

virtual void vtkProperty::GetDiffuseColor ( double  [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 &  ,
double &  ,
double &   
) [virtual]

Set/Get the specular surface color.

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

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

virtual void vtkProperty::GetEdgeColor ( double  [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.

virtual vtkXMLMaterial* vtkProperty::GetMaterial (  )  [virtual]

Get the material representation used for shading. The material will be used only when shading is enabled.

virtual char* vtkProperty::GetMaterialName (  )  [virtual]

Returns the name of the material currenly loaded, if any.

void vtkProperty::LoadMaterial ( const char *  name  ) 

Load the material. The material can be the name of a built-on material or the filename for a VTK material XML description.

void vtkProperty::LoadMaterialFromString ( const char *  materialxml  ) 

Load the material given the contents of the material file.

void vtkProperty::LoadMaterial ( vtkXMLMaterial  ) 

Load the material given the material representation.

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

Enable/Disable shading. When shading is enabled, the Material must be set.

virtual int vtkProperty::GetShading (  )  [virtual]

Enable/Disable shading. When shading is enabled, the Material must be set.

virtual void vtkProperty::ShadingOn (  )  [virtual]

Enable/Disable shading. When shading is enabled, the Material must be set.

virtual void vtkProperty::ShadingOff (  )  [virtual]

Enable/Disable shading. When shading is enabled, the Material must be set.

virtual vtkShaderProgram* vtkProperty::GetShaderProgram (  )  [virtual]

Get the Shader program. If Material is not set/or not loaded properly, this will return null.

virtual void vtkProperty::AddShaderVariable ( const char *  name,
int  numVars,
int *  x 
) [virtual]

Provide values to initialize shader variables. Useful to initialize shader variables that change over time (animation, GUI widgets inputs, etc. ) - name - hardware name of the uniform variable - numVars - number of variables being set - x - values

Reimplemented in vtkOpenGLProperty.

virtual void vtkProperty::AddShaderVariable ( const char *  name,
int  numVars,
float *  x 
) [virtual]

Provide values to initialize shader variables. Useful to initialize shader variables that change over time (animation, GUI widgets inputs, etc. ) - name - hardware name of the uniform variable - numVars - number of variables being set - x - values

Reimplemented in vtkOpenGLProperty.

virtual void vtkProperty::AddShaderVariable ( const char *  name,
int  numVars,
double *  x 
) [virtual]

Provide values to initialize shader variables. Useful to initialize shader variables that change over time (animation, GUI widgets inputs, etc. ) - name - hardware name of the uniform variable - numVars - number of variables being set - x - values

Reimplemented in vtkOpenGLProperty.

void vtkProperty::AddShaderVariable ( const char *  name,
int  v 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 300 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
float  v 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 304 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
double  v 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 308 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
int  v1,
int  v2 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 312 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
float  v1,
float  v2 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 319 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
double  v1,
double  v2 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 326 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
int  v1,
int  v2,
int  v3 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 333 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
float  v1,
float  v2,
float  v3 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 341 of file vtkProperty.h.

void vtkProperty::AddShaderVariable ( const char *  name,
double  v1,
double  v2,
double  v3 
) [inline]

Methods to provide to add shader variables from tcl.

Definition at line 349 of file vtkProperty.h.

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

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. A property does not need to have an associated texture map and multiple properties can share one texture. Textures must be assigned unique names.

vtkTexture* vtkProperty::GetTexture ( const char *  name  ) 

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. A property does not need to have an associated texture map and multiple properties can share one texture. Textures must be assigned unique names.

void vtkProperty::SetTexture ( int  unit,
vtkTexture texture 
)

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. A property does not need to have an associated texture map and multiple properties can share one texture. Textures must be assigned unique names.

vtkTexture* vtkProperty::GetTexture ( int  unit  ) 

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. A property does not need to have an associated texture map and multiple properties can share one texture. Textures must be assigned unique names.

void vtkProperty::RemoveTexture ( int  unit  ) 

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. A property does not need to have an associated texture map and multiple properties can share one texture. Textures must be assigned unique names.

void vtkProperty::RemoveTexture ( const char *  name  ) 

Remove a texture from the collection. Note that the indices of all the subsquent textures, if any, will change.

void vtkProperty::RemoveAllTextures (  ) 

Remove all the textures.

int vtkProperty::GetNumberOfTextures (  ) 

Returns the number of textures in this property.

virtual void vtkProperty::ReleaseGraphicsResources ( vtkWindow win  )  [virtual]

Release any graphics resources that are being consumed by this property. The parameter window could be used to determine which graphic resources to release.

Reimplemented in vtkOpenGLProperty.

void vtkProperty::LoadProperty (  )  [protected]

Load property iVar values from the Material XML.

void vtkProperty::LoadTextures (  )  [protected]

Load property iVar values from the Material XML.

void vtkProperty::LoadTexture ( vtkXMLDataElement elem  )  [protected]

Load property iVar values from the Material XML.

void vtkProperty::LoadPerlineNoise ( vtkXMLDataElement  )  [protected]

Load property iVar values from the Material XML.

void vtkProperty::LoadMember ( vtkXMLDataElement elem  )  [protected]

Load property iVar values from the Material XML.

virtual void vtkProperty::SetMaterialName ( const char *   )  [protected, virtual]

void vtkProperty::SetShaderProgram ( vtkShaderProgram  )  [protected]

virtual void vtkProperty::ReadFrameworkMaterial (  )  [protected, virtual]

Read this->Material from new style shaders. Default implementation is empty.

Reimplemented in vtkOpenGLProperty.

vtkTexture* vtkProperty::GetTextureAtIndex ( int  index  )  [protected]

int vtkProperty::GetTextureUnitAtIndex ( int  index  )  [protected]

int vtkProperty::GetTextureUnit ( const char *  name  )  [protected]


Friends And Related Function Documentation

friend class vtkGLSLShaderProgram [friend]

Definition at line 462 of file vtkProperty.h.

friend class vtkShader [friend]

Definition at line 463 of file vtkProperty.h.


Member Data Documentation

double vtkProperty::Color[3] [protected]

Definition at line 424 of file vtkProperty.h.

double vtkProperty::AmbientColor[3] [protected]

Definition at line 425 of file vtkProperty.h.

double vtkProperty::DiffuseColor[3] [protected]

Definition at line 426 of file vtkProperty.h.

double vtkProperty::SpecularColor[3] [protected]

Definition at line 427 of file vtkProperty.h.

double vtkProperty::EdgeColor[3] [protected]

Definition at line 428 of file vtkProperty.h.

double vtkProperty::Ambient [protected]

Definition at line 429 of file vtkProperty.h.

double vtkProperty::Diffuse [protected]

Definition at line 430 of file vtkProperty.h.

double vtkProperty::Specular [protected]

Definition at line 431 of file vtkProperty.h.

double vtkProperty::SpecularPower [protected]

Definition at line 432 of file vtkProperty.h.

double vtkProperty::Opacity [protected]

Definition at line 433 of file vtkProperty.h.

float vtkProperty::PointSize [protected]

Definition at line 434 of file vtkProperty.h.

float vtkProperty::LineWidth [protected]

Definition at line 435 of file vtkProperty.h.

Definition at line 436 of file vtkProperty.h.

Definition at line 437 of file vtkProperty.h.

int vtkProperty::Interpolation [protected]

Definition at line 438 of file vtkProperty.h.

int vtkProperty::Representation [protected]

Definition at line 439 of file vtkProperty.h.

int vtkProperty::EdgeVisibility [protected]

Definition at line 440 of file vtkProperty.h.

Definition at line 441 of file vtkProperty.h.

Definition at line 442 of file vtkProperty.h.

bool vtkProperty::Lighting [protected]

Definition at line 443 of file vtkProperty.h.

int vtkProperty::Shading [protected]

Definition at line 445 of file vtkProperty.h.

char* vtkProperty::MaterialName [protected]

Definition at line 447 of file vtkProperty.h.

Definition at line 448 of file vtkProperty.h.

Definition at line 453 of file vtkProperty.h.


The documentation for this class was generated from the following file:

Generated on Mon Sep 27 18:43:35 2010 for VTK by  doxygen 1.5.6