iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Material.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 #ifndef INCLUDE_NRT_GRAPHICS_MATERIAL_H
36 #define INCLUDE_NRT_GRAPHICS_MATERIAL_H
37 
38 #include <nrt/Core/Typing/Enum.H>
39 
40 
41 /*! \defgroup graphicmaterial Graphic object material properties
42 
43  Material defines object surface properties for OpenGL. A convenient list of pre-defined materials is available.
44 
45  \ingroup graphics */
46 namespace nrt
47 {
48  namespace graphics
49  {
50 
51  //! Material definition for OpenGL
52  /*! \ingroup graphicmaterial */
53  struct Material
54  {
55  float ambient[4]; //!< Ambient light material property
56  float diffuse[4]; //!< Diffuse light material property
57  float specular[4]; //!< Specular light material property
58  float shininess; //!< Shininess material property
59 
60  template <class Archive> void serialize(Archive & ar)
61  { ar ( ambient, diffuse, specular, shininess ); }
62  };
63 
64  //! Enum key to convenience pre-defined materials
65  /*! \class BasicMaterial
66 
67  These materials were found at http://www.kynd.info/log/?p=201
68  \ingroup graphicmaterial */
69  NRT_DEFINE_ENUM_CLASS(BasicMaterial, (Emerald) (Jade) (Obsidian) (Pearl) (Ruby) (Turquoise) (Brass)
70  (Bronze) (Chrome) (Copper) (Gold) (Silver) (PlasticBlack) (PlasticCyan) (PlasticGreen)
71  (PlasticRed) (PlasticWhite) (PlasticYellow) (RubberBlack) (RubberCyan) (RubberGreen)
72  (RubberRed) (RubberWhite) (RubberYellow));
73 
74  //! Get a convenience pre-defined material
75  /*! \ingroup graphicmaterial */
76  Material const & basicMaterial(BasicMaterial m);
77 
78  } // namespace graphics
79 } // namespace nrt
80 
81 #endif // INCLUDE_NRT_GRAPHICS_MATERIAL_H