<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OpenSceneGraph: osgFX/Effect File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="dir_bd152cb7084202a20f88fe75e9cb3a14.html">osgFX</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Defines</a> </div>
<div class="headertitle">
<h1>Effect File Reference</h1> </div>
</div>
<div class="contents">
<code>#include <<a class="el" href="a01159.html">osgFX/Export</a>></code><br/>
<code>#include <<a class="el" href="a01392.html">osgFX/Technique</a>></code><br/>
<code>#include <<a class="el" href="a01129.html">osg/buffered_value</a>></code><br/>
<code>#include <<a class="el" href="a01237.html">osg/ref_ptr</a>></code><br/>
<code>#include <<a class="el" href="a01212.html">osg/Node</a>></code><br/>
<code>#include <<a class="el" href="a01188.html">osg/Group</a>></code><br/>
<code>#include <<a class="el" href="a01179.html">osg/Geode</a>></code><br/>
<code>#include <<a class="el" href="a01219.html">osg/OccluderNode</a>></code><br/>
<code>#include <vector></code><br/>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00240.html">osgFX::Effect</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The base class for special effects. <a href="a00240.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="a01631.html">osgFX</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The <a class="el" href="a01631.html" title="The osgFX library is a NodeKit that extends the core scene graph to provide a special effects framewo...">osgFX</a> library is a NodeKit that extends the core scene graph to provide a special effects framework. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a01388.html#a86f95704646804fe6304cb33bf9ff648">META_Effect</a>(library, classname, effectname, effectdescription, effectauthor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An helper macro that defines the methods like effectName() and effectDescription() making them return the strings passed as parameters, after the usual library name and class name. <a href="#a86f95704646804fe6304cb33bf9ff648"></a><br/></td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a86f95704646804fe6304cb33bf9ff648"></a><!-- doxytag: member="Effect::META_Effect" ref="a86f95704646804fe6304cb33bf9ff648" args="(library, classname, effectname, effectdescription, effectauthor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define META_Effect</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">library, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">classname, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">effectname, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">effectdescription, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">effectauthor</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="a01212.html#aa523d8f02a25bac934b55a798c85ea34" title="META_Node macro define the standard clone, isSameKindAs, className and accept methods.">META_Node</a>(library, classname) \
<span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *effectName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> effectname; } \
<span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *effectDescription()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> effectdescription; } \
<span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *effectAuthor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> effectauthor; }
</pre></div>
<p>An helper macro that defines the methods like effectName() and effectDescription() making them return the strings passed as parameters, after the usual library name and class name. </p>
</div>
</div>
</div>
<hr>
<table border="0"><tr><td>
<img src="osg32-32.png" alt="osg logo" />
</td><td>
<address><small>Generated at Thu Aug 19 2010 16:22:41 for the <a href="http://www.openscenegraph.org/">OpenSceneGraph</a>
by <a href="http://www.doxygen.org">doxygen</a> 1.7.1.</small></address>
<!-- Dimitri van Heesch's e-mail address removed, lest he get messages on the OpenSceneGraph -->
</td></tr></table>
</body>
</html>
