Skip to content
Snippets Groups Projects
Commit 16c816f3 authored by T.J. Corona's avatar T.J. Corona
Browse files

Add descriptions to mesh operators.

parent 095cffeb
No related branches found
No related tags found
No related merge requests found
......@@ -4,6 +4,15 @@
<Definitions>
<!-- Operator -->
<AttDef Type="apply bathymetry" Label="Mesh - Apply Bathymetry" BaseType="operator">
<BriefDescription>
Add or Remove elevation from a model or mesh.
</BriefDescription>
<DetailedDescription>
&lt;p&gt;Add or Remove elevation from a model or mesh.
&lt;p&gt;This operator modifies the z-coordinate of a model, a
mesh or both a model and a mesh according to an auxiliary
geometry. The elevation data can be applied or removed.
</DetailedDescription>
<ItemDefinitions>
<String Name="operation" Label="Operation" Version="0" AdvanceLevel="0" NumberOfRequiredValues="1">
......
......@@ -7,8 +7,15 @@
<ItemDefinitions>
<MeshEntity Name="mesh" NumberOfRequiredValues="1" Extensible="true" />
</ItemDefinitions>
<BriefDescription>
Remove a mesh from the model instance.
</BriefDescription>
<DetailedDescription>
&lt;p&gt;Remove a mesh from the model instance.
&lt;p&gt;This operator removes meshes from the application's
memory. It does not remove meshes from disk.
</DetailedDescription>
</AttDef>
<!-- Result -->
<AttDef Type="result(delete mesh)" BaseType="result">
<ItemDefinitions>
......
......@@ -4,6 +4,17 @@
<Definitions>
<!-- Operator -->
<AttDef Type="export mesh" Label="Mesh - Export" BaseType="operator">
<BriefDescription>
Export a mesh to disk.
</BriefDescription>
<DetailedDescription>
&lt;p&gt;Export a mesh to disk.
&lt;p&gt;This operator creates a file representing the
selected mesh and saves it to disk. The created file is
readable by this application, but the resulting
mesh is not guaranteed to contain all of the information from
the original mesh.
</DetailedDescription>
<ItemDefinitions>
<MeshEntity Name="mesh" NumberOfRequiredValues="1" Extensible="true" />
<File Name="filename" NumberOfRequiredValues="1" ShouldExist="false"
......
......@@ -5,6 +5,18 @@
<!-- Operator -->
<AttDef Type="interpolate mesh"
Label="Mesh - Interpolate" BaseType="operator">
<BriefDescription>
Create a field on mesh nodes/elements from
interpolated 2-dimensional data.
</BriefDescription>
<DetailedDescription>
&lt;p&gt;Create a field on mesh nodes/elements from
interpolated 2-dimensional data.
&lt;p&gt;This operator accepts as input two-dimensional points
with associated scalar values, and interpolates these values
onto either the points or the cells of the mesh. The input
points can be inserted manually or read from a CSV file.
</DetailedDescription>
<ItemDefinitions>
<MeshEntity Name="mesh" Label="Mesh" NumberOfRequiredValues="1" Extensible="true" >
<BriefDescription>The mesh to elevate.</BriefDescription>
......
......@@ -4,6 +4,17 @@
<Definitions>
<!-- Operator -->
<AttDef Type="write mesh" Label="Mesh - Save" BaseType="operator">
<BriefDescription>
Write a mesh to disk.
</BriefDescription>
<DetailedDescription>
&lt;p&gt;Write a mesh to disk.
&lt;p&gt;This operator creates a file representing the
selected mesh and saves it to disk. The created file is
readable by this application, and the resulting
mesh is guaranteed to contain all of the information from
the original mesh.
</DetailedDescription>
<ItemDefinitions>
<MeshEntity Name="mesh" NumberOfRequiredValues="1" Extensible="true" />
<File Name="filename" NumberOfRequiredValues="1" ShouldExist="false"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment