mirror of
https://github.com/lucaspalomodevelop/meshlab.git
synced 2026-03-13 08:09:39 +00:00
149 lines
3.8 KiB
HTML
149 lines
3.8 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<title>Meshlab</title>
|
|
<meta name="author" content="Paolo Cignoni">
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="keywords" content="mesh 3d processing meshlab scanning">
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="description" content="Course Web page">
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="robots" content="all">
|
|
|
|
|
|
|
|
|
|
|
|
<link media="all" rel="stylesheet" href="style.css" type="text/css">
|
|
</head>
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
<div id="leftcontent">
|
|
<h1>MeshLab Coding Guide</h1>
|
|
|
|
<br>
|
|
|
|
<h2><a name="Naming_rules"></a>Naming rules</h2>
|
|
|
|
<p>Our naming rules are Qt-style. It means:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
<li><b><i>Class names</i></b> with first letter uppercase and internal uppercase
|
|
to separate compound words.</li>
|
|
|
|
<li><b><i>Function members</i></b> with first letter lowercase and internal uppercase
|
|
to separate compound words.</li>
|
|
|
|
<li><b><i>Private and Public variable members</i></b> have the first letter lowercase and
|
|
internal uppercase to separate compound words.</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<p style="margin-left: 40px;">Example:</p>
|
|
|
|
<pre style="margin-left: 40px;"> MeshLabClassExample<br> {<br> Q_OBJECT<br> private:<br> int privateVarName;<br> <br> public:<br> bool publicVarName;<br> void setValue(int &);<br> }</pre>
|
|
|
|
<h2><a name="Files"></a>Header Files</h2>
|
|
|
|
<p>There are no strict rules on naming files, except for <a href="#Dialogs">dialogs</a> files.</p>
|
|
|
|
<p>Include files must begin with the standard legal disclamier/license
|
|
intestation and report in the first line of history the $LOG$ cvs
|
|
string. The following automatically generated history can be, from time
|
|
to time, compressed and shortened to save space.</p>
|
|
<p>No absolute include path are allowed.</p>
|
|
|
|
|
|
<p>Each file has to include all the files that it requires. An
|
|
include file should rely on the files included by its own include files. </p>
|
|
|
|
<p>In Class definitions place all the prototypes all together before the inline
|
|
or templated implementations.</p>
|
|
|
|
|
|
<h2><a name="Editing_rules"></a>Editing rules</h2>
|
|
|
|
|
|
<p>Tabs are equivalent to two spaces.</p>
|
|
|
|
|
|
<p>There are no strict rules placing white spaces, '{' or indenting.<span style="font-weight: bold;"></span></p>
|
|
|
|
<h2><a name="Dialogs"></a>Dialogs</h2>
|
|
|
|
<p>A dialog tipically comes with three files: <span style="font-style: italic;">.ui</span>, <span style="font-style: italic;">.h</span>, <span style="font-style: italic;">.cpp</span>. Each new <span style="font-style: italic;">.ui</span> file must be placed in the <span style="font-style: italic;">"meshlab/ui"</span> subfolder and its name must followed by <span style="font-style: italic;">"Dialog"</span> suffix. Related <span style="font-style: italic;">.h</span> and <span style="font-style: italic;">.cpp</span> files must follow same rule but placed in the <span style="font-style: italic;">"meshlab"</span> folder.</p>
|
|
|
|
<p>Example (Settings dialog):</p>
|
|
|
|
<pre> settingsDialog.ui -> "meshlab/ui"<br> settingsDialog.h -> "meshlab/"<br> settingsDialog.cpp -> "meshlab/"</pre>
|
|
|
|
<h2><a name="Plugins"></a>Plugins</h2>
|
|
|
|
<p>Is very simple to create a working plugin. Just read <a href="filter.html">here</a>! </p>
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="rightcontent">
|
|
<a href="https://sourceforge.net/projects/meshlab/"><img style="border: 0px solid ; width: 125px; height: 37px;" src="http://sourceforge.net/sflogo.php?group_id=149444&type=2" alt="SourceForge.net Logo"></a>
|
|
<p class="menu"><a href="devel.html">Development</a></p>
|
|
|
|
<br>
|
|
|
|
<p class="menu"><a href="#Naming_rules">Naming rules</a></p>
|
|
|
|
<p class="menu"><a href="#Files">Header Files</a></p>
|
|
|
|
<p class="menu"><a href="#Editing_rules">Editing rules</a></p>
|
|
|
|
<p class="menu"><a href="#Dialogs">Dialogs</a></p>
|
|
|
|
<p class="menu"><a href="#Plugins">Plugin</a></p>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|