VTK  9.1.20211015
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkEncodedGradientShader Class Reference

Compute shading tables for encoded normals. More...

#include <vtkEncodedGradientShader.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkEncodedGradientShaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print the vtkEncodedGradientShader. More...
 
void UpdateShadingTable (vtkRenderer *ren, vtkVolume *vol, vtkEncodedGradientEstimator *gradest)
 Cause the shading table to be updated. More...
 
virtual void SetZeroNormalDiffuseIntensity (float)
 Set / Get the intensity diffuse / specular light used for the zero normals. More...
 
virtual float GetZeroNormalDiffuseIntensity ()
 Set / Get the intensity diffuse / specular light used for the zero normals. More...
 
virtual void SetZeroNormalSpecularIntensity (float)
 Set / Get the intensity diffuse / specular light used for the zero normals. More...
 
virtual float GetZeroNormalSpecularIntensity ()
 Set / Get the intensity diffuse / specular light used for the zero normals. More...
 
float * GetRedDiffuseShadingTable (vtkVolume *vol)
 Get the red/green/blue shading table. More...
 
float * GetGreenDiffuseShadingTable (vtkVolume *vol)
 Get the red/green/blue shading table. More...
 
float * GetBlueDiffuseShadingTable (vtkVolume *vol)
 Get the red/green/blue shading table. More...
 
float * GetRedSpecularShadingTable (vtkVolume *vol)
 Get the red/green/blue shading table. More...
 
float * GetGreenSpecularShadingTable (vtkVolume *vol)
 Get the red/green/blue shading table. More...
 
float * GetBlueSpecularShadingTable (vtkVolume *vol)
 Get the red/green/blue shading table. More...
 
virtual void SetActiveComponent (int)
 Set the active component for shading. More...
 
virtual int GetActiveComponent ()
 Set the active component for shading. 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...
 
vtkCommandGetCommand (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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkEncodedGradientShaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEncodedGradientShaderSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkEncodedGradientShader ()
 
 ~vtkEncodedGradientShader () override
 
void BuildShadingTable (int index, double lightDirection[3], double lightAmbientColor[3], double lightDiffuseColor[3], double lightSpecularColor[3], double lightIntensity, double viewDirection[3], double material[4], int twoSided, vtkEncodedGradientEstimator *gradest, int updateFlag)
 Build a shading table for a light with the specified direction, and color for an object of the specified material properties. More...
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

float * ShadingTable [VTK_MAX_SHADING_TABLES][6]
 
vtkVolumeShadingTableVolume [VTK_MAX_SHADING_TABLES]
 
int ShadingTableSize [VTK_MAX_SHADING_TABLES]
 
int ActiveComponent
 
float ZeroNormalDiffuseIntensity
 
float ZeroNormalSpecularIntensity
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Compute shading tables for encoded normals.

vtkEncodedGradientShader computes shading tables for encoded normals that indicates the amount of diffuse and specular illumination that is received from all light sources at a surface location with that normal. For diffuse illumination this is accurate, but for specular illumination it is approximate for perspective projections since the center view direction is always used as the view direction. Since the shading table is dependent on the volume (for the transformation that must be applied to the normals to put them into world coordinates) there is a shading table per volume. This is necessary because multiple volumes can share a volume mapper.

Definition at line 45 of file vtkEncodedGradientShader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkEncodedGradientShader.h.

Constructor & Destructor Documentation

◆ vtkEncodedGradientShader()

vtkEncodedGradientShader::vtkEncodedGradientShader ( )
protected

◆ ~vtkEncodedGradientShader()

vtkEncodedGradientShader::~vtkEncodedGradientShader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkEncodedGradientShader* vtkEncodedGradientShader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkEncodedGradientShader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkEncodedGradientShader* vtkEncodedGradientShader::NewInstance ( ) const

◆ PrintSelf()

void vtkEncodedGradientShader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Print the vtkEncodedGradientShader.

Reimplemented from vtkObject.

◆ SetZeroNormalDiffuseIntensity()

virtual void vtkEncodedGradientShader::SetZeroNormalDiffuseIntensity ( float  )
virtual

Set / Get the intensity diffuse / specular light used for the zero normals.

◆ GetZeroNormalDiffuseIntensity()

virtual float vtkEncodedGradientShader::GetZeroNormalDiffuseIntensity ( )
virtual

Set / Get the intensity diffuse / specular light used for the zero normals.

◆ SetZeroNormalSpecularIntensity()

virtual void vtkEncodedGradientShader::SetZeroNormalSpecularIntensity ( float  )
virtual

Set / Get the intensity diffuse / specular light used for the zero normals.

◆ GetZeroNormalSpecularIntensity()

virtual float vtkEncodedGradientShader::GetZeroNormalSpecularIntensity ( )
virtual

Set / Get the intensity diffuse / specular light used for the zero normals.

◆ UpdateShadingTable()

void vtkEncodedGradientShader::UpdateShadingTable ( vtkRenderer ren,
vtkVolume vol,
vtkEncodedGradientEstimator gradest 
)

Cause the shading table to be updated.

◆ GetRedDiffuseShadingTable()

float* vtkEncodedGradientShader::GetRedDiffuseShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

◆ GetGreenDiffuseShadingTable()

float* vtkEncodedGradientShader::GetGreenDiffuseShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

◆ GetBlueDiffuseShadingTable()

float* vtkEncodedGradientShader::GetBlueDiffuseShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

◆ GetRedSpecularShadingTable()

float* vtkEncodedGradientShader::GetRedSpecularShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

◆ GetGreenSpecularShadingTable()

float* vtkEncodedGradientShader::GetGreenSpecularShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

◆ GetBlueSpecularShadingTable()

float* vtkEncodedGradientShader::GetBlueSpecularShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

◆ SetActiveComponent()

virtual void vtkEncodedGradientShader::SetActiveComponent ( int  )
virtual

Set the active component for shading.

This component's ambient / diffuse / specular / specular power values will be used to create the shading table. The default is 1.0

◆ GetActiveComponent()

virtual int vtkEncodedGradientShader::GetActiveComponent ( )
virtual

Set the active component for shading.

This component's ambient / diffuse / specular / specular power values will be used to create the shading table. The default is 1.0

◆ BuildShadingTable()

void vtkEncodedGradientShader::BuildShadingTable ( int  index,
double  lightDirection[3],
double  lightAmbientColor[3],
double  lightDiffuseColor[3],
double  lightSpecularColor[3],
double  lightIntensity,
double  viewDirection[3],
double  material[4],
int  twoSided,
vtkEncodedGradientEstimator gradest,
int  updateFlag 
)
protected

Build a shading table for a light with the specified direction, and color for an object of the specified material properties.

material[0] = ambient, material[1] = diffuse, material[2] = specular and material[3] = specular exponent. If the ambient flag is 1, then ambient illumination is added. If not, then this means we are calculating the "other side" of two sided lighting, so no ambient intensity is added in. If the update flag is 0, the shading table is overwritten with these new shading values. If the updateFlag is 1, then the computed light contribution is added to the current shading table values. There is one shading table per volume, and the index value indicated which index table should be used. It is computed in the UpdateShadingTable method.

Member Data Documentation

◆ ShadingTable

float* vtkEncodedGradientShader::ShadingTable[VTK_MAX_SHADING_TABLES][6]
protected

Definition at line 122 of file vtkEncodedGradientShader.h.

◆ ShadingTableVolume

vtkVolume* vtkEncodedGradientShader::ShadingTableVolume[VTK_MAX_SHADING_TABLES]
protected

Definition at line 123 of file vtkEncodedGradientShader.h.

◆ ShadingTableSize

int vtkEncodedGradientShader::ShadingTableSize[VTK_MAX_SHADING_TABLES]
protected

Definition at line 124 of file vtkEncodedGradientShader.h.

◆ ActiveComponent

int vtkEncodedGradientShader::ActiveComponent
protected

Definition at line 126 of file vtkEncodedGradientShader.h.

◆ ZeroNormalDiffuseIntensity

float vtkEncodedGradientShader::ZeroNormalDiffuseIntensity
protected

Definition at line 130 of file vtkEncodedGradientShader.h.

◆ ZeroNormalSpecularIntensity

float vtkEncodedGradientShader::ZeroNormalSpecularIntensity
protected

Definition at line 131 of file vtkEncodedGradientShader.h.


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