vtkProperty Class Reference

represent surface properties of a geometric object More...

#include <vtkProperty.h>

Inheritance diagram for vtkProperty:

Collaboration diagram for vtkProperty:

Public Types
enum class	Point2DShapeType { Round , Square }
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.
vtkProperty *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	DeepCopy (vtkProperty *p)
	Assign one property to another.
virtual void	Render (vtkActor *, vtkRenderer *)
	This method causes the property to set up whatever is required for its instance variables.
virtual void	BackfaceRender (vtkActor *, vtkRenderer *)
	This method renders the property as a backface property.
virtual void	PostRender (vtkActor *, vtkRenderer *)
	This method is called after the actor has been rendered.
	vtkSetEnumMacro (Point2DShape, Point2DShapeType)
	Set/Get the 2D shape of points to use when RenderPointsAsSpheres=false.
	vtkGetEnumMacro (Point2DShape, Point2DShapeType)
void	SetBaseColorTexture (vtkTexture *texture)
	Set the base color texture.
void	SetORMTexture (vtkTexture *texture)
	Set the ORM texture.
void	SetAnisotropyTexture (vtkTexture *texture)
	Set the anisotropy texture.
void	SetNormalTexture (vtkTexture *texture)
	Set the normal texture.
void	SetEmissiveTexture (vtkTexture *texture)
	Set the emissive texture.
void	SetCoatNormalTexture (vtkTexture *texture)
	Set the coat normal texture.
void	RemoveTexture (const char *name)
	Remove a texture from the collection.
void	RemoveAllTextures ()
	Remove all the textures.
int	GetNumberOfTextures ()
	Returns the number of textures in this property.
std::map< std::string, vtkTexture * > &	GetAllTextures ()
	Returns all the textures in this property and their names.
virtual void	ReleaseGraphicsResources (vtkWindow *win)
	Release any graphics resources that are being consumed by this property.
virtual bool	GetLighting ()
	Set/Get lighting flag for an object.
virtual void	SetLighting (bool)
	Set/Get lighting flag for an object.
virtual void	LightingOn ()
	Set/Get lighting flag for an object.
virtual void	LightingOff ()
	Set/Get lighting flag for an object.
virtual bool	GetRenderPointsAsSpheres ()
	Set/Get rendering of points as spheres.
virtual void	SetRenderPointsAsSpheres (bool)
	Set/Get rendering of points as spheres.
virtual void	RenderPointsAsSpheresOn ()
	Set/Get rendering of points as spheres.
virtual void	RenderPointsAsSpheresOff ()
	Set/Get rendering of points as spheres.
virtual bool	GetRenderLinesAsTubes ()
	Set/Get rendering of lines as tubes.
virtual void	SetRenderLinesAsTubes (bool)
	Set/Get rendering of lines as tubes.
virtual void	RenderLinesAsTubesOn ()
	Set/Get rendering of lines as tubes.
virtual void	RenderLinesAsTubesOff ()
	Set/Get rendering of lines as tubes.
virtual void	SetInterpolation (int)
	Set the shading interpolation method for an object.
virtual int	GetInterpolation ()
	Set the shading interpolation method for an object.
void	SetInterpolationToFlat ()
	Set the shading interpolation method for an object.
void	SetInterpolationToGouraud ()
	Set the shading interpolation method for an object.
void	SetInterpolationToPhong ()
	Set the shading interpolation method for an object.
void	SetInterpolationToPBR ()
	Set the shading interpolation method for an object.
const char *	GetInterpolationAsString ()
	Return the method of shading as a descriptive character string.
virtual void	SetRepresentation (int)
	Control the surface geometry representation for the object.
virtual int	GetRepresentation ()
	Control the surface geometry representation for the object.
void	SetRepresentationToPoints ()
	Control the surface geometry representation for the object.
void	SetRepresentationToWireframe ()
	Control the surface geometry representation for the object.
void	SetRepresentationToSurface ()
	Control the surface geometry representation for the object.
const char *	GetRepresentationAsString ()
	Return the method of shading as a descriptive character string.
virtual void	SetColor (double r, double g, double b)
	Set the color of the object.
virtual void	SetColor (double a[3])
	Set the color of the object.
double *	GetColor ()
	Set the color of the object.
void	GetColor (double rgb[3])
	Set the color of the object.
void	GetColor (double &r, double &g, double &b)
	Set the color of the object.
virtual void	SetBaseIOR (double)
	Set/Get the Index Of Refraction of the base layer.
virtual double	GetBaseIOR ()
	Set/Get the Index Of Refraction of the base layer.
virtual void	SetMetallic (double)
	Set/Get the metallic coefficient.
virtual double	GetMetallic ()
	Set/Get the metallic coefficient.
virtual void	SetRoughness (double)
	Set/Get the roughness coefficient.
virtual double	GetRoughness ()
	Set/Get the roughness coefficient.
virtual void	SetAnisotropy (double)
	Set/Get the anisotropy coefficient.
virtual double	GetAnisotropy ()
	Set/Get the anisotropy coefficient.
virtual void	SetAnisotropyRotation (double)
	Set/Get the anisotropy rotation coefficient.
virtual double	GetAnisotropyRotation ()
	Set/Get the anisotropy rotation coefficient.
virtual void	SetCoatIOR (double)
	Set/Get the coat layer Index Of Refraction.
virtual double	GetCoatIOR ()
	Set/Get the coat layer Index Of Refraction.
virtual void	SetCoatRoughness (double)
	Set/Get the coat layer roughness coefficient.
virtual double	GetCoatRoughness ()
	Set/Get the coat layer roughness coefficient.
virtual void	SetCoatStrength (double)
	Set/Get the coat layer strength coefficient.
virtual double	GetCoatStrength ()
	Set/Get the coat layer strength coefficient.
virtual void	SetCoatColor (double, double, double)
	Set/Get the color of the coat layer.
virtual void	SetCoatColor (double[3])
	Set/Get the color of the coat layer.
virtual double *	GetCoatColor ()
	Set/Get the color of the coat layer.
virtual void	GetCoatColor (double &, double &, double &)
	Set/Get the color of the coat layer.
virtual void	GetCoatColor (double[3])
	Set/Get the color of the coat layer.
virtual void	SetCoatNormalScale (double)
	Set/Get the coat layer normal scale coefficient.
virtual double	GetCoatNormalScale ()
	Set/Get the coat layer normal scale coefficient.
virtual void	SetNormalScale (double)
	Set/Get the normal scale coefficient.
virtual double	GetNormalScale ()
	Set/Get the normal scale coefficient.
virtual void	SetOcclusionStrength (double)
	Set/Get the occlusion strength coefficient.
virtual double	GetOcclusionStrength ()
	Set/Get the occlusion strength coefficient.
virtual void	SetEmissiveFactor (double, double, double)
	Set/Get the emissive factor.
virtual void	SetEmissiveFactor (double[3])
	Set/Get the emissive factor.
virtual double *	GetEmissiveFactor ()
	Set/Get the emissive factor.
virtual void	GetEmissiveFactor (double &, double &, double &)
	Set/Get the emissive factor.
virtual void	GetEmissiveFactor (double[3])
	Set/Get the emissive factor.
virtual void	SetEdgeTint (double, double, double)
	Set/Get the edge tint (for metals only).
virtual void	SetEdgeTint (double[3])
	Set/Get the edge tint (for metals only).
virtual double *	GetEdgeTint ()
	Set/Get the edge tint (for metals only).
virtual void	GetEdgeTint (double &, double &, double &)
	Set/Get the edge tint (for metals only).
virtual void	GetEdgeTint (double[3])
	Set/Get the edge tint (for metals only).
virtual void	SetAmbient (double)
	Set/Get the ambient lighting coefficient.
virtual double	GetAmbient ()
	Set/Get the ambient lighting coefficient.
virtual void	SetDiffuse (double)
	Set/Get the diffuse lighting coefficient.
virtual double	GetDiffuse ()
	Set/Get the diffuse lighting coefficient.
virtual void	SetSpecular (double)
	Set/Get the specular lighting coefficient.
virtual double	GetSpecular ()
	Set/Get the specular lighting coefficient.
virtual void	SetSpecularPower (double)
	Set/Get the specular power.
virtual double	GetSpecularPower ()
	Set/Get the specular power.
virtual void	SetOpacity (double)
	Set/Get the object's opacity.
virtual double	GetOpacity ()
	Set/Get the object's opacity.
virtual void	SetEdgeOpacity (double)
	Set/Get the line opacity.
virtual double	GetEdgeOpacity ()
	Set/Get the line opacity.
virtual void	SetAmbientColor (double, double, double)
	Set/Get the ambient surface color.
virtual void	SetAmbientColor (double[3])
	Set/Get the ambient surface color.
virtual double *	GetAmbientColor ()
	Set/Get the ambient surface color.
virtual void	GetAmbientColor (double &, double &, double &)
	Set/Get the ambient surface color.
virtual void	GetAmbientColor (double[3])
	Set/Get the ambient surface color.
virtual void	SetDiffuseColor (double, double, double)
	Set/Get the diffuse surface color.
virtual void	SetDiffuseColor (double[3])
	Set/Get the diffuse surface color.
virtual double *	GetDiffuseColor ()
	Set/Get the diffuse surface color.
virtual void	GetDiffuseColor (double &, double &, double &)
	Set/Get the diffuse surface color.
virtual void	GetDiffuseColor (double[3])
	Set/Get the diffuse surface color.
virtual void	SetSpecularColor (double, double, double)
	Set/Get the specular surface color.
virtual void	SetSpecularColor (double[3])
	Set/Get the specular surface color.
virtual double *	GetSpecularColor ()
	Set/Get the specular surface color.
virtual void	GetSpecularColor (double &, double &, double &)
	Set/Get the specular surface color.
virtual void	GetSpecularColor (double[3])
	Set/Get the specular surface color.
virtual vtkTypeBool	GetEdgeVisibility ()
	Turn on/off the visibility of edges.
virtual void	SetEdgeVisibility (vtkTypeBool)
	Turn on/off the visibility of edges.
virtual void	EdgeVisibilityOn ()
	Turn on/off the visibility of edges.
virtual void	EdgeVisibilityOff ()
	Turn on/off the visibility of edges.
virtual void	SetEdgeColor (double, double, double)
	Set/Get the color of primitive edges (if edge visibility is enabled).
virtual void	SetEdgeColor (double[3])
	Set/Get the color of primitive edges (if edge visibility is enabled).
virtual double *	GetEdgeColor ()
	Set/Get the color of primitive edges (if edge visibility is enabled).
virtual void	GetEdgeColor (double &, double &, double &)
	Set/Get the color of primitive edges (if edge visibility is enabled).
virtual void	GetEdgeColor (double[3])
	Set/Get the color of primitive edges (if edge visibility is enabled).
virtual vtkTypeBool	GetVertexVisibility ()
	Turn on/off the visibility of vertices.
virtual void	SetVertexVisibility (vtkTypeBool)
	Turn on/off the visibility of vertices.
virtual void	VertexVisibilityOn ()
	Turn on/off the visibility of vertices.
virtual void	VertexVisibilityOff ()
	Turn on/off the visibility of vertices.
virtual void	SetVertexColor (double, double, double)
	Set/Get the color of primitive vertices (if vertex visibility is enabled).
virtual void	SetVertexColor (double[3])
	Set/Get the color of primitive vertices (if vertex visibility is enabled).
virtual double *	GetVertexColor ()
	Set/Get the color of primitive vertices (if vertex visibility is enabled).
virtual void	GetVertexColor (double &, double &, double &)
	Set/Get the color of primitive vertices (if vertex visibility is enabled).
virtual void	GetVertexColor (double[3])
	Set/Get the color of primitive vertices (if vertex visibility is enabled).
virtual void	SetSelectionColor (double, double, double, double)
	Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
virtual void	SetSelectionColor (double[4])
	Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
virtual double *	GetSelectionColor ()
	Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
virtual void	GetSelectionColor (double &, double &, double &, double &)
	Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
virtual void	GetSelectionColor (double[4])
	Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
virtual void	SetSelectionLineWidth (float)
	Set/Get the selection line width.
virtual float	GetSelectionLineWidth ()
	Set/Get the selection line width.
virtual void	SetSelectionPointSize (float)
	Set/Get the selection point size.
virtual float	GetSelectionPointSize ()
	Set/Get the selection point size.
virtual void	SetLineWidth (float)
	Set/Get the width of a Line.
virtual float	GetLineWidth ()
	Set/Get the width of a Line.
virtual void	SetEdgeWidth (float)
	Set/Get the edge width.
virtual float	GetEdgeWidth ()
	Set/Get the edge width.
virtual void	UseLineWidthForEdgeThicknessOn ()
	When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.
virtual void	UseLineWidthForEdgeThicknessOff ()
	When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.
virtual void	SetUseLineWidthForEdgeThickness (bool)
	When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.
virtual bool	GetUseLineWidthForEdgeThickness ()
	When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.
virtual void	SetLineStipplePattern (int)
	Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).
virtual int	GetLineStipplePattern ()
	Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).
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.
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.
virtual void	SetPointSize (float)
	Set/Get the diameter of a point.
virtual float	GetPointSize ()
	Set/Get the diameter of a point.
virtual vtkTypeBool	GetBackfaceCulling ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	SetBackfaceCulling (vtkTypeBool)
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	BackfaceCullingOn ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	BackfaceCullingOff ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual vtkTypeBool	GetFrontfaceCulling ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	SetFrontfaceCulling (vtkTypeBool)
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	FrontfaceCullingOn ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	FrontfaceCullingOff ()
	Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
virtual void	SetMaterialName (const char *)
	Returns the name of the material currently loaded, if any.
virtual char *	GetMaterialName ()
	Returns the name of the material currently loaded, if any.
virtual void	SetShading (vtkTypeBool)
	Enable/Disable shading.
virtual vtkTypeBool	GetShading ()
	Enable/Disable shading.
virtual void	ShadingOn ()
	Enable/Disable shading.
virtual void	ShadingOff ()
	Enable/Disable shading.
virtual void	AddShaderVariable (const char *, int, int *)
	Provide values to initialize shader variables.
virtual void	AddShaderVariable (const char *, int, float *)
	Provide values to initialize shader variables.
virtual void	AddShaderVariable (const char *, int, double *)
	Provide values to initialize shader variables.
void	AddShaderVariable (const char *, int)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, float)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, double)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, int, int)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, float, float)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, double, double)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, int, int, int)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, float, float, float)
	Methods to provide to add shader variables from wrappers.
void	AddShaderVariable (const char *, double, double, double)
	Methods to provide to add shader variables from wrappers.
virtual void	SetShowTexturesOnBackface (bool)
	Show texture maps when the geometry is backfacing.
virtual bool	GetShowTexturesOnBackface ()
	Show texture maps when the geometry is backfacing.
virtual void	ShowTexturesOnBackfaceOn ()
	Show texture maps when the geometry is backfacing.
virtual void	ShowTexturesOnBackfaceOff ()
	Show texture maps when the geometry is backfacing.
void	SetTexture (const char *name, vtkTexture *texture)
	Set/Get the texture object to control rendering texture maps.
vtkTexture *	GetTexture (const char *name)
	Set/Get the texture object to control rendering texture maps.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with the Property.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with the Property.
double	ComputeReflectanceOfBaseLayer ()
	For PBR, calculate the reflectance of the base layer depending on the presence of a coat layer.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

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.
static double	ComputeReflectanceFromIOR (double IORTo, double IORFrom)
	For PBR, calculate the reflectance from the refractive index of ingoing and outgoing interfaces.
static double	ComputeIORFromReflectance (double reflectance, double ior)
	For PBR, calculate the refractive index from the reflectance of the interface and the refractive index of one of both medium.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	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.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
double	Color [3]
double	AmbientColor [3]
double	DiffuseColor [3]
double	SpecularColor [3]
double	EdgeColor [3]
double	VertexColor [3]
double	SelectionColor [4] = { 1.0, 0.0, 0.0, 1.0 }
double	Ambient
double	Diffuse
double	Metallic
double	Roughness
double	Anisotropy
double	AnisotropyRotation
double	BaseIOR
double	CoatIOR
double	CoatColor [3]
double	CoatRoughness
double	CoatStrength
double	CoatNormalScale
double	NormalScale
double	OcclusionStrength
double	EmissiveFactor [3]
double	Specular
double	SpecularPower
double	Opacity
double	EdgeOpacity = 1.0
double	EdgeTint [3]
float	PointSize
float	LineWidth
float	EdgeWidth = 1.0
float	SelectionPointSize = 2.f
float	SelectionLineWidth = 2.f
bool	UseLineWidthForEdgeThickness = true
int	LineStipplePattern
int	LineStippleRepeatFactor
int	Interpolation
int	Representation
vtkTypeBool	EdgeVisibility
vtkTypeBool	VertexVisibility
vtkTypeBool	BackfaceCulling
vtkTypeBool	FrontfaceCulling
bool	Lighting
Point2DShapeType	Point2DShape = Point2DShapeType::Square
bool	RenderPointsAsSpheres
bool	RenderLinesAsTubes
bool	ShowTexturesOnBackface
vtkTypeBool	Shading
char *	MaterialName
MapOfTextures	Textures
vtkInformation *	Information
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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)

Online Examples:

ClipDataSetWithPolyData

Spring

DownsamplePointCloud

PointSource

PolygonalSurfaceContourLineInterpolator

RenderWindowNoUiFile

Tutorial_Step3

PointDataSubdivision

DecimateFran

MultiBlockVolumeMapper

Tests:

vtkProperty (Tests)

Definition at line 169 of file vtkProperty.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkProperty::Superclass

Definition at line 172 of file vtkProperty.h.

MapOfTextures

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

protected

Definition at line 976 of file vtkProperty.h.

Member Enumeration Documentation

Point2DShapeType

enum class vtkProperty::Point2DShapeType

strong

Enumerator
Round
Square

Definition at line 221 of file vtkProperty.h.

Constructor & Destructor Documentation

vtkProperty()

vtkProperty::vtkProperty ( )

protected

~vtkProperty()

vtkProperty::~vtkProperty ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkProperty::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkRIBProperty, vtkOpenGLProperty, and vtkWebGPUProperty.

NewInstance()

vtkProperty * vtkProperty::NewInstance

(

)

const

PrintSelf()

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 vtkRIBProperty, and vtkWebGPUProperty.

New()

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.

DeepCopy()

void vtkProperty::DeepCopy

(

vtkProperty *

p

)

Assign one property to another.

Render()

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

BackfaceRender()

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

Definition at line 203 of file vtkProperty.h.

PostRender()

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

GetLighting()

virtual bool vtkProperty::GetLighting ( )

virtual

Set/Get lighting flag for an object.

Initial value is true.

SetLighting()

virtual void vtkProperty::SetLighting ( bool  )

virtual

Set/Get lighting flag for an object.

Initial value is true.

LightingOn()

virtual void vtkProperty::LightingOn ( )

virtual

Set/Get lighting flag for an object.

Initial value is true.

LightingOff()

virtual void vtkProperty::LightingOff ( )

virtual

Set/Get lighting flag for an object.

Initial value is true.

vtkSetEnumMacro()

vtkProperty::vtkSetEnumMacro	(	Point2DShape	,
		Point2DShapeType
	)

Set/Get the 2D shape of points to use when RenderPointsAsSpheres=false.

Some graphics implementations may ignore this setting.

vtkGetEnumMacro()

vtkProperty::vtkGetEnumMacro	(	Point2DShape	,
		Point2DShapeType
	)

GetRenderPointsAsSpheres()

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.

SetRenderPointsAsSpheres()

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.

RenderPointsAsSpheresOn()

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.

RenderPointsAsSpheresOff()

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.

GetRenderLinesAsTubes()

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.

SetRenderLinesAsTubes()

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.

RenderLinesAsTubesOn()

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.

RenderLinesAsTubesOff()

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.

SetInterpolation()

virtual void vtkProperty::SetInterpolation ( int  )

virtual

Set the shading interpolation method for an object.

GetInterpolation()

virtual int vtkProperty::GetInterpolation ( )

virtual

Set the shading interpolation method for an object.

SetInterpolationToFlat()

void vtkProperty::SetInterpolationToFlat ( )

inline

Set the shading interpolation method for an object.

Definition at line 265 of file vtkProperty.h.

SetInterpolationToGouraud()

void vtkProperty::SetInterpolationToGouraud ( )

inline

Set the shading interpolation method for an object.

Definition at line 266 of file vtkProperty.h.

SetInterpolationToPhong()

void vtkProperty::SetInterpolationToPhong ( )

inline

Set the shading interpolation method for an object.

Definition at line 267 of file vtkProperty.h.

SetInterpolationToPBR()

void vtkProperty::SetInterpolationToPBR ( )

inline

Set the shading interpolation method for an object.

Definition at line 268 of file vtkProperty.h.

GetInterpolationAsString()

const char * vtkProperty::GetInterpolationAsString ( )

inline

Return the method of shading as a descriptive character string.

Definition at line 990 of file vtkProperty.h.

SetRepresentation()

virtual void vtkProperty::SetRepresentation ( int  )

virtual

Control the surface geometry representation for the object.

GetRepresentation()

virtual int vtkProperty::GetRepresentation ( )

virtual

Control the surface geometry representation for the object.

SetRepresentationToPoints()

void vtkProperty::SetRepresentationToPoints ( )

inline

Control the surface geometry representation for the object.

Definition at line 278 of file vtkProperty.h.

SetRepresentationToWireframe()

void vtkProperty::SetRepresentationToWireframe ( )

inline

Control the surface geometry representation for the object.

Definition at line 279 of file vtkProperty.h.

SetRepresentationToSurface()

void vtkProperty::SetRepresentationToSurface ( )

inline

Control the surface geometry representation for the object.

Definition at line 280 of file vtkProperty.h.

GetRepresentationAsString()

const char * vtkProperty::GetRepresentationAsString ( )

inline

Return the method of shading as a descriptive character string.

Definition at line 1013 of file vtkProperty.h.

SetColor() [1/2]

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.

SetColor() [2/2]

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.

GetColor() [1/3]

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.

GetColor() [2/3]

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.

GetColor() [3/3]

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.

SetBaseIOR()

virtual void vtkProperty::SetBaseIOR ( double  )

virtual

Set/Get the Index Of Refraction of the base layer.

It controls the amount of light reflected at normal incidence (the reflectance F0), depending on the IOR of the upper layer (eg. coat layer, or environment). For example, with a base IOR of 1.5 and an IOR of 1.0 outside (IOR of the air), 4% of the amount of the light is reflected at normal incidence. Notice that modifying this value is only useful for dielectrics materials, as the reflectance for metallic is the albedo. This parameter is only used by PBR Interpolation. Default value is 1.5

GetBaseIOR()

virtual double vtkProperty::GetBaseIOR ( )

virtual

Set/Get the Index Of Refraction of the base layer.

It controls the amount of light reflected at normal incidence (the reflectance F0), depending on the IOR of the upper layer (eg. coat layer, or environment). For example, with a base IOR of 1.5 and an IOR of 1.0 outside (IOR of the air), 4% of the amount of the light is reflected at normal incidence. Notice that modifying this value is only useful for dielectrics materials, as the reflectance for metallic is the albedo. This parameter is only used by PBR Interpolation. Default value is 1.5

SetMetallic()

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

GetMetallic()

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

SetRoughness()

virtual void vtkProperty::SetRoughness ( double  )

virtual

Set/Get the roughness coefficient.

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

GetRoughness()

virtual double vtkProperty::GetRoughness ( )

virtual

Set/Get the roughness coefficient.

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

SetAnisotropy()

virtual void vtkProperty::SetAnisotropy ( double  )

virtual

Set/Get the anisotropy coefficient.

This value controls the anisotropy of the material (0.0 means isotropic) This parameter is only used by PBR Interpolation. Default value is 0.0

GetAnisotropy()

virtual double vtkProperty::GetAnisotropy ( )

virtual

Set/Get the anisotropy coefficient.

This value controls the anisotropy of the material (0.0 means isotropic) This parameter is only used by PBR Interpolation. Default value is 0.0

SetAnisotropyRotation()

virtual void vtkProperty::SetAnisotropyRotation ( double  )

virtual

Set/Get the anisotropy rotation coefficient.

This value controls the rotation of the direction of the anisotropy. This parameter is only used by PBR Interpolation. Default value is 0.0

GetAnisotropyRotation()

virtual double vtkProperty::GetAnisotropyRotation ( )

virtual

Set/Get the anisotropy rotation coefficient.

This value controls the rotation of the direction of the anisotropy. This parameter is only used by PBR Interpolation. Default value is 0.0

SetCoatIOR()

virtual void vtkProperty::SetCoatIOR ( double  )

virtual

Set/Get the coat layer Index Of Refraction.

This parameter is only used by PBR Interpolation. Default value is 2.0

GetCoatIOR()

virtual double vtkProperty::GetCoatIOR ( )

virtual

Set/Get the coat layer Index Of Refraction.

This parameter is only used by PBR Interpolation. Default value is 2.0

SetCoatRoughness()

virtual void vtkProperty::SetCoatRoughness ( double  )

virtual

Set/Get the coat layer roughness coefficient.

This value has to be between 0 (glossy) and 1 (rough). This parameter is only used by PBR Interpolation. Default value is 0.0

GetCoatRoughness()

virtual double vtkProperty::GetCoatRoughness ( )

virtual

Set/Get the coat layer roughness coefficient.

This value has to be between 0 (glossy) and 1 (rough). This parameter is only used by PBR Interpolation. Default value is 0.0

SetCoatStrength()

virtual void vtkProperty::SetCoatStrength ( double  )

virtual

Set/Get the coat layer strength coefficient.

This value affects the strength of the coat layer reflection. This parameter is only used by PBR Interpolation. Default value is 0.0

GetCoatStrength()

virtual double vtkProperty::GetCoatStrength ( )

virtual

Set/Get the coat layer strength coefficient.

This value affects the strength of the coat layer reflection. This parameter is only used by PBR Interpolation. Default value is 0.0

SetCoatColor() [1/2]

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

virtual

Set/Get the color of the coat layer.

This value is only used by PBR Interpolation. Default value is white [1.0, 1.0, 1.0]

SetCoatColor() [2/2]

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

virtual

Set/Get the color of the coat layer.

This value is only used by PBR Interpolation. Default value is white [1.0, 1.0, 1.0]

GetCoatColor() [1/3]

virtual double * vtkProperty::GetCoatColor ( )

virtual

Set/Get the color of the coat layer.

This value is only used by PBR Interpolation. Default value is white [1.0, 1.0, 1.0]

GetCoatColor() [2/3]

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

virtual

Set/Get the color of the coat layer.

This value is only used by PBR Interpolation. Default value is white [1.0, 1.0, 1.0]

GetCoatColor() [3/3]

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

virtual

Set/Get the color of the coat layer.

This value is only used by PBR Interpolation. Default value is white [1.0, 1.0, 1.0]

SetCoatNormalScale()

virtual void vtkProperty::SetCoatNormalScale ( double  )

virtual

Set/Get the coat layer normal scale coefficient.

This value affects the strength of the normal deviation from the coat normal texture. This parameter is only used by PBR Interpolation. Default value is 1.0

GetCoatNormalScale()

virtual double vtkProperty::GetCoatNormalScale ( )

virtual

Set/Get the coat layer normal scale coefficient.

This value affects the strength of the normal deviation from the coat normal texture. This parameter is only used by PBR Interpolation. Default value is 1.0

SetNormalScale()

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

GetNormalScale()

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

SetOcclusionStrength()

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

GetOcclusionStrength()

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

SetEmissiveFactor() [1/2]

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]

SetEmissiveFactor() [2/2]

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]

GetEmissiveFactor() [1/3]

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]

GetEmissiveFactor() [2/3]

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]

GetEmissiveFactor() [3/3]

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]

SetEdgeTint() [1/2]

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

virtual

Set/Get the edge tint (for metals only).

Set the color at grazing angle (fresnel reflectance). This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

SetEdgeTint() [2/2]

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

virtual

Set/Get the edge tint (for metals only).

Set the color at grazing angle (fresnel reflectance). This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

GetEdgeTint() [1/3]

virtual double * vtkProperty::GetEdgeTint ( )

virtual

Set/Get the edge tint (for metals only).

Set the color at grazing angle (fresnel reflectance). This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

GetEdgeTint() [2/3]

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

virtual

Set/Get the edge tint (for metals only).

Set the color at grazing angle (fresnel reflectance). This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

GetEdgeTint() [3/3]

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

virtual

Set/Get the edge tint (for metals only).

Set the color at grazing angle (fresnel reflectance). This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]

SetAmbient()

virtual void vtkProperty::SetAmbient ( double  )

virtual

Set/Get the ambient lighting coefficient.

GetAmbient()

virtual double vtkProperty::GetAmbient ( )

virtual

Set/Get the ambient lighting coefficient.

SetDiffuse()

virtual void vtkProperty::SetDiffuse ( double  )

virtual

Set/Get the diffuse lighting coefficient.

GetDiffuse()

virtual double vtkProperty::GetDiffuse ( )

virtual

Set/Get the diffuse lighting coefficient.

SetSpecular()

virtual void vtkProperty::SetSpecular ( double  )

virtual

Set/Get the specular lighting coefficient.

GetSpecular()

virtual double vtkProperty::GetSpecular ( )

virtual

Set/Get the specular lighting coefficient.

SetSpecularPower()

virtual void vtkProperty::SetSpecularPower ( double  )

virtual

Set/Get the specular power.

GetSpecularPower()

virtual double vtkProperty::GetSpecularPower ( )

virtual

Set/Get the specular power.

SetOpacity()

virtual void vtkProperty::SetOpacity ( double  )

virtual

Set/Get the object's opacity.

1.0 is totally opaque and 0.0 is completely transparent.

GetOpacity()

virtual double vtkProperty::GetOpacity ( )

virtual

Set/Get the object's opacity.

1.0 is totally opaque and 0.0 is completely transparent.

SetEdgeOpacity()

virtual void vtkProperty::SetEdgeOpacity ( double  )

virtual

Set/Get the line opacity.

1.0 is totally opaque and 0.0 is completely transparent.

GetEdgeOpacity()

virtual double vtkProperty::GetEdgeOpacity ( )

virtual

Set/Get the line opacity.

1.0 is totally opaque and 0.0 is completely transparent.

SetAmbientColor() [1/2]

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.

SetAmbientColor() [2/2]

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.

GetAmbientColor() [1/3]

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.

GetAmbientColor() [2/3]

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.

GetAmbientColor() [3/3]

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.

SetDiffuseColor() [1/2]

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

SetDiffuseColor() [2/2]

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

GetDiffuseColor() [1/3]

virtual double * vtkProperty::GetDiffuseColor ( )

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

GetDiffuseColor() [2/3]

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

GetDiffuseColor() [3/3]

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

virtual

Set/Get the diffuse surface color.

For PBR Interpolation, DiffuseColor is used as the base color

SetSpecularColor() [1/2]

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

virtual

Set/Get the specular surface color.

SetSpecularColor() [2/2]

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

virtual

Set/Get the specular surface color.

GetSpecularColor() [1/3]

virtual double * vtkProperty::GetSpecularColor ( )

virtual

Set/Get the specular surface color.

GetSpecularColor() [2/3]

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

virtual

Set/Get the specular surface color.

GetSpecularColor() [3/3]

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

virtual

Set/Get the specular surface color.

GetEdgeVisibility()

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.

SetEdgeVisibility()

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.

EdgeVisibilityOn()

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.

EdgeVisibilityOff()

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.

SetEdgeColor() [1/2]

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

virtual

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

SetEdgeColor() [2/2]

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

virtual

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

GetEdgeColor() [1/3]

virtual double * vtkProperty::GetEdgeColor ( )

virtual

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

GetEdgeColor() [2/3]

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

virtual

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

GetEdgeColor() [3/3]

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

virtual

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

GetVertexVisibility()

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.

SetVertexVisibility()

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.

VertexVisibilityOn()

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.

VertexVisibilityOff()

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.

SetVertexColor() [1/2]

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

virtual

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

SetVertexColor() [2/2]

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

virtual

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

GetVertexColor() [1/3]

virtual double * vtkProperty::GetVertexColor ( )

virtual

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

GetVertexColor() [2/3]

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

virtual

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

GetVertexColor() [3/3]

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

virtual

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

SetSelectionColor() [1/2]

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

virtual

Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).

Default is red and opaque.

SetSelectionColor() [2/2]

virtual void vtkProperty::SetSelectionColor ( double  [4] )

virtual

Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).

Default is red and opaque.

GetSelectionColor() [1/3]

virtual double * vtkProperty::GetSelectionColor ( )

virtual

Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).

Default is red and opaque.

GetSelectionColor() [2/3]

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

virtual

Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).

Default is red and opaque.

GetSelectionColor() [3/3]

virtual void vtkProperty::GetSelectionColor ( double  [4] )

virtual

Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).

Default is red and opaque.

SetSelectionLineWidth()

virtual void vtkProperty::SetSelectionLineWidth ( float  )

virtual

Set/Get the selection line width.

Default is 2.

GetSelectionLineWidth()

virtual float vtkProperty::GetSelectionLineWidth ( )

virtual

Set/Get the selection line width.

Default is 2.

SetSelectionPointSize()

virtual void vtkProperty::SetSelectionPointSize ( float  )

virtual

Set/Get the selection point size.

Default is 2.

GetSelectionPointSize()

virtual float vtkProperty::GetSelectionPointSize ( )

virtual

Set/Get the selection point size.

Default is 2.

SetLineWidth()

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.

GetLineWidth()

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.

SetEdgeWidth()

virtual void vtkProperty::SetEdgeWidth ( float  )

virtual

Set/Get the edge width.

Default is 1.

Note

When UseLineWidthForEdgeThickness is false, this property controls the thickness of edges of cells.

GetEdgeWidth()

virtual float vtkProperty::GetEdgeWidth ( )

virtual

Set/Get the edge width.

Default is 1.

Note

When UseLineWidthForEdgeThickness is false, this property controls the thickness of edges of cells.

UseLineWidthForEdgeThicknessOn()

virtual void vtkProperty::UseLineWidthForEdgeThicknessOn ( )

virtual

When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.

When UseLineWidthForEdgeThickness is false, the thickness of edges in a cell is controlled by EdgeWidth property.

Note

Default value is true. Edge width is determined by the value of LineWidth

UseLineWidthForEdgeThicknessOff()

virtual void vtkProperty::UseLineWidthForEdgeThicknessOff ( )

virtual

When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.

When UseLineWidthForEdgeThickness is false, the thickness of edges in a cell is controlled by EdgeWidth property.

Note

Default value is true. Edge width is determined by the value of LineWidth

SetUseLineWidthForEdgeThickness()

virtual void vtkProperty::SetUseLineWidthForEdgeThickness ( bool  )

virtual

When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.

When UseLineWidthForEdgeThickness is false, the thickness of edges in a cell is controlled by EdgeWidth property.

Note

Default value is true. Edge width is determined by the value of LineWidth

GetUseLineWidthForEdgeThickness()

virtual bool vtkProperty::GetUseLineWidthForEdgeThickness ( )

virtual

When UseLineWidthForEdgeThickness is true, the thickness of edges in a cell is controlled by LineWidth property.

When UseLineWidthForEdgeThickness is false, the thickness of edges in a cell is controlled by EdgeWidth property.

Note

Default value is true. Edge width is determined by the value of LineWidth

SetLineStipplePattern()

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.

GetLineStipplePattern()

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.

SetLineStippleRepeatFactor()

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.

GetLineStippleRepeatFactor()

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.

SetPointSize()

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.

GetPointSize()

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.

GetBackfaceCulling()

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.

SetBackfaceCulling()

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.

BackfaceCullingOn()

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.

BackfaceCullingOff()

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.

GetFrontfaceCulling()

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.

SetFrontfaceCulling()

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.

FrontfaceCullingOn()

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.

FrontfaceCullingOff()

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.

SetMaterialName()

virtual void vtkProperty::SetMaterialName ( const char *  )

virtual

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

GetMaterialName()

virtual char * vtkProperty::GetMaterialName ( )

virtual

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

SetShading()

virtual void vtkProperty::SetShading ( vtkTypeBool  )

virtual

Enable/Disable shading.

When shading is enabled, the Material must be set.

GetShading()

virtual vtkTypeBool vtkProperty::GetShading ( )

virtual

Enable/Disable shading.

When shading is enabled, the Material must be set.

ShadingOn()

virtual void vtkProperty::ShadingOn ( )

virtual

Enable/Disable shading.

When shading is enabled, the Material must be set.

ShadingOff()

virtual void vtkProperty::ShadingOff ( )

virtual

Enable/Disable shading.

When shading is enabled, the Material must be set.

AddShaderVariable() [1/12]

virtual void vtkProperty::AddShaderVariable ( const char *  , int  , int *    )

inlinevirtual

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

Definition at line 709 of file vtkProperty.h.

AddShaderVariable() [2/12]

virtual void vtkProperty::AddShaderVariable ( const char *  , int  , float *    )

inlinevirtual

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

Definition at line 713 of file vtkProperty.h.

AddShaderVariable() [3/12]

virtual void vtkProperty::AddShaderVariable ( const char *  , int  , double *    )

inlinevirtual

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

Definition at line 717 of file vtkProperty.h.

AddShaderVariable() [4/12]

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

inline

Methods to provide to add shader variables from wrappers.

Definition at line 727 of file vtkProperty.h.

AddShaderVariable() [5/12]

void vtkProperty::AddShaderVariable ( const char *  , float    )

inline

Methods to provide to add shader variables from wrappers.

Definition at line 731 of file vtkProperty.h.

AddShaderVariable() [6/12]

void vtkProperty::AddShaderVariable ( const char *  , double    )

inline

Methods to provide to add shader variables from wrappers.

Definition at line 735 of file vtkProperty.h.

AddShaderVariable() [7/12]

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

inline

Methods to provide to add shader variables from wrappers.

Definition at line 739 of file vtkProperty.h.

AddShaderVariable() [8/12]

void vtkProperty::AddShaderVariable ( const char *  , float  , float    )

inline

Methods to provide to add shader variables from wrappers.

Definition at line 743 of file vtkProperty.h.

AddShaderVariable() [9/12]

void vtkProperty::AddShaderVariable ( const char *  , double  , double    )

inline

Methods to provide to add shader variables from wrappers.

Definition at line 747 of file vtkProperty.h.

AddShaderVariable() [10/12]

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

inline

Methods to provide to add shader variables from wrappers.

Definition at line 751 of file vtkProperty.h.

AddShaderVariable() [11/12]

void vtkProperty::AddShaderVariable ( const char *  , float  , float  , float    )

inline

Methods to provide to add shader variables from wrappers.

Definition at line 755 of file vtkProperty.h.

AddShaderVariable() [12/12]

void vtkProperty::AddShaderVariable ( const char *  , double  , double  , double    )

inline

Methods to provide to add shader variables from wrappers.

Definition at line 759 of file vtkProperty.h.

SetShowTexturesOnBackface()

virtual void vtkProperty::SetShowTexturesOnBackface ( bool  )

virtual

Show texture maps when the geometry is backfacing.

Texture maps are always shown when frontfacing. By default this is true.

GetShowTexturesOnBackface()

virtual bool vtkProperty::GetShowTexturesOnBackface ( )

virtual

Show texture maps when the geometry is backfacing.

Texture maps are always shown when frontfacing. By default this is true.

ShowTexturesOnBackfaceOn()

virtual void vtkProperty::ShowTexturesOnBackfaceOn ( )

virtual

Show texture maps when the geometry is backfacing.

Texture maps are always shown when frontfacing. By default this is true.

ShowTexturesOnBackfaceOff()

virtual void vtkProperty::ShowTexturesOnBackfaceOff ( )

virtual

Show texture maps when the geometry is backfacing.

Texture maps are always shown when frontfacing. By default this is true.

SetTexture()

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. Note that for texture blending the textures will be rendering is alphabetical order and after any texture defined in the actor. There exists 6 special textures with reserved names: "albedoTex", "materialTex", "normalTex", "emissiveTex", "anisotropyTex" and "coatNormalTex". While these textures can be added with the regular SetTexture method, it is preferred to use the methods SetBaseColorTexture, SetORMTexture, SetNormalTexture, SetEmissiveTexture, SetAnisotropyTexture and SetCoatNormalTex respectively.

GetTexture()

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. Note that for texture blending the textures will be rendering is alphabetical order and after any texture defined in the actor. There exists 6 special textures with reserved names: "albedoTex", "materialTex", "normalTex", "emissiveTex", "anisotropyTex" and "coatNormalTex". While these textures can be added with the regular SetTexture method, it is preferred to use the methods SetBaseColorTexture, SetORMTexture, SetNormalTexture, SetEmissiveTexture, SetAnisotropyTexture and SetCoatNormalTex respectively.

SetBaseColorTexture()

void vtkProperty::SetBaseColorTexture ( vtkTexture *  texture )

inline

Set the base color texture.

Also called albedo, this texture is only used while rendering with PBR interpolation. This is the color of the object. This texture must be in sRGB color space.

See also

SetInterpolationToPBR vtkTexture::UseSRGBColorSpaceOn

Definition at line 798 of file vtkProperty.h.

SetORMTexture()

void vtkProperty::SetORMTexture ( vtkTexture *  texture )

inline

Set the ORM texture.

This texture contains three RGB independent components corresponding to the Occlusion value, Roughness value and Metallic value respectively. Each texture value is scaled by the Occlusion strength, roughness coefficient and metallic coefficient. This texture must be in linear color space. This is only used by the PBR shading model.

See also

SetInterpolationToPBR SetOcclusionStrength SetMetallic SetRoughness

Definition at line 809 of file vtkProperty.h.

SetAnisotropyTexture()

void vtkProperty::SetAnisotropyTexture ( vtkTexture *  texture )

inline

Set the anisotropy texture.

This texture contains two independent components corresponding to the anisotropy value and anisotropy rotation. The last component (blue channel) is discarded. The anisotropy value is scaled by the anisotropy coefficient of the material. The anisotropy rotation rotates the direction of the anisotropy (ie. the tangent) around the normal and is not scaled by the anisotropy rotation coefficient. This texture must be in linear color space. This is only used by the PBR shading model.

See also

SetInterpolationToPBR SetAnisotropy

Definition at line 821 of file vtkProperty.h.

SetNormalTexture()

void vtkProperty::SetNormalTexture ( vtkTexture *  texture )

inline

Set the normal texture.

This texture is required for normal mapping. It is valid for both PBR and Phong interpolation. The normal mapping is enabled if this texture is present and both normals and tangents are presents in the vtkPolyData. This texture must be in linear color space.

See also

vtkPolyDataTangents SetNormalScale

Definition at line 831 of file vtkProperty.h.

SetEmissiveTexture()

void vtkProperty::SetEmissiveTexture ( vtkTexture *  texture )

inline

Set the emissive texture.

When present, this RGB texture provides location and color to the shader where the vtkPolyData should emit light. Emitted light is scaled by EmissiveFactor. This is only supported by PBR interpolation model. This texture must be in sRGB color space.

See also

SetInterpolationToPBR SetEmissiveFactor vtkTexture::UseSRGBColorSpaceOn

Definition at line 840 of file vtkProperty.h.

SetCoatNormalTexture()

void vtkProperty::SetCoatNormalTexture ( vtkTexture *  texture )

inline

Set the coat normal texture.

This texture is required for coat normal mapping. It is valid only for PBR interpolation. The coat normal mapping is enabled if this texture is present and both normals and tangents are presents in the vtkPolyData. This texture must be in linear color space.

See also

vtkPolyDataTangents SetCoatNormalScale

Definition at line 850 of file vtkProperty.h.

RemoveTexture()

void vtkProperty::RemoveTexture

(

const char *

name

)

Remove a texture from the collection.

RemoveAllTextures()

void vtkProperty::RemoveAllTextures

(

)

Remove all the textures.

GetNumberOfTextures()

int vtkProperty::GetNumberOfTextures

(

)

Returns the number of textures in this property.

GetAllTextures()

std::map< std::string, vtkTexture * > & vtkProperty::GetAllTextures ( )

inline

Returns all the textures in this property and their names.

Definition at line 870 of file vtkProperty.h.

ReleaseGraphicsResources()

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

GetInformation()

virtual vtkInformation * vtkProperty::GetInformation ( )

virtual

Set/Get the information object associated with the Property.

SetInformation()

virtual void vtkProperty::SetInformation ( vtkInformation *  )

virtual

Set/Get the information object associated with the Property.

ComputeReflectanceFromIOR()

static double vtkProperty::ComputeReflectanceFromIOR ( double  IORTo, double  IORFrom  )

static

For PBR, calculate the reflectance from the refractive index of ingoing and outgoing interfaces.

ComputeIORFromReflectance()

static double vtkProperty::ComputeIORFromReflectance ( double  reflectance, double  ior  )

static

For PBR, calculate the refractive index from the reflectance of the interface and the refractive index of one of both medium.

ComputeReflectanceOfBaseLayer()

double vtkProperty::ComputeReflectanceOfBaseLayer

(

)

For PBR, calculate the reflectance of the base layer depending on the presence of a coat layer.

If there is no coat layer, the reflectance is the one at the interface environment - base layer. If a coat layer is present, the reflectance is the one at the interface between the base and the coat layer.

ComputeCompositeColor()

static void vtkProperty::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]  )

staticprotected

Computes composite color.

Used by GetColor().

Member Data Documentation

Color

double vtkProperty::Color[3]

protected

Definition at line 925 of file vtkProperty.h.

AmbientColor

double vtkProperty::AmbientColor[3]

protected

Definition at line 926 of file vtkProperty.h.

DiffuseColor

double vtkProperty::DiffuseColor[3]

protected

Definition at line 927 of file vtkProperty.h.

SpecularColor

double vtkProperty::SpecularColor[3]

protected

Definition at line 928 of file vtkProperty.h.

EdgeColor

double vtkProperty::EdgeColor[3]

protected

Definition at line 929 of file vtkProperty.h.

VertexColor

double vtkProperty::VertexColor[3]

protected

Definition at line 930 of file vtkProperty.h.

SelectionColor

double vtkProperty::SelectionColor[4] = { 1.0, 0.0, 0.0, 1.0 }

protected

Definition at line 931 of file vtkProperty.h.

Ambient

double vtkProperty::Ambient

protected

Definition at line 932 of file vtkProperty.h.

Diffuse

double vtkProperty::Diffuse

protected

Definition at line 933 of file vtkProperty.h.

Metallic

double vtkProperty::Metallic

protected

Definition at line 934 of file vtkProperty.h.

Roughness

double vtkProperty::Roughness

protected

Definition at line 935 of file vtkProperty.h.

Anisotropy

double vtkProperty::Anisotropy

protected

Definition at line 936 of file vtkProperty.h.

AnisotropyRotation

double vtkProperty::AnisotropyRotation

protected

Definition at line 937 of file vtkProperty.h.

BaseIOR

double vtkProperty::BaseIOR

protected

Definition at line 938 of file vtkProperty.h.

CoatIOR

double vtkProperty::CoatIOR

protected

Definition at line 939 of file vtkProperty.h.

CoatColor

double vtkProperty::CoatColor[3]

protected

Definition at line 940 of file vtkProperty.h.

CoatRoughness

double vtkProperty::CoatRoughness

protected

Definition at line 941 of file vtkProperty.h.

CoatStrength

double vtkProperty::CoatStrength

protected

Definition at line 942 of file vtkProperty.h.

CoatNormalScale

double vtkProperty::CoatNormalScale

protected

Definition at line 943 of file vtkProperty.h.

NormalScale

double vtkProperty::NormalScale

protected

Definition at line 944 of file vtkProperty.h.

OcclusionStrength

double vtkProperty::OcclusionStrength

protected

Definition at line 945 of file vtkProperty.h.

EmissiveFactor

double vtkProperty::EmissiveFactor[3]

protected

Definition at line 946 of file vtkProperty.h.

Specular

double vtkProperty::Specular

protected

Definition at line 947 of file vtkProperty.h.

SpecularPower

double vtkProperty::SpecularPower

protected

Definition at line 948 of file vtkProperty.h.

Opacity

double vtkProperty::Opacity

protected

Definition at line 949 of file vtkProperty.h.

EdgeOpacity

double vtkProperty::EdgeOpacity = 1.0

protected

Definition at line 950 of file vtkProperty.h.

EdgeTint

double vtkProperty::EdgeTint[3]

protected

Definition at line 951 of file vtkProperty.h.

PointSize

float vtkProperty::PointSize

protected

Definition at line 952 of file vtkProperty.h.

LineWidth

float vtkProperty::LineWidth

protected

Definition at line 953 of file vtkProperty.h.

EdgeWidth

float vtkProperty::EdgeWidth = 1.0

protected

Definition at line 954 of file vtkProperty.h.

SelectionPointSize

float vtkProperty::SelectionPointSize = 2.f

protected

Definition at line 955 of file vtkProperty.h.

SelectionLineWidth

float vtkProperty::SelectionLineWidth = 2.f

protected

Definition at line 956 of file vtkProperty.h.

UseLineWidthForEdgeThickness

bool vtkProperty::UseLineWidthForEdgeThickness = true

protected

Definition at line 957 of file vtkProperty.h.

LineStipplePattern

int vtkProperty::LineStipplePattern

protected

Definition at line 958 of file vtkProperty.h.

LineStippleRepeatFactor

int vtkProperty::LineStippleRepeatFactor

protected

Definition at line 959 of file vtkProperty.h.

Interpolation

int vtkProperty::Interpolation

protected

Definition at line 960 of file vtkProperty.h.

Representation

int vtkProperty::Representation

protected

Definition at line 961 of file vtkProperty.h.

EdgeVisibility

vtkTypeBool vtkProperty::EdgeVisibility

protected

Definition at line 962 of file vtkProperty.h.

VertexVisibility

vtkTypeBool vtkProperty::VertexVisibility

protected

Definition at line 963 of file vtkProperty.h.

BackfaceCulling

vtkTypeBool vtkProperty::BackfaceCulling

protected

Definition at line 964 of file vtkProperty.h.

FrontfaceCulling

vtkTypeBool vtkProperty::FrontfaceCulling

protected

Definition at line 965 of file vtkProperty.h.

Lighting

bool vtkProperty::Lighting

protected

Definition at line 966 of file vtkProperty.h.

Point2DShape

Point2DShapeType vtkProperty::Point2DShape = Point2DShapeType::Square

protected

Definition at line 967 of file vtkProperty.h.

RenderPointsAsSpheres

bool vtkProperty::RenderPointsAsSpheres

protected

Definition at line 968 of file vtkProperty.h.

RenderLinesAsTubes

bool vtkProperty::RenderLinesAsTubes

protected

Definition at line 969 of file vtkProperty.h.

ShowTexturesOnBackface

bool vtkProperty::ShowTexturesOnBackface

protected

Definition at line 970 of file vtkProperty.h.

Shading

vtkTypeBool vtkProperty::Shading

protected

Definition at line 972 of file vtkProperty.h.

MaterialName

char* vtkProperty::MaterialName

protected

Definition at line 974 of file vtkProperty.h.

Textures

MapOfTextures vtkProperty::Textures

protected

Definition at line 977 of file vtkProperty.h.

Information

vtkInformation* vtkProperty::Information

protected

Definition at line 980 of file vtkProperty.h.

---

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

• Rendering/Core/vtkProperty.h