HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GR_Material Class Referenceabstract

#include <GR_Material.h>

+ Inheritance diagram for GR_Material:

Public Types

enum  MaterialType {
  SIMPLE_SURFACE, UNLIT_SURFACE, FILM_SURFACE, HAIR_CURVE,
  HEIGHTFIELD_SURFACE, MATX_SURFACE, MATCAP_SURFACE
}
 
enum  SpecularMode { PHONG = 0, BLINN, GGX, SPEC_ANGLE }
 
enum  DisplaceMode { DISPLACE_NORMAL = 0, DISPLACE_VECTOR_TANGENT, DISPLACE_VECTOR_WORLD, DISPLACE_VECTOR_OBJECT }
 
enum  NormalMapType { NMLMAP_TANGENT = 0, NMLMAP_WORLD, NMLMAP_OBJECT }
 
enum  AlphaMode { ALPHA_BLEND = 0, ALPHA_CUTOUT, ALPHA_IGNORE }
 
enum  InputType {
  IN_INT, IN_FLOAT, IN_VEC2, IN_VEC3,
  IN_VEC4
}
 

Public Member Functions

MaterialType type () const
 
int getNodeID () const
 
void setNodeID (int id)
 
UT_StringHolder getNodePath () const
 
void setTimeDependent (bool timedep, fpreal t=0.0)
 
void setOPTimeDependent (bool timedep, fpreal t=0.0)
 
bool isTimeDependent () const
 
bool isOPTimeDependent () const
 
fpreal getCurrentTime () const
 
bool isDirty (fpreal time)
 
void dirty (bool dirty=true)
 
virtual void dirtyTextures ()
 
bool isTextured () const
 
void setTextured (bool has_tex)
 
bool hasUDIM () const
 
void setHasUDIM (bool has_udim)
 
bool hasDisplacement () const
 
void setHasDisplacement (bool has_disp)
 
bool needsUVs () const
 
void setNeedsUVs (bool uvs)
 
bool needsTangents () const
 
void setNeedsTangents (bool tan)
 
bool isTransparent () const
 
void setTransparent (bool has_tex)
 
bool texturesLoaded () const
 
void setTexturesLoaded (bool loaded)
 
bool bindWithoutUpdate (RV_Render *r, RV_ShaderProgramBase *shader, const GR_DisplayOption *opts, bool for_curve=false)
 
bool bind (RV_Render *r, RV_ShaderProgramBase *shader, const GR_DisplayOption *opts, bool for_curve=false)
 
virtual bool bindForCompute (RV_Render *r, RV_ShaderProgramBase *shader, const GR_DisplayOption &opts)
 
virtual void update (const GR_MaterialParms &options)=0
 
virtual bool initMaterialSetForRender (RV_Render *r, RV_ShaderProgramBase *shader, bool &created)=0
 
virtual bool initBlocks (RV_Render *r, const GR_DisplayOption *opts)=0
 
bool checkCompatible (RV_Render *r, RV_ShaderProgramBase *sh, bool for_curve=false) const
 
bool bindSets (RV_Render *r, RV_ShaderProgramBase *shader, bool for_curve)
 
DEP_MicroNode & dependencies ()
 
virtual RV_ShaderProgram * getSurfaceShader () const
 
virtual RV_ShaderProgram * getCurveShader () const
 
virtual RV_ShaderCompute * getDisplaceShader () const
 
bool opDependenciesDirty () const
 
void clearOpDependenciesDirty ()
 
const UT_Set< int > opDependencies () const
 
void setOverrides (const UT_Options *overrides)
 
const UT_Options * getOverrides () const
 
void setFallbacks (const UT_Options *attrib_fallbacks)
 
const UT_Options * getFallbacks () const
 
void setExtraInputs (const UT_StringMap< InputType > &extra_inputs)
 
const UT_StringMap< InputType > & extraInputs () const
 
- Public Member Functions inherited from GR_SceneItem
const UT_StringHolder & name () const
 
exint id () const
 
int64 getVersion () const
 
void setVersion (int64 v)
 
void incref ()
 
void decref ()
 
void setName (const UT_StringHolder &name)
 
void setID (int id)
 

Static Public Member Functions

static GR_MaterialPtr create (MaterialType type, const UT_StringHolder &name)
 
static exint getUniqueMaterialID ()
 

Protected Member Functions

 GR_Material (const UT_StringHolder &name, MaterialType type)
 
 ~GR_Material () override
 
 UT_NON_COPYABLE (GR_Material)
 
void clearOpIDs ()
 
void addOpID (int id)
 
bool timeChangeCheck () const
 
void initTextureParms (RV_TextureParms &parms, const GR_DisplayOption *opts, RV_ImageDim tex_type, RV_TextureFilter filter=RV_FILTER_LINEAR)
 
- Protected Member Functions inherited from GR_SceneItem
 GR_SceneItem (const UT_StringHolder &name, int id)
 
virtual ~GR_SceneItem ()
 
 UT_NON_COPYABLE (GR_SceneItem)
 

Protected Attributes

UT_UniquePtr
< RV_ShaderVariableSet > 		myMaterialSet
 
UT_UniquePtr
< RV_ShaderVariableSet > 		myTexMaterialSet
 
UT_UniquePtr
< RV_ShaderVariableSet > 		myTexCurveMaterialSet
 
bool myDirtyFlag
 
bool myBlockDirtyFlag
 

Detailed Description

Definition at line 45 of file GR_Material.h.

Member Enumeration Documentation

enum GR_Material::AlphaMode
Enumerator
ALPHA_BLEND 
ALPHA_CUTOUT 
ALPHA_IGNORE 

Definition at line 79 of file GR_Material.h.

enum GR_Material::DisplaceMode
Enumerator
DISPLACE_NORMAL 
DISPLACE_VECTOR_TANGENT 
DISPLACE_VECTOR_WORLD 
DISPLACE_VECTOR_OBJECT 

Definition at line 65 of file GR_Material.h.

enum GR_Material::InputType
Enumerator
IN_INT 
IN_FLOAT 
IN_VEC2 
IN_VEC3 
IN_VEC4 

Definition at line 197 of file GR_Material.h.

enum GR_Material::MaterialType
Enumerator
SIMPLE_SURFACE 
UNLIT_SURFACE 
FILM_SURFACE 
HAIR_CURVE 
HEIGHTFIELD_SURFACE 
MATX_SURFACE 
MATCAP_SURFACE 

Definition at line 48 of file GR_Material.h.

enum GR_Material::NormalMapType
Enumerator
NMLMAP_TANGENT 
NMLMAP_WORLD 
NMLMAP_OBJECT 

Definition at line 72 of file GR_Material.h.

enum GR_Material::SpecularMode
Enumerator
PHONG 
BLINN 
GGX 
SPEC_ANGLE 

Definition at line 58 of file GR_Material.h.

Constructor & Destructor Documentation

GR_Material::GR_Material ( const UT_StringHolder &  name,
MaterialType  type 
)
protected
GR_Material::~GR_Material ( )
overrideprotected

Member Function Documentation

void GR_Material::addOpID ( int  id)
protected
bool GR_Material::bind ( RV_Render *  r,
RV_ShaderProgramBase *  shader,
const GR_DisplayOption *  opts,
bool  for_curve = false 
)
inline

Definition at line 159 of file GR_Material.h.

virtual bool GR_Material::bindForCompute ( RV_Render *  r,
RV_ShaderProgramBase *  shader,
const GR_DisplayOption &  opts 
)
virtual

Reimplemented in GR_MatXMaterial, and GR_FilmMaterial.

bool GR_Material::bindSets ( RV_Render *  r,
RV_ShaderProgramBase *  shader,
bool  for_curve 
)
bool GR_Material::bindWithoutUpdate ( RV_Render *  r,
RV_ShaderProgramBase *  shader,
const GR_DisplayOption *  opts,
bool  for_curve = false 
)
inline

Definition at line 153 of file GR_Material.h.

bool GR_Material::checkCompatible ( RV_Render *  r,
RV_ShaderProgramBase *  sh,
bool  for_curve = false 
) const
void GR_Material::clearOpDependenciesDirty ( )
inline

Definition at line 187 of file GR_Material.h.

void GR_Material::clearOpIDs ( )
inlineprotected

Definition at line 217 of file GR_Material.h.

static GR_MaterialPtr GR_Material::create ( MaterialType  type,
const UT_StringHolder &  name 
)
static
DEP_MicroNode& GR_Material::dependencies ( )
inline

Definition at line 180 of file GR_Material.h.

void GR_Material::dirty ( bool  dirty = true)
inline

Definition at line 117 of file GR_Material.h.

virtual void GR_Material::dirtyTextures ( )
inlinevirtual

Reimplemented in GR_MatXMaterial, GR_HairMaterial, GR_FilmMaterial, and GR_MatCapMaterial.

Definition at line 127 of file GR_Material.h.

const UT_StringMap<InputType>& GR_Material::extraInputs ( ) const
inline

Definition at line 207 of file GR_Material.h.

fpreal GR_Material::getCurrentTime ( ) const
inline

Definition at line 99 of file GR_Material.h.

virtual RV_ShaderProgram* GR_Material::getCurveShader ( ) const
inlinevirtual

Reimplemented in GR_MatXMaterial.

Definition at line 183 of file GR_Material.h.

virtual RV_ShaderCompute* GR_Material::getDisplaceShader ( ) const
inlinevirtual

Reimplemented in GR_MatXMaterial.

Definition at line 184 of file GR_Material.h.

const UT_Options* GR_Material::getFallbacks ( ) const
inline

Definition at line 195 of file GR_Material.h.

int GR_Material::getNodeID ( ) const
inline

Definition at line 91 of file GR_Material.h.

UT_StringHolder GR_Material::getNodePath ( ) const
const UT_Options* GR_Material::getOverrides ( ) const
inline

Definition at line 192 of file GR_Material.h.

virtual RV_ShaderProgram* GR_Material::getSurfaceShader ( ) const
inlinevirtual

Reimplemented in GR_MatXMaterial.

Definition at line 182 of file GR_Material.h.

static exint GR_Material::getUniqueMaterialID ( )
static
bool GR_Material::hasDisplacement ( ) const
inline

Definition at line 136 of file GR_Material.h.

bool GR_Material::hasUDIM ( ) const
inline

Definition at line 133 of file GR_Material.h.

virtual bool GR_Material::initBlocks ( RV_Render *  r,
const GR_DisplayOption *  opts 
)
pure virtual

Implemented in GR_HeightfieldMaterial, GR_MatXMaterial, GR_HairMaterial, GR_FilmMaterial, GR_MatCapMaterial, and GR_SimpleMaterial.

virtual bool GR_Material::initMaterialSetForRender ( RV_Render *  r,
RV_ShaderProgramBase *  shader,
bool &  created 
)
pure virtual

Implemented in GR_HeightfieldMaterial, GR_MatXMaterial, GR_HairMaterial, GR_FilmMaterial, GR_MatCapMaterial, and GR_SimpleMaterial.

void GR_Material::initTextureParms ( RV_TextureParms &  parms,
const GR_DisplayOption *  opts,
RV_ImageDim  tex_type,
RV_TextureFilter  filter = RV_FILTER_LINEAR 
)
protected
bool GR_Material::isDirty ( fpreal  time)
inline

Definition at line 102 of file GR_Material.h.

bool GR_Material::isOPTimeDependent ( ) const
inline

Definition at line 98 of file GR_Material.h.

bool GR_Material::isTextured ( ) const
inline

Definition at line 130 of file GR_Material.h.

bool GR_Material::isTimeDependent ( ) const
inline

Definition at line 97 of file GR_Material.h.

bool GR_Material::isTransparent ( ) const
inline

Definition at line 147 of file GR_Material.h.

bool GR_Material::needsTangents ( ) const
inline

Definition at line 144 of file GR_Material.h.

bool GR_Material::needsUVs ( ) const
inline

Definition at line 140 of file GR_Material.h.

const UT_Set<int> GR_Material::opDependencies ( ) const
inline

Definition at line 188 of file GR_Material.h.

bool GR_Material::opDependenciesDirty ( ) const
inline

Definition at line 186 of file GR_Material.h.

void GR_Material::setExtraInputs ( const UT_StringMap< InputType > &  extra_inputs)
inline

Definition at line 205 of file GR_Material.h.

void GR_Material::setFallbacks ( const UT_Options *  attrib_fallbacks)
void GR_Material::setHasDisplacement ( bool  has_disp)
inline

Definition at line 137 of file GR_Material.h.

void GR_Material::setHasUDIM ( bool  has_udim)
inline

Definition at line 134 of file GR_Material.h.

void GR_Material::setNeedsTangents ( bool  tan)
inline

Definition at line 145 of file GR_Material.h.

void GR_Material::setNeedsUVs ( bool  uvs)
inline

Definition at line 141 of file GR_Material.h.

void GR_Material::setNodeID ( int  id)
inline

Definition at line 92 of file GR_Material.h.

void GR_Material::setOPTimeDependent ( bool  timedep,
fpreal  t = 0.0 
)
void GR_Material::setOverrides ( const UT_Options *  overrides)
void GR_Material::setTextured ( bool  has_tex)
inline

Definition at line 131 of file GR_Material.h.

void GR_Material::setTexturesLoaded ( bool  loaded)
inline

Definition at line 151 of file GR_Material.h.

void GR_Material::setTimeDependent ( bool  timedep,
fpreal  t = 0.0 
)
void GR_Material::setTransparent ( bool  has_tex)
inline

Definition at line 148 of file GR_Material.h.

bool GR_Material::texturesLoaded ( ) const
inline

Definition at line 150 of file GR_Material.h.

bool GR_Material::timeChangeCheck ( ) const
protected
MaterialType GR_Material::type ( ) const
inline

Definition at line 88 of file GR_Material.h.

virtual void GR_Material::update ( const GR_MaterialParms &  options)
pure virtual

Implemented in GR_HeightfieldMaterial, GR_MatXMaterial, GR_HairMaterial, GR_FilmMaterial, GR_MatCapMaterial, and GR_SimpleMaterial.

GR_Material::UT_NON_COPYABLE ( GR_Material  )
protected

Member Data Documentation

bool GR_Material::myBlockDirtyFlag
protected

Definition at line 232 of file GR_Material.h.

bool GR_Material::myDirtyFlag
protected

Definition at line 231 of file GR_Material.h.

UT_UniquePtr<RV_ShaderVariableSet> GR_Material::myMaterialSet
protected

Definition at line 222 of file GR_Material.h.

UT_UniquePtr<RV_ShaderVariableSet> GR_Material::myTexCurveMaterialSet
protected

Definition at line 224 of file GR_Material.h.

UT_UniquePtr<RV_ShaderVariableSet> GR_Material::myTexMaterialSet
protected

Definition at line 223 of file GR_Material.h.

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