HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType > Class Template Reference

Color shader that treats the surface normal (x, y, z) as an RGB color. More...

#include <RayTracer.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >:

Public Member Functions

 NormalShader (const GridT &grid)
 
 NormalShader (const NormalShader &)=default
 
 ~NormalShader () override=default
 
Film::RGBA operator() (const Vec3R &xyz, const Vec3R &normal, const Vec3R &) const override
 Defines the interface of the virtual function that returns a RGB color. More...
 
BaseShadercopy () const override
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::tools::BaseShader
 BaseShader ()
 
 BaseShader (const BaseShader &)=default
 
virtual ~BaseShader ()=default
 

Additional Inherited Members

- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::tools::BaseShader
using RayT = math::Ray< Real >
 

Detailed Description

template<typename GridT = Film::RGBA, typename SamplerType = tools::PointSampler>
class openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >

Color shader that treats the surface normal (x, y, z) as an RGB color.

The color can either be constant (if GridT = Film::RGBA which is the default) or defined in a separate Vec3 color grid. Use SamplerType to define the order of interpolation (default is zero order, i.e. closes-point).

Definition at line 644 of file RayTracer.h.

Constructor & Destructor Documentation

template<typename GridT = Film::RGBA, typename SamplerType = tools::PointSampler>
openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >::NormalShader ( const GridT &  grid)
inline

Definition at line 647 of file RayTracer.h.

template<typename GridT = Film::RGBA, typename SamplerType = tools::PointSampler>
openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >::NormalShader ( const NormalShader< GridT, SamplerType > &  )
default
template<typename GridT = Film::RGBA, typename SamplerType = tools::PointSampler>
openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >::~NormalShader ( )
overridedefault

Member Function Documentation

template<typename GridT = Film::RGBA, typename SamplerType = tools::PointSampler>
BaseShader* openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >::copy ( void  ) const
inlineoverridevirtual

Implements openvdb::OPENVDB_VERSION_NAME::tools::BaseShader.

Definition at line 656 of file RayTracer.h.

template<typename GridT = Film::RGBA, typename SamplerType = tools::PointSampler>
Film::RGBA openvdb::OPENVDB_VERSION_NAME::tools::NormalShader< GridT, SamplerType >::operator() ( const Vec3R xyz,
const Vec3R nml,
const Vec3R dir 
) const
inlineoverridevirtual

Defines the interface of the virtual function that returns a RGB color.

Parameters
xyzWorld position of the intersection point.
nmlNormal in world space at the intersection point.
dirDirection of the ray in world space.

Implements openvdb::OPENVDB_VERSION_NAME::tools::BaseShader.

Definition at line 650 of file RayTracer.h.


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