VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkOpenGLProperty Class Reference

OpenGL property. More...

#include <vtkOpenGLProperty.h>

Inheritance diagram for vtkOpenGLProperty:
[legend]
Collaboration diagram for vtkOpenGLProperty:
[legend]

Public Types

typedef vtkProperty Superclass
 
- Public Types inherited from vtkProperty
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...
 
vtkOpenGLPropertyNewInstance () 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
vtkPropertyNewInstance () const
 
void DeepCopy (vtkProperty *p)
 Assign one property to another. More...
 
virtual bool GetLighting ()
 Set/Get lighting flag for an object. More...
 
virtual void SetLighting (bool)
 
virtual void LightingOn ()
 
virtual void LightingOff ()
 
virtual bool GetRenderPointsAsSpheres ()
 Set/Get rendering of points as spheres. More...
 
virtual void SetRenderPointsAsSpheres (bool)
 
virtual void RenderPointsAsSpheresOn ()
 
virtual void RenderPointsAsSpheresOff ()
 
virtual bool GetRenderLinesAsTubes ()
 Set/Get rendering of lines as tubes. More...
 
virtual void SetRenderLinesAsTubes (bool)
 
virtual void RenderLinesAsTubesOn ()
 
virtual void RenderLinesAsTubesOff ()
 
virtual void SetInterpolation (int)
 Set the shading interpolation method for an object. More...
 
virtual int GetInterpolation ()
 
void SetInterpolationToFlat ()
 
void SetInterpolationToGouraud ()
 
void SetInterpolationToPhong ()
 
void SetInterpolationToPBR ()
 
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 ()
 
void SetRepresentationToPoints ()
 
void SetRepresentationToWireframe ()
 
void SetRepresentationToSurface ()
 
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])
 
doubleGetColor ()
 
void GetColor (double rgb[3])
 
void GetColor (double &r, double &g, double &b)
 
virtual void SetMetallic (double)
 Set/Get the metallic coefficient. More...
 
virtual double GetMetallic ()
 
virtual void SetRoughness (double)
 Set/Get the roughness coefficient. More...
 
virtual double GetRoughness ()
 
virtual void SetNormalScale (double)
 Set/Get the normal scale coefficient. More...
 
virtual double GetNormalScale ()
 
virtual void SetOcclusionStrength (double)
 Set/Get the occlusion strength coefficient. More...
 
virtual double GetOcclusionStrength ()
 
virtual void SetEmissiveFactor (double, double, double)
 Set/Get the emissive factor. More...
 
virtual void SetEmissiveFactor (double[3])
 
virtual doubleGetEmissiveFactor ()
 
virtual void GetEmissiveFactor (double &, double &, double &)
 
virtual void GetEmissiveFactor (double[3])
 
virtual void SetAmbient (double)
 Set/Get the ambient lighting coefficient. More...
 
virtual double GetAmbient ()
 
virtual void SetDiffuse (double)
 Set/Get the diffuse lighting coefficient. More...
 
virtual double GetDiffuse ()
 
virtual void SetSpecular (double)
 Set/Get the specular lighting coefficient. More...
 
virtual double GetSpecular ()
 
virtual void SetSpecularPower (double)
 Set/Get the specular power. More...
 
virtual double GetSpecularPower ()
 
virtual void SetOpacity (double)
 Set/Get the object's opacity. More...
 
virtual double GetOpacity ()
 
virtual void SetAmbientColor (double, double, double)
 Set/Get the ambient surface color. More...
 
virtual void SetAmbientColor (double[3])
 
virtual doubleGetAmbientColor ()
 
virtual void GetAmbientColor (double &, double &, double &)
 
virtual void GetAmbientColor (double[3])
 
virtual void SetDiffuseColor (double, double, double)
 Set/Get the diffuse surface color. More...
 
virtual void SetDiffuseColor (double[3])
 
virtual doubleGetDiffuseColor ()
 
virtual void GetDiffuseColor (double &, double &, double &)
 
virtual void GetDiffuseColor (double[3])
 
virtual void SetSpecularColor (double, double, double)
 Set/Get the specular surface color. More...
 
virtual void SetSpecularColor (double[3])
 
virtual doubleGetSpecularColor ()
 
virtual void GetSpecularColor (double &, double &, double &)
 
virtual void GetSpecularColor (double[3])
 
virtual vtkTypeBool GetEdgeVisibility ()
 Turn on/off the visibility of edges. More...
 
virtual void SetEdgeVisibility (vtkTypeBool)
 
virtual void EdgeVisibilityOn ()
 
virtual void EdgeVisibilityOff ()
 
virtual void SetEdgeColor (double, double, double)
 Set/Get the color of primitive edges (if edge visibility is enabled). More...
 
virtual void SetEdgeColor (double[3])
 
virtual doubleGetEdgeColor ()
 
virtual void GetEdgeColor (double &, double &, double &)
 
virtual void GetEdgeColor (double[3])
 
virtual vtkTypeBool GetVertexVisibility ()
 Turn on/off the visibility of vertices. More...
 
virtual void SetVertexVisibility (vtkTypeBool)
 
virtual void VertexVisibilityOn ()
 
virtual void VertexVisibilityOff ()
 
virtual void SetVertexColor (double, double, double)
 Set/Get the color of primitive vertices (if vertex visibility is enabled). More...
 
virtual void SetVertexColor (double[3])
 
virtual doubleGetVertexColor ()
 
virtual void GetVertexColor (double &, double &, double &)
 
virtual void GetVertexColor (double[3])
 
virtual void SetLineWidth (float)
 Set/Get the width of a Line. More...
 
virtual float GetLineWidth ()
 
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 ()
 
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 ()
 
virtual void SetPointSize (float)
 Set/Get the diameter of a point. More...
 
virtual float GetPointSize ()
 
virtual vtkTypeBool GetBackfaceCulling ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...
 
virtual void SetBackfaceCulling (vtkTypeBool)
 
virtual void BackfaceCullingOn ()
 
virtual void BackfaceCullingOff ()
 
virtual vtkTypeBool GetFrontfaceCulling ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More...
 
virtual void SetFrontfaceCulling (vtkTypeBool)
 
virtual void FrontfaceCullingOn ()
 
virtual void FrontfaceCullingOff ()
 
virtual void SetMaterialName (const char *)
 Returns the name of the material currently loaded, if any. More...
 
virtual char * GetMaterialName ()
 
virtual void SetShading (vtkTypeBool)
 Enable/Disable shading. More...
 
virtual vtkTypeBool GetShading ()
 
virtual void ShadingOn ()
 
virtual void ShadingOff ()
 
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)
 
virtual void AddShaderVariable (const char *name, int numVars, double *x)
 
void AddShaderVariable (const char *name, int v)
 Methods to provide to add shader variables from wrappers. More...
 
void AddShaderVariable (const char *name, float v)
 
void AddShaderVariable (const char *name, double v)
 
void AddShaderVariable (const char *name, int v1, int v2)
 
void AddShaderVariable (const char *name, float v1, float v2)
 
void AddShaderVariable (const char *name, double v1, double v2)
 
void AddShaderVariable (const char *name, int v1, int v2, int v3)
 
void AddShaderVariable (const char *name, float v1, float v2, float v3)
 
void AddShaderVariable (const char *name, double v1, double v2, double v3)
 
void SetTexture (const char *name, vtkTexture *texture)
 Set/Get the texture object to control rendering texture maps. More...
 
vtkTextureGetTexture (const char *name)
 
void SetBaseColorTexture (vtkTexture *texture)
 Set the base color texture. More...
 
void SetORMTexture (vtkTexture *texture)
 Set the ORM texture. More...
 
void SetNormalTexture (vtkTexture *texture)
 Set the normal texture. More...
 
void SetEmissiveTexture (vtkTexture *texture)
 Set the emissive texture. More...
 
void RemoveTexture (const char *name)
 Remove a texture from the collection. More...
 
void RemoveAllTextures ()
 Remove all the textures. More...
 
int GetNumberOfTextures ()
 Returns the number of textures in this property. More...
 
std::map< std::string, vtkTexture * > & GetAllTextures ()
 Returns all the textures in this property and their names. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with the Property. More...
 
virtual void SetInformation (vtkInformation *)
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOpenGLPropertyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLPropertySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProperty
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropertySafeDownCast (vtkObjectBase *o)
 
static vtkPropertyNew ()
 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 vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- 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 Metallic
 
double Roughness
 
double NormalScale
 
double OcclusionStrength
 
double EmissiveFactor [3]
 
double Specular
 
double SpecularPower
 
double Opacity
 
float PointSize
 
float LineWidth
 
int LineStipplePattern
 
int LineStippleRepeatFactor
 
int Interpolation
 
int Representation
 
vtkTypeBool EdgeVisibility
 
vtkTypeBool VertexVisibility
 
vtkTypeBool BackfaceCulling
 
vtkTypeBool FrontfaceCulling
 
bool Lighting
 
bool RenderPointsAsSpheres
 
bool RenderLinesAsTubes
 
vtkTypeBool Shading
 
char * MaterialName
 
MapOfTextures Textures
 
vtkInformationInformation
 
- 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

◆ Superclass

Definition at line 33 of file vtkOpenGLProperty.h.

Constructor & Destructor Documentation

◆ vtkOpenGLProperty()

vtkOpenGLProperty::vtkOpenGLProperty ( )
protected

◆ ~vtkOpenGLProperty()

vtkOpenGLProperty::~vtkOpenGLProperty ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLProperty* vtkOpenGLProperty::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLProperty::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProperty.

◆ NewInstance()

vtkOpenGLProperty* vtkOpenGLProperty::NewInstance ( ) const

◆ PrintSelf()

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.

◆ Render()

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

Implement base class method.

Reimplemented from vtkProperty.

◆ BackfaceRender()

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

Implement base class method.

Reimplemented from vtkProperty.

◆ PostRender()

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.

◆ ReleaseGraphicsResources()

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.

◆ RenderTextures()

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: