/Core/Dependencies/OgreCollada/FCollada/FCollada/Documentation/html/class_f_c_d_effect_parameter_surface_init_planar.html
HTML | 132 lines | 123 code | 8 blank | 1 comment | 0 complexity | af990e2712e77f504e4b090791ea034d MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
- <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
- <title>FCollada: FCDEffectParameterSurfaceInitPlanar Class Reference</title>
- <link href="doxygen.css" rel="stylesheet" type="text/css">
- <link href="tabs.css" rel="stylesheet" type="text/css">
- </head><body>
- <!-- Generated by Doxygen 1.4.6-NO -->
- <div class="tabs">
- <ul>
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li id="current"><a href="classes.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- </ul></div>
- <div class="tabs">
- <ul>
- <li><a href="classes.html"><span>Alphabetical List</span></a></li>
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul></div>
- <h1>FCDEffectParameterSurfaceInitPlanar Class Reference</h1><!-- doxytag: class="FCDEffectParameterSurfaceInitPlanar" --><!-- doxytag: inherits="FCDEffectParameterSurfaceInit" -->This method allows to initialize the surface as planar.
- <a href="#_details">More...</a>
- <p>
- <code>#include <<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a>></code>
- <p>
- <p>Inheritance diagram for FCDEffectParameterSurfaceInitPlanar:
- <p><center><img src="class_f_c_d_effect_parameter_surface_init_planar.png" usemap="#FCDEffectParameterSurfaceInitPlanar_map" border="0" alt=""></center>
- <map name="FCDEffectParameterSurfaceInitPlanar_map">
- <area href="class_f_c_d_effect_parameter_surface_init.html" alt="FCDEffectParameterSurfaceInit" shape="rect" coords="0,0,227,24">
- </map>
- <a href="class_f_c_d_effect_parameter_surface_init_planar-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
- <tr><td></td></tr>
- <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8ce39fa32d458f71da29f83a69ec7329"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitPlanar::FCDEffectParameterSurfaceInitPlanar" ref="8ce39fa32d458f71da29f83a69ec7329" args="()" -->
- </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_planar.html#8ce39fa32d458f71da29f83a69ec7329">FCDEffectParameterSurfaceInitPlanar</a> ()</td></tr>
- <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: builds a new file surface initialization method. <br></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e29ed97f2de4463e47b8354338db5b44"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitPlanar::~FCDEffectParameterSurfaceInitPlanar" ref="e29ed97f2de4463e47b8354338db5b44" args="()" -->
- virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_planar.html#e29ed97f2de4463e47b8354338db5b44">~FCDEffectParameterSurfaceInitPlanar</a> ()</td></tr>
- <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_planar.html#9e91a455acbcbed40b8e647aa0c56d80">GetInitType</a> () const </td></tr>
- <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the initialization type. <a href="#9e91a455acbcbed40b8e647aa0c56d80"></a><br></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_planar.html#6f098c38b09bddf08e9e3eb9e9872c0a">Clone</a> (<a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> *clone) const </td></tr>
- <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a full copy of the surface initialization parameter. <a href="#6f098c38b09bddf08e9e3eb9e9872c0a"></a><br></td></tr>
- </table>
- <hr><a name="_details"></a><h2>Detailed Description</h2>
- This method allows to initialize the surface as planar.
- <p>
- <hr><h2>Member Function Documentation</h2>
- <a class="anchor" name="6f098c38b09bddf08e9e3eb9e9872c0a"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitPlanar::Clone" ref="6f098c38b09bddf08e9e3eb9e9872c0a" args="(FCDEffectParameterSurfaceInit *clone) const " --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a>* FCDEffectParameterSurfaceInitPlanar::Clone </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> * </td>
- <td class="mdname1" valign="top" nowrap> <em>clone</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const<code> [virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- Creates a full copy of the surface initialization parameter.
- <p>
- <dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>clone</em> </td><td>The cloned surface initialization. If this pointer is NULL, a new surface initialization parameter will be created and you will need to delete this pointer. </td></tr>
- </table>
- </dl>
- <dl compact><dt><b>Returns:</b></dt><dd>The cloned surface initialization. </dd></dl>
- <p>
- Reimplemented from <a class="el" href="class_f_c_d_effect_parameter_surface_init.html#8dc058e0b704bff3588af0f694a740bc">FCDEffectParameterSurfaceInit</a>. </td>
- </tr>
- </table>
- <a class="anchor" name="9e91a455acbcbed40b8e647aa0c56d80"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitPlanar::GetInitType" ref="9e91a455acbcbed40b8e647aa0c56d80" args="() const " --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a> FCDEffectParameterSurfaceInitPlanar::GetInitType </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap> const<code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- Retrieves the initialization type.
- <p>
- You cannot modify this value. To change the initialization type of a surface parameter, create a new surface initialization structure of the correct type. <dl compact><dt><b>Returns:</b></dt><dd>The initialization type. </dd></dl>
- <p>
- Implements <a class="el" href="class_f_c_d_effect_parameter_surface_init.html#d0109233e63c892e5963a3ca67f7108f">FCDEffectParameterSurfaceInit</a>. </td>
- </tr>
- </table>
- <hr>The documentation for this class was generated from the following file:<ul>
- <li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a></ul>
- <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 17 13:25:03 2007 for FCollada by
- <a href="http://www.doxygen.org/index.html">
- <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
- </body>
- </html>