VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkEncodedGradientShader Class Reference

Compute shading tables for encoded normals. More...

#include <vtkEncodedGradientShader.h>

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

List of all members.

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetZeroNormalDiffuseIntensity (float)
virtual float GetZeroNormalDiffuseIntensity ()
virtual void SetZeroNormalSpecularIntensity (float)
virtual float GetZeroNormalSpecularIntensity ()
void UpdateShadingTable (vtkRenderer *ren, vtkVolume *vol, vtkEncodedGradientEstimator *gradest)
float * GetRedDiffuseShadingTable (vtkVolume *vol)
float * GetGreenDiffuseShadingTable (vtkVolume *vol)
float * GetBlueDiffuseShadingTable (vtkVolume *vol)
float * GetRedSpecularShadingTable (vtkVolume *vol)
float * GetGreenSpecularShadingTable (vtkVolume *vol)
float * GetBlueSpecularShadingTable (vtkVolume *vol)
virtual void SetActiveComponent (int)
virtual int GetActiveComponent ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkEncodedGradientShaderNew ()
static int IsTypeOf (const char *type)
static vtkEncodedGradientShaderSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkEncodedGradientShader ()
 ~vtkEncodedGradientShader ()
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)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
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
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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 43 of file vtkEncodedGradientShader.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 47 of file vtkEncodedGradientShader.h.


Constructor & Destructor Documentation

vtkEncodedGradientShader::vtkEncodedGradientShader ( )
protected
vtkEncodedGradientShader::~vtkEncodedGradientShader ( )
protected

Member Function Documentation

static vtkEncodedGradientShader* vtkEncodedGradientShader::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkEncodedGradientShader::GetClassName ( )
virtual

Reimplemented from vtkObject.

static int vtkEncodedGradientShader::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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 vtkObject.

virtual int 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 vtkObject.

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

Reimplemented from vtkObject.

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

Print the vtkEncodedGradientShader

Reimplemented from vtkObject.

virtual void vtkEncodedGradientShader::SetZeroNormalDiffuseIntensity ( float  )
virtual

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

virtual float vtkEncodedGradientShader::GetZeroNormalDiffuseIntensity ( )
virtual

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

virtual void vtkEncodedGradientShader::SetZeroNormalSpecularIntensity ( float  )
virtual

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

virtual float vtkEncodedGradientShader::GetZeroNormalSpecularIntensity ( )
virtual

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

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

Cause the shading table to be updated

float* vtkEncodedGradientShader::GetRedDiffuseShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

float* vtkEncodedGradientShader::GetGreenDiffuseShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

float* vtkEncodedGradientShader::GetBlueDiffuseShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

float* vtkEncodedGradientShader::GetRedSpecularShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

float* vtkEncodedGradientShader::GetGreenSpecularShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

float* vtkEncodedGradientShader::GetBlueSpecularShadingTable ( vtkVolume vol)

Get the red/green/blue shading table.

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

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

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

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

Definition at line 120 of file vtkEncodedGradientShader.h.

vtkVolume* vtkEncodedGradientShader::ShadingTableVolume[VTK_MAX_SHADING_TABLES]
protected

Definition at line 121 of file vtkEncodedGradientShader.h.

int vtkEncodedGradientShader::ShadingTableSize[VTK_MAX_SHADING_TABLES]
protected

Definition at line 122 of file vtkEncodedGradientShader.h.

int vtkEncodedGradientShader::ActiveComponent
protected

Definition at line 124 of file vtkEncodedGradientShader.h.

float vtkEncodedGradientShader::ZeroNormalDiffuseIntensity
protected

Definition at line 128 of file vtkEncodedGradientShader.h.

float vtkEncodedGradientShader::ZeroNormalSpecularIntensity
protected

Definition at line 129 of file vtkEncodedGradientShader.h.


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