Recent changes to Geometry Editor

Geometry Editor modified by Dasha

Dasha — Wed, 25 Jun 2014 21:38:38 -0000

--- v6
+++ v7
@@ -23,7 +23,7 @@
   * Initialize, import, and modify a CSG tree 
   * Generate a triangle surface mesh for the [jMonkeyEngine](http://jmonkeyengine.org/) [Mesh](http://jmonkeyengine.org/javadoc/index.html?com/jme3/scene/Mesh.html) format in order to display an interactive preview for the user in the Geometry Editor's viewport 
   * Generate a tetrahedral volume mesh to be used by a third-party application 
-  * Build a [ NiCE Component](Data_Structures_in_NiCE_) with the CSG tree, including all information required to persist and restore a geometry model 
+  * Build a [NiCE Component](Data Structures in NiCE) with the CSG tree, including all information required to persist and restore a geometry model 
   * Export to standard and application-specific geometry and volume mesh formats (BREP, etc.)

 # Graphical User Interface

Geometry Editor modified by Dasha

Dasha — Tue, 24 Jun 2014 09:01:09 -0000

--- v5
+++ v6
@@ -1,25 +1,12 @@
-The NiCE Geometry Editor provides users of 
-    
-    NiCEClient
+The NiCE Geometry Editor provides users of NiCEClient a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of [constructive solid geometry](http://en.wikipedia.org/wiki/Constructive_solid_geometry), as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the NiCEClient environment, as well as to generate output formats to be served as input data for processes launched with NiCECore.

-a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of [constructive solid geometry](http://en.wikipedia.org/wiki/Constructive_solid_geometry), as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the 
-    
-    NiCEClient
-
-environment, as well as to generate output formats to be served as input data for processes launched with 
-    
-    NiCECore
-
-. 
-
-  
-
+**Table of Contents**

 [TOC]

-## Requirements
+# Requirements

-### User Interface
+## User Interface

 The user must be able to perform the following from the Geometry Editor's interface. 

@@ -29,49 +16,35 @@
   * Select multiple groups of objects as well as their constituent primitive shapes. Once selected, the user may delete, duplicate, or reorder its role in the [CSG tree](http://en.wikipedia.org/wiki/File:Csg_tree.png). 
   * Optionally rename instances of primitives and groups. 

-### Geometry Engine
+## Geometry Engine

-In order to integrate with 
-    
-    NiCECore
-
-, 
-    
-    NiCEClient
-
-, and third-party applications, the geometry engine must have the following capabilities: 
+In order to integrate with NiCECore, NiCEClient, and third-party applications, the geometry engine must have the following capabilities: 

   * Initialize, import, and modify a CSG tree 
   * Generate a triangle surface mesh for the [jMonkeyEngine](http://jmonkeyengine.org/) [Mesh](http://jmonkeyengine.org/javadoc/index.html?com/jme3/scene/Mesh.html) format in order to display an interactive preview for the user in the Geometry Editor's viewport 
   * Generate a tetrahedral volume mesh to be used by a third-party application 
   * Build a [ NiCE Component](Data_Structures_in_NiCE_) with the CSG tree, including all information required to persist and restore a geometry model 
-  * Export to standard and application-specific geometry and volume mesh formats (BREP, etc.) 
+  * Export to standard and application-specific geometry and volume mesh formats (BREP, etc.)

-  
-
-
-## Graphical User Interface
+# Graphical User Interface

 The Geometry Editor GUI is opened from within the NiCEClient environment. Within this environment are three dockable panels—the Viewport panel, the Object List panel, and the Transform panel. Each of these are used to manipulate the CSG tree, i.e. create shapes, relate them with set operations, and edit their transformation matrix. 

-### Viewport Panel
+## Viewport Panel

 A variable-quality rendering of the CSG tree is displayed in the _Viewport_ panel, along with a Mini-Axis Widget for determining the orientation of the virtual camera. With the mouse, the user can pan and rotate the camera's perspective and select certain types of primitives and groups. Right-clicking will display a context menu with additional features for quick access. 

-### Object List Panel
+## Object List Panel

 The Object List panel features a representation of the current CSG tree as an [SWT Tree](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Tree.html) or [JFace TreeViewer](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/TreeViewer.html). Leaf nodes in this tree list correspond to primitive shapes, while parent branches represent set operations applied to their child nodes. The user may select multiple objects from this tree to delete, duplicate, or rename them. 

-### Transform Panel
+## Transform Panel

 Users can manipulate the transformation matrix of a selected object with the _Transform_ panel. This panel contains a text box for position, size, scale, rotation, and shear for each of the needed coordinates. A child will inherit its parents' transformations, but its own transformation parameters will be preserved. This is achieved by applying the dot product to each of its corresponding transformations matrices. 

-### Mini-Axis Widget
+## Mini-Axis Widget

 The Mini-Axis Widget is shown in the center of the _Viewport_ panel and reveals the orientation of the camera by labeling each of the three axes. Clicking and dragging one of the arrowheads will transpose the selected object. By holding down modifier keys, the user may instead scale, size, or rotate the object. 
-
-  
-

 _"I hate meshes. I cannot believe how hard this is. Geometry is hard."_

Geometry_Editor modified by Dasha

Dasha — Mon, 23 Jun 2014 16:47:41 -0000

--- v4
+++ v5
@@ -1,4 +1,16 @@
-The NiCE Geometry Editor provides users of NiCEClient a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of [constructive solid geometry](http://en.wikipedia.org/wiki/Constructive_solid_geometry), as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the NiCEClient environment, as well as to generate output formats to be served as input data for processes launched with NiCECore. 
+The NiCE Geometry Editor provides users of 
+    
+    NiCEClient
+
+a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of [constructive solid geometry](http://en.wikipedia.org/wiki/Constructive_solid_geometry), as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the 
+    
+    NiCEClient
+
+environment, as well as to generate output formats to be served as input data for processes launched with 
+    
+    NiCECore
+
+.

@@ -11,26 +23,29 @@

 The user must be able to perform the following from the Geometry Editor's interface. 

-  * Add shapes from a predefined list to the viewport 
-    * Sphere, cube, cylinder, cone, Platonic solids, and imported custom meshes 
-  * Apply set operations to two or more objects 
-    * Union, intersection, compliment 
-  * Edit each shape's matrix transformations 
-    * Position, size, scale, rotation, shear 
-  * Select multiple groups of objects as well as their constituent primitive shapes 
-    * Once selected, the user may delete, duplicate, or reorder its role in the [CSG tree](http://en.wikipedia.org/wiki/File:Csg_tree.png). 
-  * Optionally rename instances of primitives and groups 
+  * Add shapes from a predefined list to the viewport (spheres, cubes, cylinders, cones, Platonic solids, and imported custom meshes). 
+  * Apply set operations to two or more objects (union, intersection, complement). 
+  * Edit each shape's matrix transformations (position, size, scale, rotation, shear). 
+  * Select multiple groups of objects as well as their constituent primitive shapes. Once selected, the user may delete, duplicate, or reorder its role in the [CSG tree](http://en.wikipedia.org/wiki/File:Csg_tree.png). 
+  * Optionally rename instances of primitives and groups. 

 ### Geometry Engine

-In order to integrate with NiCECore, NiCEClient, and third party applications, the geometry engine must have the following capability. 
+In order to integrate with 
+    
+    NiCECore
+
+, 
+    
+    NiCEClient
+
+, and third-party applications, the geometry engine must have the following capabilities: 

   * Initialize, import, and modify a CSG tree 
   * Generate a triangle surface mesh for the [jMonkeyEngine](http://jmonkeyengine.org/) [Mesh](http://jmonkeyengine.org/javadoc/index.html?com/jme3/scene/Mesh.html) format in order to display an interactive preview for the user in the Geometry Editor's viewport 
-  * Generate a tetrahedral volume mesh to be used by a third party application 
+  * Generate a tetrahedral volume mesh to be used by a third-party application 
   * Build a [ NiCE Component](Data_Structures_in_NiCE_) with the CSG tree, including all information required to persist and restore a geometry model 
-  * Export to standard and application-specific geometry and volume mesh formats 
-    * BREP, etc. 
+  * Export to standard and application-specific geometry and volume mesh formats (BREP, etc.) 

@@ -41,7 +56,7 @@

 ### Viewport Panel

-A variable-quality rendering of the CSG tree is displayed in the Viewport panel, along with a Mini-Axis Widget for determining the orientation of the virtual camera. With the mouse, the user can pan and rotate the camera's perspective and select certain types of primitives and groups. Right-clicking will display a context menu with additional features for quick access. 
+A variable-quality rendering of the CSG tree is displayed in the _Viewport_ panel, along with a Mini-Axis Widget for determining the orientation of the virtual camera. With the mouse, the user can pan and rotate the camera's perspective and select certain types of primitives and groups. Right-clicking will display a context menu with additional features for quick access. 

 ### Object List Panel

@@ -49,11 +64,11 @@

 ### Transform Panel

-Users can manipulate the transformation matrix of a selected object with the Transform panel. This panel contains a text box for position, size, scale, rotation, and shear for each of the needed coordinates. A child will inherit its parents' transformations, but its own transformation parameters will be preserved. This is achieved by applying the dot product to each of its corresponding transformations matrices. 
+Users can manipulate the transformation matrix of a selected object with the _Transform_ panel. This panel contains a text box for position, size, scale, rotation, and shear for each of the needed coordinates. A child will inherit its parents' transformations, but its own transformation parameters will be preserved. This is achieved by applying the dot product to each of its corresponding transformations matrices. 

 ### Mini-Axis Widget

-The Mini-Axis Widget is shown in the center of the Viewport panel and reveals the orientation of the camera by labeling each of the three axes. Clicking and dragging one of the arrowheads will transpose the selected object. By holding down modifier keys, the user may instead scale, size, or rotate the object. 
+The Mini-Axis Widget is shown in the center of the _Viewport_ panel and reveals the orientation of the camera by labeling each of the three axes. Clicking and dragging one of the arrowheads will transpose the selected object. By holding down modifier keys, the user may instead scale, size, or rotate the object.

Geometry_Editor modified by Andrew Belt

Andrew Belt — Mon, 23 Jun 2014 16:47:41 -0000

--- v3
+++ v4
@@ -1,4 +1,4 @@
-The NiCE Geometry Editor provides users of NiCEClient a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of [constructive solid geometry](http://en.wikipedia.org/wiki/Constructive_solid_geometry), as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the NiCEClient window, as well as to generate output formats to be served as input data for processes launched with NiCECore. 
+The NiCE Geometry Editor provides users of NiCEClient a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of [constructive solid geometry](http://en.wikipedia.org/wiki/Constructive_solid_geometry), as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the NiCEClient environment, as well as to generate output formats to be served as input data for processes launched with NiCECore.

@@ -12,12 +12,12 @@
 The user must be able to perform the following from the Geometry Editor's interface. 

   * Add shapes from a predefined list to the viewport 
-    * Sphere, cube, cylinder, imported custom meshes, etc. 
+    * Sphere, cube, cylinder, cone, Platonic solids, and imported custom meshes 
   * Apply set operations to two or more objects 
     * Union, intersection, compliment 
   * Edit each shape's matrix transformations 
     * Position, size, scale, rotation, shear 
-  * Select groups of objects as well as individual primitive shapes 
+  * Select multiple groups of objects as well as their constituent primitive shapes 
     * Once selected, the user may delete, duplicate, or reorder its role in the [CSG tree](http://en.wikipedia.org/wiki/File:Csg_tree.png). 
   * Optionally rename instances of primitives and groups 

@@ -28,7 +28,7 @@
   * Initialize, import, and modify a CSG tree 
   * Generate a triangle surface mesh for the [jMonkeyEngine](http://jmonkeyengine.org/) [Mesh](http://jmonkeyengine.org/javadoc/index.html?com/jme3/scene/Mesh.html) format in order to display an interactive preview for the user in the Geometry Editor's viewport 
   * Generate a tetrahedral volume mesh to be used by a third party application 
-  * Build a [ NiCEDataStructure](Data_Structures_in_NiCE_) with CSG tree and program state data, including all information required to persist and restore a Geometry Editor session 
+  * Build a [ NiCE Component](Data_Structures_in_NiCE_) with the CSG tree, including all information required to persist and restore a geometry model 
   * Export to standard and application-specific geometry and volume mesh formats 
     * BREP, etc. 

@@ -45,7 +45,7 @@

 ### Object List Panel

-The Object List panel features a representation of the current CSG tree as a [SWT Tree](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Tree.html) or [JFace TreeViewer](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/TreeViewer.html). Leaf nodes in this tree list correspond to primitives, while parent branches represent set operations applied to their child nodes. The user may select multiple objects from this tree and delete, duplicate, or rename them. 
+The Object List panel features a representation of the current CSG tree as an [SWT Tree](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Tree.html) or [JFace TreeViewer](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/TreeViewer.html). Leaf nodes in this tree list correspond to primitive shapes, while parent branches represent set operations applied to their child nodes. The user may select multiple objects from this tree to delete, duplicate, or rename them. 

 ### Transform Panel

Geometry_Editor modified by Andrew Belt

Andrew Belt — Mon, 23 Jun 2014 16:47:40 -0000

--- v2
+++ v3
@@ -45,11 +45,18 @@

 ### Object List Panel

-The Object List panel features a representation of the current CSG tree as a [SWT Tree](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Tree.html) or [JFace TreeViewer](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/TreeViewer.html). Leaf nodes in this tree list correspond to primitives, while parent branches represent set operations applied to their child nodes. 
+The Object List panel features a representation of the current CSG tree as a [SWT Tree](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Tree.html) or [JFace TreeViewer](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/TreeViewer.html). Leaf nodes in this tree list correspond to primitives, while parent branches represent set operations applied to their child nodes. The user may select multiple objects from this tree and delete, duplicate, or rename them. 

 ### Transform Panel

+Users can manipulate the transformation matrix of a selected object with the Transform panel. This panel contains a text box for position, size, scale, rotation, and shear for each of the needed coordinates. A child will inherit its parents' transformations, but its own transformation parameters will be preserved. This is achieved by applying the dot product to each of its corresponding transformations matrices. 
+
 ### Mini-Axis Widget
+
+The Mini-Axis Widget is shown in the center of the Viewport panel and reveals the orientation of the camera by labeling each of the three axes. Clicking and dragging one of the arrowheads will transpose the selected object. By holding down modifier keys, the user may instead scale, size, or rotate the object. 
+
+  
+

 _"I hate meshes. I cannot believe how hard this is. Geometry is hard."_

Geometry_Editor modified by Andrew Belt

Andrew Belt — Mon, 23 Jun 2014 16:47:40 -0000

--- v1
+++ v2
@@ -37,6 +37,20 @@

 ## Graphical User Interface

+The Geometry Editor GUI is opened from within the NiCEClient environment. Within this environment are three dockable panels—the Viewport panel, the Object List panel, and the Transform panel. Each of these are used to manipulate the CSG tree, i.e. create shapes, relate them with set operations, and edit their transformation matrix. 
+
+### Viewport Panel
+
+A variable-quality rendering of the CSG tree is displayed in the Viewport panel, along with a Mini-Axis Widget for determining the orientation of the virtual camera. With the mouse, the user can pan and rotate the camera's perspective and select certain types of primitives and groups. Right-clicking will display a context menu with additional features for quick access. 
+
+### Object List Panel
+
+The Object List panel features a representation of the current CSG tree as a [SWT Tree](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Tree.html) or [JFace TreeViewer](http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/jface/viewers/TreeViewer.html). Leaf nodes in this tree list correspond to primitives, while parent branches represent set operations applied to their child nodes. 
+
+### Transform Panel
+
+### Mini-Axis Widget
+
 _"I hate meshes. I cannot believe how hard this is. Geometry is hard."_

 —David Baraff, Senior Research Scientist, Pixar Animation Studios

Geometry_Editor modified by Andrew Belt

Andrew Belt — Mon, 23 Jun 2014 16:47:40 -0000

The NiCE Geometry Editor provides users of NiCEClient a method for viewing and editing application-specific input data in the form of 3D volume meshes. Editing is performed by means of constructive solid geometry, as is used in many CAD and drafting tools. The Geometry Editor integrates with NiCE to enable users to build geometry data inside the NiCEClient window, as well as to generate output formats to be served as input data for processes launched with NiCECore.

Requirements
- User Interface
- Geometry Engine
Graphical User Interface

Requirements

User Interface

The user must be able to perform the following from the Geometry Editor's interface.

Add shapes from a predefined list to the viewport
- Sphere, cube, cylinder, imported custom meshes, etc.
Apply set operations to two or more objects
- Union, intersection, compliment
Edit each shape's matrix transformations
- Position, size, scale, rotation, shear
Select groups of objects as well as individual primitive shapes
- Once selected, the user may delete, duplicate, or reorder its role in the CSG tree.
Optionally rename instances of primitives and groups

Geometry Engine

In order to integrate with NiCECore, NiCEClient, and third party applications, the geometry engine must have the following capability.

Initialize, import, and modify a CSG tree
Generate a triangle surface mesh for the jMonkeyEngine Mesh format in order to display an interactive preview for the user in the Geometry Editor's viewport
Generate a tetrahedral volume mesh to be used by a third party application
Build a NiCEDataStructure with CSG tree and program state data, including all information required to persist and restore a Geometry Editor session
Export to standard and application-specific geometry and volume mesh formats
- BREP, etc.

Graphical User Interface

"I hate meshes. I cannot believe how hard this is. Geometry is hard."

—David Baraff, Senior Research Scientist, Pixar Animation Studios