OpenGL property. More...

#include <vtkOpenGLProperty.h>

Inheritance diagram for vtkOpenGLProperty:

Collaboration diagram for vtkOpenGLProperty:

Public Types
typedef vtkProperty	Superclass

Public Types inherited from vtkProperty
enum	VTKTextureUnit { VTK_TEXTURE_UNIT_0 = 0, VTK_TEXTURE_UNIT_1, VTK_TEXTURE_UNIT_2, VTK_TEXTURE_UNIT_3, VTK_TEXTURE_UNIT_4, VTK_TEXTURE_UNIT_5, VTK_TEXTURE_UNIT_6, VTK_TEXTURE_UNIT_7 }

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

vtkOpenGLProperty *	NewInstance () const

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

void	Render (vtkActor a, vtkRenderer ren) override
	Implement base class method. More...

void	BackfaceRender (vtkActor a, vtkRenderer ren) override
	Implement base class method. More...

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

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

Public Member Functions inherited from vtkProperty
vtkProperty *	NewInstance () const

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

virtual vtkShaderDeviceAdapter2 *	GetShaderDeviceAdapter2 ()
	Get the vtkShaderDeviceAdapter2 if set, returns null otherwise. 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 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...

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

void	SetTexture (int unit, vtkTexture *texture)
	Set/Get the texture object to control rendering texture maps. More...

vtkTexture *	GetTexture (int unit)
	Set/Get the texture object to control rendering texture maps. More...

void	RemoveTexture (int unit)
	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 vtkOpenGLProperty *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLProperty *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProperty
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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLProperty ()

	~vtkOpenGLProperty () override

bool	RenderTextures (vtkActor actor, vtkRenderer renderer)
	Method called in vtkOpenGLProperty::Render() to render textures. More...

Protected Member Functions inherited from vtkProperty
	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 &)

Additional Inherited Members
Protected Types inherited from vtkProperty
typedef std::map< std::string, vtkTexture * >	MapOfTextures

Static Protected Member Functions inherited from vtkProperty
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 inherited from vtkProperty
double	Color [3]

double	AmbientColor [3]

double	DiffuseColor [3]

double	SpecularColor [3]

double	EdgeColor [3]

double	VertexColor [3]

double	Ambient

double	Diffuse

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

OpenGL property.

vtkOpenGLProperty is a concrete implementation of the abstract class vtkProperty. vtkOpenGLProperty interfaces to the OpenGL rendering library.

Definition at line 29 of file vtkOpenGLProperty.h.

Member Typedef Documentation

typedef vtkProperty vtkOpenGLProperty::Superclass

Definition at line 33 of file vtkOpenGLProperty.h.

Constructor & Destructor Documentation

vtkOpenGLProperty::vtkOpenGLProperty ( )

protected

vtkOpenGLProperty::~vtkOpenGLProperty ( )

overrideprotected

Member Function Documentation

static vtkOpenGLProperty* vtkOpenGLProperty::New ( )

static

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

static

virtual vtkTypeBool vtkOpenGLProperty::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 vtkProperty.

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

static

virtual vtkObjectBase* vtkOpenGLProperty::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProperty.

vtkOpenGLProperty* vtkOpenGLProperty::NewInstance ( ) const

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

void vtkOpenGLProperty::Render	(	vtkActor *	a,
		vtkRenderer *	ren
	)

overridevirtual

Implement base class method.

Reimplemented from vtkProperty.

void vtkOpenGLProperty::BackfaceRender	(	vtkActor *	a,
		vtkRenderer *	ren
	)

overridevirtual

Implement base class method.

Reimplemented from vtkProperty.

void vtkOpenGLProperty::PostRender	(	vtkActor *	a,
		vtkRenderer *	r
	)

overridevirtual

This method is called after the actor has been rendered.

Don't call this directly. This method cleans up any shaders allocated.

Reimplemented from vtkProperty.

void vtkOpenGLProperty::ReleaseGraphicsResources ( vtkWindow * win )

overridevirtual

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

bool vtkOpenGLProperty::RenderTextures	(	vtkActor *	actor,
		vtkRenderer *	renderer
	)

protected

Method called in vtkOpenGLProperty::Render() to render textures.

Last argument is the value returned from RenderShaders() call.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkOpenGLProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation