represent surface properties of a geometric object More...

#include <vtkProperty.h>

Inheritance diagram for vtkProperty:

Collaboration diagram for vtkProperty:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkProperty *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	DeepCopy (vtkProperty *p)
	Assign one property to another. More...

virtual void	Render (vtkActor , vtkRenderer )
	This method causes the property to set up whatever is required for its instance variables. More...

virtual void	BackfaceRender (vtkActor , vtkRenderer )
	This method renders the property as a backface property. More...

virtual void	PostRender (vtkActor , vtkRenderer )
	This method is called after the actor has been rendered. More...

virtual vtkShaderDeviceAdapter2 *	GetShaderDeviceAdapter2 ()
	Get the vtkShaderDeviceAdapter2 if set, returns null otherwise. More...

void	SetBaseColorTexture (vtkTexture *texture)
	Set the base color texture. More...

void	SetORMTexture (vtkTexture *texture)
	Set the ORM texture. More...

void	SetNormalTexture (vtkTexture *texture)
	Set the normal texture. More...

void	SetEmissiveTexture (vtkTexture *texture)
	Set the emissive texture. More...

void	RemoveTexture (const char *name)
	Remove a texture from the collection. More...

void	RemoveAllTextures ()
	Remove all the textures. More...

int	GetNumberOfTextures ()
	Returns the number of textures in this property. More...

std::map< std::string, vtkTexture * > &	GetAllTextures ()
	Returns all the textures in this property and their names. More...

virtual void	ReleaseGraphicsResources (vtkWindow *win)
	Release any graphics resources that are being consumed by this property. More...


virtual bool	GetLighting ()
	Set/Get lighting flag for an object. More...

virtual void	SetLighting (bool)
	Set/Get lighting flag for an object. More...

virtual void	LightingOn ()
	Set/Get lighting flag for an object. More...

virtual void	LightingOff ()
	Set/Get lighting flag for an object. More...


virtual bool	GetRenderPointsAsSpheres ()
	Set/Get rendering of points as spheres. More...

virtual void	SetRenderPointsAsSpheres (bool)
	Set/Get rendering of points as spheres. More...

virtual void	RenderPointsAsSpheresOn ()
	Set/Get rendering of points as spheres. More...

virtual void	RenderPointsAsSpheresOff ()
	Set/Get rendering of points as spheres. More...


virtual bool	GetRenderLinesAsTubes ()
	Set/Get rendering of lines as tubes. More...

virtual void	SetRenderLinesAsTubes (bool)
	Set/Get rendering of lines as tubes. More...

virtual void	RenderLinesAsTubesOn ()
	Set/Get rendering of lines as tubes. More...

virtual void	RenderLinesAsTubesOff ()
	Set/Get rendering of lines as tubes. More...


virtual void	SetInterpolation (int)
	Set the shading interpolation method for an object. More...

virtual int	GetInterpolation ()
	Set the shading interpolation method for an object. More...

void	SetInterpolationToFlat ()
	Set the shading interpolation method for an object. More...

void	SetInterpolationToGouraud ()
	Set the shading interpolation method for an object. More...

void	SetInterpolationToPhong ()
	Set the shading interpolation method for an object. More...

void	SetInterpolationToPBR ()
	Set the shading interpolation method for an object. More...

const char *	GetInterpolationAsString ()
	Return the method of shading as a descriptive character string. More...


virtual void	SetRepresentation (int)
	Control the surface geometry representation for the object. More...

virtual int	GetRepresentation ()
	Control the surface geometry representation for the object. More...

void	SetRepresentationToPoints ()
	Control the surface geometry representation for the object. More...

void	SetRepresentationToWireframe ()
	Control the surface geometry representation for the object. More...

void	SetRepresentationToSurface ()
	Control the surface geometry representation for the object. More...

const char *	GetRepresentationAsString ()
	Return the method of shading as a descriptive character string. More...


virtual void	SetColor (double r, double g, double b)
	Set the color of the object. More...

virtual void	SetColor (double a[3])
	Set the color of the object. More...

double *	GetColor ()
	Set the color of the object. More...

void	GetColor (double rgb[3])
	Set the color of the object. More...

void	GetColor (double &r, double &g, double &b)
	Set the color of the object. More...


virtual void	SetMetallic (double)
	Set/Get the metallic coefficient. More...

virtual double	GetMetallic ()
	Set/Get the metallic coefficient. More...


virtual void	SetRoughness (double)
	Set/Get the roughness coefficient. More...

virtual double	GetRoughness ()
	Set/Get the roughness coefficient. More...


virtual void	SetNormalScale (double)
	Set/Get the normal scale coefficient. More...

virtual double	GetNormalScale ()
	Set/Get the normal scale coefficient. More...


virtual void	SetOcclusionStrength (double)
	Set/Get the occlusion strength coefficient. More...

virtual double	GetOcclusionStrength ()
	Set/Get the occlusion strength coefficient. More...


virtual void	SetEmissiveFactor (double, double, double)
	Set/Get the emissive factor. More...

virtual void	SetEmissiveFactor (double[3])
	Set/Get the emissive factor. More...

virtual double *	GetEmissiveFactor ()
	Set/Get the emissive factor. More...

virtual void	GetEmissiveFactor (double &, double &, double &)
	Set/Get the emissive factor. More...

virtual void	GetEmissiveFactor (double[3])
	Set/Get the emissive factor. More...


virtual void	SetAmbient (double)
	Set/Get the ambient lighting coefficient. More...

virtual double	GetAmbient ()
	Set/Get the ambient lighting coefficient. More...


virtual void	SetDiffuse (double)
	Set/Get the diffuse lighting coefficient. More...

virtual double	GetDiffuse ()
	Set/Get the diffuse lighting coefficient. More...


virtual void	SetSpecular (double)
	Set/Get the specular lighting coefficient. More...

virtual double	GetSpecular ()
	Set/Get the specular lighting coefficient. More...


virtual void	SetSpecularPower (double)
	Set/Get the specular power. More...

virtual double	GetSpecularPower ()
	Set/Get the specular power. More...


virtual void	SetOpacity (double)
	Set/Get the object's opacity. More...

virtual double	GetOpacity ()
	Set/Get the object's opacity. More...


virtual void	SetAmbientColor (double, double, double)
	Set/Get the ambient surface color. More...

virtual void	SetAmbientColor (double[3])
	Set/Get the ambient surface color. More...

virtual double *	GetAmbientColor ()
	Set/Get the ambient surface color. More...

virtual void	GetAmbientColor (double &, double &, double &)
	Set/Get the ambient surface color. More...

virtual void	GetAmbientColor (double[3])
	Set/Get the ambient surface color. More...


virtual void	SetDiffuseColor (double, double, double)
	Set/Get the diffuse surface color. More...

virtual void	SetDiffuseColor (double[3])
	Set/Get the diffuse surface color. More...

virtual double *	GetDiffuseColor ()
	Set/Get the diffuse surface color. More...

virtual void	GetDiffuseColor (double &, double &, double &)
	Set/Get the diffuse surface color. More...

virtual void	GetDiffuseColor (double[3])
	Set/Get the diffuse surface color. More...


virtual void	SetSpecularColor (double, double, double)
	Set/Get the specular surface color. More...

virtual void	SetSpecularColor (double[3])
	Set/Get the specular surface color. More...

virtual double *	GetSpecularColor ()
	Set/Get the specular surface color. More...

virtual void	GetSpecularColor (double &, double &, double &)
	Set/Get the specular surface color. More...

virtual void	GetSpecularColor (double[3])
	Set/Get the specular surface color. More...


virtual vtkTypeBool	GetEdgeVisibility ()
	Turn on/off the visibility of edges. More...

virtual void	SetEdgeVisibility (vtkTypeBool)
	Turn on/off the visibility of edges. More...

virtual void	EdgeVisibilityOn ()
	Turn on/off the visibility of edges. More...

virtual void	EdgeVisibilityOff ()
	Turn on/off the visibility of edges. More...


virtual void	SetEdgeColor (double, double, double)
	Set/Get the color of primitive edges (if edge visibility is enabled). More...

virtual void	SetEdgeColor (double[3])
	Set/Get the color of primitive edges (if edge visibility is enabled). More...

virtual double *	GetEdgeColor ()
	Set/Get the color of primitive edges (if edge visibility is enabled). More...

virtual void	GetEdgeColor (double &, double &, double &)
	Set/Get the color of primitive edges (if edge visibility is enabled). More...

virtual void	GetEdgeColor (double[3])
	Set/Get the color of primitive edges (if edge visibility is enabled). More...


virtual vtkTypeBool	GetVertexVisibility ()
	Turn on/off the visibility of vertices. More...

virtual void	SetVertexVisibility (vtkTypeBool)
	Turn on/off the visibility of vertices. More...

virtual void	VertexVisibilityOn ()
	Turn on/off the visibility of vertices. More...

virtual void	VertexVisibilityOff ()
	Turn on/off the visibility of vertices. More...


virtual void	SetVertexColor (double, double, double)
	Set/Get the color of primitive vertices (if vertex visibility is enabled). More...

virtual void	SetVertexColor (double[3])
	Set/Get the color of primitive vertices (if vertex visibility is enabled). More...

virtual double *	GetVertexColor ()
	Set/Get the color of primitive vertices (if vertex visibility is enabled). More...

virtual void	GetVertexColor (double &, double &, double &)
	Set/Get the color of primitive vertices (if vertex visibility is enabled). More...

virtual void	GetVertexColor (double[3])
	Set/Get the color of primitive vertices (if vertex visibility is enabled). More...


virtual void	SetLineWidth (float)
	Set/Get the width of a Line. More...

virtual float	GetLineWidth ()
	Set/Get the width of a Line. More...


virtual void	SetLineStipplePattern (int)
	Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). More...

virtual int	GetLineStipplePattern ()
	Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). More...


virtual void	SetLineStippleRepeatFactor (int)
	Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. More...

virtual int	GetLineStippleRepeatFactor ()
	Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. More...


virtual void	SetPointSize (float)
	Set/Get the diameter of a point. More...

virtual float	GetPointSize ()
	Set/Get the diameter of a point. More...


virtual vtkTypeBool	GetBackfaceCulling ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...

virtual void	SetBackfaceCulling (vtkTypeBool)
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...

virtual void	BackfaceCullingOn ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...

virtual void	BackfaceCullingOff ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...


virtual vtkTypeBool	GetFrontfaceCulling ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...

virtual void	SetFrontfaceCulling (vtkTypeBool)
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...

virtual void	FrontfaceCullingOn ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...

virtual void	FrontfaceCullingOff ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...


virtual void	SetMaterialName (const char *)
	Returns the name of the material currently loaded, if any. More...

virtual char *	GetMaterialName ()
	Returns the name of the material currently loaded, if any. More...


virtual void	SetShading (vtkTypeBool)
	Enable/Disable shading. More...

virtual vtkTypeBool	GetShading ()
	Enable/Disable shading. More...

virtual void	ShadingOn ()
	Enable/Disable shading. More...

virtual void	ShadingOff ()
	Enable/Disable shading. More...


virtual void	AddShaderVariable (const char name, int numVars, int x)
	Provide values to initialize shader variables. More...

virtual void	AddShaderVariable (const char name, int numVars, float x)
	Provide values to initialize shader variables. More...

virtual void	AddShaderVariable (const char name, int numVars, double x)
	Provide values to initialize shader variables. More...


void	AddShaderVariable (const char *name, int v)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, float v)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, double v)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, int v1, int v2)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, float v1, float v2)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, double v1, double v2)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, int v1, int v2, int v3)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, float v1, float v2, float v3)
	Methods to provide to add shader variables from wrappers. More...

void	AddShaderVariable (const char *name, double v1, double v2, double v3)
	Methods to provide to add shader variables from wrappers. More...


void	SetTexture (const char name, vtkTexture texture)
	Set/Get the texture object to control rendering texture maps. More...

vtkTexture *	GetTexture (const char *name)
	Set/Get the texture object to control rendering texture maps. More...


virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with the Property. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with the Property. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProperty *	SafeDownCast (vtkObjectBase *o)

static vtkProperty *	New ()
	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. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Types
typedef std::map< std::string, vtkTexture * >	MapOfTextures

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProperty ()

	~vtkProperty () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ComputeCompositeColor (double result[3], double ambient, const double ambient_color[3], double diffuse, const double diffuse_color[3], double specular, const double specular_color[3])
	Computes composite color. More...

Protected Attributes
double	Color [3]

double	AmbientColor [3]

double	DiffuseColor [3]

double	SpecularColor [3]

double	EdgeColor [3]

double	VertexColor [3]

double	Ambient

double	Diffuse

double	Metallic

double	Roughness

double	NormalScale

double	OcclusionStrength

double	EmissiveFactor [3]

double	Specular

double	SpecularPower

double	Opacity

float	PointSize

float	LineWidth

int	LineStipplePattern

int	LineStippleRepeatFactor

int	Interpolation

int	Representation

vtkTypeBool	EdgeVisibility

vtkTypeBool	VertexVisibility

vtkTypeBool	BackfaceCulling

vtkTypeBool	FrontfaceCulling

bool	Lighting

bool	RenderPointsAsSpheres

bool	RenderLinesAsTubes

vtkTypeBool	Shading

char *	MaterialName

MapOfTextures	Textures

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Member Typedef Documentation

typedef vtkObject vtkProperty::Superclass

Definition at line 71 of file vtkProperty.h.

typedef std::map<std::string, vtkTexture*> vtkProperty::MapOfTextures

protected

Definition at line 625 of file vtkProperty.h.

Constructor & Destructor Documentation

vtkProperty::vtkProperty ( )

protected

vtkProperty::~vtkProperty ( )

overrideprotected

Member Function Documentation

static vtkTypeBool vtkProperty::IsTypeOf ( const char * type )

static

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkRIBProperty, and vtkOpenGLProperty.

static vtkProperty* vtkProperty::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkProperty::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkRIBProperty, and vtkOpenGLProperty.

vtkProperty* vtkProperty::NewInstance ( ) const

void vtkProperty::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 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.

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, and vtkOpenGLProperty.

virtual void vtkProperty::BackfaceRender	(	vtkActor *	,
		vtkRenderer *
	)

inlinevirtual

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 vtkOpenGLProperty.

Definition at line 102 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 bool vtkProperty::GetRenderPointsAsSpheres ( )

virtual

Set/Get rendering of points as spheres.

The size of the sphere in pixels is controlled by the PointSize attribute. Note that half spheres may be rendered instead of spheres.

virtual void vtkProperty::SetRenderPointsAsSpheres ( bool )

virtual

Set/Get rendering of points as spheres.

The size of the sphere in pixels is controlled by the PointSize attribute. Note that half spheres may be rendered instead of spheres.

virtual void vtkProperty::RenderPointsAsSpheresOn ( )

virtual

Set/Get rendering of points as spheres.

The size of the sphere in pixels is controlled by the PointSize attribute. Note that half spheres may be rendered instead of spheres.

virtual void vtkProperty::RenderPointsAsSpheresOff ( )

virtual

Set/Get rendering of points as spheres.

The size of the sphere in pixels is controlled by the PointSize attribute. Note that half spheres may be rendered instead of spheres.

virtual bool vtkProperty::GetRenderLinesAsTubes ( )

virtual

Set/Get rendering of lines as tubes.

The width of the line in pixels is controlled by the LineWidth attribute. May not be supported on every platform and the implementation may be half tubes, or something only tube like in appearance.

virtual void vtkProperty::SetRenderLinesAsTubes ( bool )

virtual

Set/Get rendering of lines as tubes.

The width of the line in pixels is controlled by the LineWidth attribute. May not be supported on every platform and the implementation may be half tubes, or something only tube like in appearance.

virtual void vtkProperty::RenderLinesAsTubesOn ( )

virtual

Set/Get rendering of lines as tubes.

The width of the line in pixels is controlled by the LineWidth attribute. May not be supported on every platform and the implementation may be half tubes, or something only tube like in appearance.

virtual void vtkProperty::RenderLinesAsTubesOff ( )

virtual

Set/Get rendering of lines as tubes.

The width of the line in pixels is controlled by the LineWidth attribute. May not be supported on every platform and the implementation may be half tubes, or something only tube like in appearance.

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

void vtkProperty::SetInterpolationToGouraud ( )

inline

Set the shading interpolation method for an object.

Definition at line 153 of file vtkProperty.h.

void vtkProperty::SetInterpolationToPhong ( )

inline

Set the shading interpolation method for an object.

Definition at line 155 of file vtkProperty.h.

void vtkProperty::SetInterpolationToPBR ( )

inline

Set the shading interpolation method for an object.

Definition at line 157 of file vtkProperty.h.

const char * vtkProperty::GetInterpolationAsString ( void )

inline

Return the method of shading as a descriptive character string.

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

void vtkProperty::SetRepresentationToWireframe ( )

inline

Control the surface geometry representation for the object.

Definition at line 170 of file vtkProperty.h.

void vtkProperty::SetRepresentationToSurface ( )

inline

Control the surface geometry representation for the object.

Definition at line 172 of file vtkProperty.h.

const char * vtkProperty::GetRepresentationAsString ( void )

inline

Return the method of shading as a descriptive character string.

Definition at line 665 of file vtkProperty.h.

virtual void vtkProperty::SetColor	(	double	r,
		double	g,
		double	b
	)

virtual

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::SetColor ( double a[3] )

virtual

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.

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::SetMetallic ( double )

virtual

Set/Get the metallic coefficient.

Usually this value is either 0 or 1 for real material but any value in between is valid. This parameter is only used by PBR Interpolation. Default value is 0.0

virtual double vtkProperty::GetMetallic ( )

virtual

Set/Get the metallic coefficient.

Usually this value is either 0 or 1 for real material but any value in between is valid. This parameter is only used by PBR Interpolation. Default value is 0.0

virtual void vtkProperty::SetRoughness ( double )

virtual

Set/Get the roughness coefficient.

This value have to be between 0 (glossy) and 1 (rough). A glossy material have reflections and a high specular part. This parameter is only used by PBR Interpolation. Default value is 0.5

virtual double vtkProperty::GetRoughness ( )

virtual

Set/Get the roughness coefficient.

This value have to be between 0 (glossy) and 1 (rough). A glossy material have reflections and a high specular part. This parameter is only used by PBR Interpolation. Default value is 0.5

virtual void vtkProperty::SetNormalScale ( double )

virtual

Set/Get the normal scale coefficient.

This value affects the strength of the normal deviation from the texture. Default value is 1.0

virtual double vtkProperty::GetNormalScale ( )

virtual

Set/Get the normal scale coefficient.

This value affects the strength of the normal deviation from the texture. Default value is 1.0

virtual void vtkProperty::SetOcclusionStrength ( double )

virtual

Set/Get the occlusion strength coefficient.

This value affects the strength of the occlusion if a material texture is present. This parameter is only used by PBR Interpolation. Default value is 1.0

virtual double vtkProperty::GetOcclusionStrength ( )

virtual

Set/Get the occlusion strength coefficient.

This value affects the strength of the occlusion if a material texture is present. This parameter is only used by PBR Interpolation. Default value is 1.0

virtual void vtkProperty::SetEmissiveFactor	(	double	,
		double	,
		double
	)

virtual

Set/Get the emissive factor.

This value is multiplied with the emissive color when an emissive texture is present. This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

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

virtual

Set/Get the emissive factor.

This value is multiplied with the emissive color when an emissive texture is present. This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

virtual double* vtkProperty::GetEmissiveFactor ( )

virtual

Set/Get the emissive factor.

This value is multiplied with the emissive color when an emissive texture is present. This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

virtual void vtkProperty::GetEmissiveFactor	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the emissive factor.

This value is multiplied with the emissive color when an emissive texture is present. This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

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

virtual

Set/Get the emissive factor.

This value is multiplied with the emissive color when an emissive texture is present. This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

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.

For PBR Interpolation, DiffuseColor is used as the base color

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

virtual double* vtkProperty::GetDiffuseColor ( )

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base 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 vtkTypeBool 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 ( vtkTypeBool )

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 vtkTypeBool vtkProperty::GetVertexVisibility ( )

virtual

Turn on/off the visibility of vertices.

On some renderers it is possible to render the vertices of geometric primitives separately from the interior.

virtual void vtkProperty::SetVertexVisibility ( vtkTypeBool )

virtual

Turn on/off the visibility of vertices.

On some renderers it is possible to render the vertices of geometric primitives separately from the interior.

virtual void vtkProperty::VertexVisibilityOn ( )

virtual

Turn on/off the visibility of vertices.

On some renderers it is possible to render the vertices of geometric primitives separately from the interior.

virtual void vtkProperty::VertexVisibilityOff ( )

virtual

Turn on/off the visibility of vertices.

On some renderers it is possible to render the vertices of geometric primitives separately from the interior.

virtual void vtkProperty::SetVertexColor	(	double	,
		double	,
		double
	)

virtual

Set/Get the color of primitive vertices (if vertex visibility is enabled).

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

virtual

Set/Get the color of primitive vertices (if vertex visibility is enabled).

virtual double* vtkProperty::GetVertexColor ( )

virtual

Set/Get the color of primitive vertices (if vertex visibility is enabled).

virtual void vtkProperty::GetVertexColor	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the color of primitive vertices (if vertex visibility is enabled).

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

virtual

Set/Get the color of primitive vertices (if vertex 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, not OpenGL2. 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, not OpenGL2. 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, not OpenGL2. 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, not OpenGL2. 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 vtkTypeBool 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 ( vtkTypeBool )

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 vtkTypeBool 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 ( vtkTypeBool )

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 void vtkProperty::SetMaterialName ( const char * )

virtual

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

virtual char* vtkProperty::GetMaterialName ( )

virtual

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

virtual void vtkProperty::SetShading ( vtkTypeBool )

virtual

Enable/Disable shading.

When shading is enabled, the Material must be set.

virtual vtkTypeBool 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 vtkShaderDeviceAdapter2* vtkProperty::GetShaderDeviceAdapter2 ( )

inlinevirtual

Get the vtkShaderDeviceAdapter2 if set, returns null otherwise.

Definition at line 433 of file vtkProperty.h.

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

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

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

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

inline