# Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics

[Home] [Tutorials] [All Classes] [Grouped Classes]

Public Member Functions | Protected Attributes

# vl::ObjMaterial Class Reference

Represents a Wavefront OBJ material as loaded from an MTL file. See also ObjLoader. More...

`#include <ioOBJ.hpp>`

Inheritance diagram for vl::ObjMaterial:

List of all members.

## Public Member Functions

| ObjMaterial ()
const fvec3 & | ka () const
| Ka - ambient color.
const fvec3 & | kd () const
| Kd - diffuse color.
const fvec3 & | ks () const
| Ks - specular color.
const fvec3 & | ke () const
| Ke - emissive color.
float | tr () const
| Tr/d - transparency.
float | ns () const
| Ns - specular exponent.
int | illum () const
| illum - illumination model
float | ni () const
| Ni - optical density / index of refraction.
const ObjTexture & | map_Kd () const
| map_Kd - ambient diffuse
const ObjTexture & | map_Ka () const
| map_Ka - ambient color map
const ObjTexture & | map_Ks () const
| map_Ks - specular color map
const ObjTexture & | map_Ns () const
| map_Ns - specular exponent map
const ObjTexture & | map_d () const
| map_d - transparency map
const ObjTexture & | map_Decal () const
| decal - decal map
const ObjTexture & | map_Disp () const
| disp - displace map
const ObjTexture & | map_Bump () const
| bump - bump map
void | setKa (const fvec3 &ka)
| Ka - ambient color.
void | setKd (const fvec3 &kd)
| Kd - diffuse color.
void | setKs (const fvec3 &ks)
| Ks - specular color.
void | setKe (const fvec3 &ke)
| Ke - emissive color.
void | setTr (float tr)
| Tr/d - transparency.
void | setNs (float ns)
| Ns - specular exponent.
void | setIllum (int illum)
| illum - illumination model
void | setNi (float ni)
| Ni - optical density / index of refraction.
void | setMap_Kd (const ObjTexture &map_kd)
| map_Kd - ambient diffuse
void | setMap_Ka (const ObjTexture &map_ka)
| map_Ka - ambient color map
void | setMap_Ks (const ObjTexture &map_ks)
| map_Ks - specular color map
void | setMap_Ns (const ObjTexture &map_ns)
| map_Ns - specular exponent map
void | setMap_d (const ObjTexture &map_d)
| map_d - transparency map
void | setMap_Decal (const ObjTexture &map_decal)
| decal - decal map
void | setMap_Disp (const ObjTexture &map_disp)
| disp - displace map
void | setMap_Bump (const ObjTexture &map_bump)
| bump - bump map

## Protected Attributes

fvec3 | mKa
| Ka - ambient color.
fvec3 | mKd
| Kd - diffuse color.
fvec3 | mKs
| Ks - specular color.
fvec3 | mKe
| Ke - emissive color.
float | mTr
| Tr/d - transparency.
float | mNs
| Ns - specular exponent.
int | mIllum
| illum - illumination model
float | mNi
| Ni - optical density / index of refraction.
ObjTexture | mMap_Kd
| map_Kd - ambient diffuse
ObjTexture | mMap_Ka
| map_Ka - ambient color map
ObjTexture | mMap_Ks
| map_Ks - specular color map
ObjTexture | mMap_Ns
| map_Ns - specular exponent map
ObjTexture | mMap_d
| map_d - transparency map
ObjTexture | mMap_Decal
| decal - decal map
ObjTexture | mMap_Disp
| disp - displace map
ObjTexture | mMap_Bump
| bump - bump map

## Detailed Description

Represents a Wavefront OBJ material as loaded from an MTL file. See also ObjLoader.

Definition at line 187 of file ioOBJ.hpp.

## Constructor & Destructor Documentation

vl::ObjMaterial::ObjMaterial | ( | ) | `[inline]`

Definition at line 192 of file ioOBJ.hpp.

## Member Function Documentation

const fvec3& vl::ObjMaterial::ka | ( | ) | const`[inline]`

Ka - ambient color.

Definition at line 195 of file ioOBJ.hpp.

References mKa.

Referenced by setKa().

const fvec3& vl::ObjMaterial::kd | ( | ) | const`[inline]`

Kd - diffuse color.

Definition at line 197 of file ioOBJ.hpp.

References mKd.

Referenced by setKd().

const fvec3& vl::ObjMaterial::ks | ( | ) | const`[inline]`

Ks - specular color.

Definition at line 199 of file ioOBJ.hpp.

References mKs.

Referenced by setKs().

const fvec3& vl::ObjMaterial::ke | ( | ) | const`[inline]`

Ke - emissive color.

Definition at line 201 of file ioOBJ.hpp.

References mKe.

Referenced by setKe().

float vl::ObjMaterial::tr | ( | ) | const`[inline]`

Tr/d - transparency.

Definition at line 203 of file ioOBJ.hpp.

References mTr.

Referenced by setTr().

float vl::ObjMaterial::ns | ( | ) | const`[inline]`

Ns - specular exponent.

Definition at line 205 of file ioOBJ.hpp.

References mNs.

Referenced by setNs().

int vl::ObjMaterial::illum | ( | ) | const`[inline]`

illum - illumination model

Definition at line 207 of file ioOBJ.hpp.

References mIllum.

Referenced by setIllum().

float vl::ObjMaterial::ni | ( | ) | const`[inline]`

Ni - optical density / index of refraction.

Definition at line 209 of file ioOBJ.hpp.

References mNi.

Referenced by setNi().

const ObjTexture& vl::ObjMaterial::map_Kd | ( | ) | const`[inline]`

map_Kd - ambient diffuse

Definition at line 211 of file ioOBJ.hpp.

References mMap_Kd.

const ObjTexture& vl::ObjMaterial::map_Ka | ( | ) | const`[inline]`

map_Ka - ambient color map

Definition at line 213 of file ioOBJ.hpp.

References mMap_Ka.

const ObjTexture& vl::ObjMaterial::map_Ks | ( | ) | const`[inline]`

map_Ks - specular color map

Definition at line 215 of file ioOBJ.hpp.

References mMap_Ks.

const ObjTexture& vl::ObjMaterial::map_Ns | ( | ) | const`[inline]`

map_Ns - specular exponent map

Definition at line 217 of file ioOBJ.hpp.

References mMap_Ns.

const ObjTexture& vl::ObjMaterial::map_d | ( | ) | const`[inline]`

map_d - transparency map

Definition at line 219 of file ioOBJ.hpp.

References mMap_d.

Referenced by setMap_d().

const ObjTexture& vl::ObjMaterial::map_Decal | ( | ) | const`[inline]`

decal - decal map

Definition at line 221 of file ioOBJ.hpp.

References mMap_Decal.

const ObjTexture& vl::ObjMaterial::map_Disp | ( | ) | const`[inline]`

disp - displace map

Definition at line 223 of file ioOBJ.hpp.

References mMap_Disp.

const ObjTexture& vl::ObjMaterial::map_Bump | ( | ) | const`[inline]`

bump - bump map

Definition at line 225 of file ioOBJ.hpp.

References mMap_Bump.

void vl::ObjMaterial::setKa | ( | const fvec3 & | ka ) | `[inline]`

Ka - ambient color.

Definition at line 228 of file ioOBJ.hpp.

References ka(), and mKa.

void vl::ObjMaterial::setKd | ( | const fvec3 & | kd ) | `[inline]`

Kd - diffuse color.

Definition at line 230 of file ioOBJ.hpp.

References kd(), and mKd.

void vl::ObjMaterial::setKs | ( | const fvec3 & | ks ) | `[inline]`

Ks - specular color.

Definition at line 232 of file ioOBJ.hpp.

References ks(), and mKs.

void vl::ObjMaterial::setKe | ( | const fvec3 & | ke ) | `[inline]`

Ke - emissive color.

Definition at line 234 of file ioOBJ.hpp.

References ke(), and mKe.

void vl::ObjMaterial::setTr | ( | float | tr ) | `[inline]`

Tr/d - transparency.

Definition at line 236 of file ioOBJ.hpp.

References mTr, and tr().

void vl::ObjMaterial::setNs | ( | float | ns ) | `[inline]`

Ns - specular exponent.

Definition at line 238 of file ioOBJ.hpp.

References mNs, and ns().

void vl::ObjMaterial::setIllum | ( | int | illum ) | `[inline]`

illum - illumination model

Definition at line 240 of file ioOBJ.hpp.

References illum(), and mIllum.

void vl::ObjMaterial::setNi | ( | float | ni ) | `[inline]`

Ni - optical density / index of refraction.

Definition at line 242 of file ioOBJ.hpp.

References mNi, and ni().

void vl::ObjMaterial::setMap_Kd | ( | const ObjTexture & | map_kd ) | `[inline]`

map_Kd - ambient diffuse

Definition at line 244 of file ioOBJ.hpp.

References mMap_Kd.

void vl::ObjMaterial::setMap_Ka | ( | const ObjTexture & | map_ka ) | `[inline]`

map_Ka - ambient color map

Definition at line 246 of file ioOBJ.hpp.

References mMap_Ka.

void vl::ObjMaterial::setMap_Ks | ( | const ObjTexture & | map_ks ) | `[inline]`

map_Ks - specular color map

Definition at line 248 of file ioOBJ.hpp.

References mMap_Ks.

void vl::ObjMaterial::setMap_Ns | ( | const ObjTexture & | map_ns ) | `[inline]`

map_Ns - specular exponent map

Definition at line 250 of file ioOBJ.hpp.

References mMap_Ns.

void vl::ObjMaterial::setMap_d | ( | const ObjTexture & | map_d ) | `[inline]`

map_d - transparency map

Definition at line 252 of file ioOBJ.hpp.

References map_d(), and mMap_d.

void vl::ObjMaterial::setMap_Decal | ( | const ObjTexture & | map_decal ) | `[inline]`

decal - decal map

Definition at line 254 of file ioOBJ.hpp.

References mMap_Decal.

void vl::ObjMaterial::setMap_Disp | ( | const ObjTexture & | map_disp ) | `[inline]`

disp - displace map

Definition at line 256 of file ioOBJ.hpp.

References mMap_Disp.

void vl::ObjMaterial::setMap_Bump | ( | const ObjTexture & | map_bump ) | `[inline]`

bump - bump map

Definition at line 258 of file ioOBJ.hpp.

References mMap_Bump.

## Member Data Documentation

fvec3 vl::ObjMaterial::mKa`[protected]`

Ka - ambient color.

Definition at line 262 of file ioOBJ.hpp.

Referenced by ka(), and setKa().

fvec3 vl::ObjMaterial::mKd`[protected]`

Kd - diffuse color.

Definition at line 264 of file ioOBJ.hpp.

Referenced by kd(), and setKd().

fvec3 vl::ObjMaterial::mKs`[protected]`

Ks - specular color.

Definition at line 266 of file ioOBJ.hpp.

Referenced by ks(), and setKs().

fvec3 vl::ObjMaterial::mKe`[protected]`

Ke - emissive color.

Definition at line 268 of file ioOBJ.hpp.

Referenced by ke(), and setKe().

float vl::ObjMaterial::mTr`[protected]`

Tr/d - transparency.

Definition at line 270 of file ioOBJ.hpp.

Referenced by setTr(), and tr().

float vl::ObjMaterial::mNs`[protected]`

Ns - specular exponent.

Definition at line 272 of file ioOBJ.hpp.

Referenced by ns(), and setNs().

int vl::ObjMaterial::mIllum`[protected]`

illum - illumination model

Definition at line 274 of file ioOBJ.hpp.

Referenced by illum(), and setIllum().

float vl::ObjMaterial::mNi`[protected]`

Ni - optical density / index of refraction.

Definition at line 276 of file ioOBJ.hpp.

Referenced by ni(), and setNi().

ObjTexture vl::ObjMaterial::mMap_Kd`[protected]`

map_Kd - ambient diffuse

Definition at line 278 of file ioOBJ.hpp.

Referenced by map_Kd(), and setMap_Kd().

ObjTexture vl::ObjMaterial::mMap_Ka`[protected]`

map_Ka - ambient color map

Definition at line 280 of file ioOBJ.hpp.

Referenced by map_Ka(), and setMap_Ka().

ObjTexture vl::ObjMaterial::mMap_Ks`[protected]`

map_Ks - specular color map

Definition at line 282 of file ioOBJ.hpp.

Referenced by map_Ks(), and setMap_Ks().

ObjTexture vl::ObjMaterial::mMap_Ns`[protected]`

map_Ns - specular exponent map

Definition at line 284 of file ioOBJ.hpp.

Referenced by map_Ns(), and setMap_Ns().

ObjTexture vl::ObjMaterial::mMap_d`[protected]`

map_d - transparency map

Definition at line 286 of file ioOBJ.hpp.

Referenced by map_d(), and setMap_d().

ObjTexture vl::ObjMaterial::mMap_Decal`[protected]`

decal - decal map

Definition at line 288 of file ioOBJ.hpp.

Referenced by map_Decal(), and setMap_Decal().

ObjTexture vl::ObjMaterial::mMap_Disp`[protected]`

disp - displace map

Definition at line 290 of file ioOBJ.hpp.

Referenced by map_Disp(), and setMap_Disp().

ObjTexture vl::ObjMaterial::mMap_Bump`[protected]`

bump - bump map

Definition at line 292 of file ioOBJ.hpp.

Referenced by map_Bump(), and setMap_Bump().

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

- D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/plugins/ioOBJ.hpp

Visualization Library v2011.09.1162 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu Jan 26 2012 00:44:42.
Permission is granted to use this page to write and publish articles regarding Visualization Library.